a file I forgot to check in (sorry Julian)

[wxWidgets.git] / include / wx / gtk / dataobj.h

diff --git a/include/wx/gtk/dataobj.h b/include/wx/gtk/dataobj.h
index 6ec2a94b87604334a94f7e484667178546ce4ad4..42233e4494ada6fe68377a85622faf9e6d7f4d61 100644 (file)
--- a/include/wx/gtk/dataobj.h
+++ b/include/wx/gtk/dataobj.h
@@ -23,6 +23,8 @@
 // classes
 //-------------------------------------------------------------------------
 
 // classes
 //-------------------------------------------------------------------------
 

+class wxDataFormat;
+class wxDataBroker;

 class wxDataObject;
 class wxTextDataObject;
 class wxBitmapDataObject;
 class wxDataObject;
 class wxTextDataObject;
 class wxBitmapDataObject;


@@ -30,28 +32,145 @@ class wxPrivateDataObject;
 class wxFileDataObject;
 
 //-------------------------------------------------------------------------
 class wxFileDataObject;
 
 //-------------------------------------------------------------------------

-// wxDataObject
+// wxDataType (internal)

 //-------------------------------------------------------------------------
 
 //-------------------------------------------------------------------------
 

-class wxDataObject: public wxObject
+enum wxDataType

 {
 {

-  DECLARE_ABSTRACT_CLASS( wxDataObject )
+  wxDF_INVALID =          0,
+  wxDF_TEXT =             1,  /* CF_TEXT */
+  wxDF_BITMAP =           2,  /* CF_BITMAP */
+  wxDF_METAFILE =         3,  /* CF_METAFILEPICT */
+  wxDF_SYLK =             4,
+  wxDF_DIF =              5,
+  wxDF_TIFF =             6,
+  wxDF_OEMTEXT =          7,  /* CF_OEMTEXT */
+  wxDF_DIB =              8,  /* CF_DIB */
+  wxDF_PALETTE =          9,
+  wxDF_PENDATA =          10,
+  wxDF_RIFF =             11,
+  wxDF_WAVE =             12,
+  wxDF_UNICODETEXT =      13,
+  wxDF_ENHMETAFILE =      14,
+  wxDF_FILENAME =         15, /* CF_HDROP */
+  wxDF_LOCALE =           16,
+  wxDF_PRIVATE =          20
+};

 
 

+//-------------------------------------------------------------------------
+// wxDataFormat (internal)
+//-------------------------------------------------------------------------
+
+class wxDataFormat : public wxObject
+{
+  DECLARE_CLASS( wxDataFormat )
+  

 public:
 public:

+  
+  wxDataFormat();
+  wxDataFormat( wxDataType type );
+  wxDataFormat( const wxString &id );
+  wxDataFormat( wxDataFormat &format );
+  wxDataFormat( const GdkAtom atom );
+
+  void SetType( wxDataType type );    
+  wxDataType GetType() const;
+  
+  wxString GetId() const;
+  void SetId( const wxString &id );
+  
+  GdkAtom GetAtom();
+      
+private:

 
 

-  wxDataObject() {}
-  ~wxDataObject() {}
+  wxDataType  m_type;
+  wxString    m_id;
+  bool        m_hasAtom;
+  GdkAtom     m_atom;
+};

 
 

-  virtual wxDataFormat GetFormat() const = 0;
+//-------------------------------------------------------------------------
+// wxDataBroker (internal)
+//-------------------------------------------------------------------------
+
+class wxDataBroker : public wxObject
+{
+  DECLARE_CLASS( wxDataBroker )
+
+public:
+
+  /* constructor */
+  wxDataBroker();

   
   

-  // implementation
+  /* add data object */
+  void Add( wxDataObject *dataObject, bool preferred = FALSE );

   
   

-  GdkAtom  m_formatAtom;
+private:  
+  
+  /* OLE implementation, the methods don't need to be overridden */
+  
+  /* get number of supported formats */
+  virtual size_t GetFormatCount() const;
+  
+  /* return nth supported format */    
+  virtual wxDataFormat &GetNthFormat( size_t nth ) const;
+    
+  /* return preferrd/best supported format */    
+  virtual wxDataFormat &GetPreferredFormat() const;
+    
+  /* search through m_dataObjects, return TRUE if found */
+  virtual bool IsSupportedFormat( wxDataFormat &format ) const;
+  
+  /* search through m_dataObjects and call child's GetSize() */
+  virtual size_t GetSize( wxDataFormat& format ) const;
+    
+  /* search through m_dataObjects and call child's WriteData(dest) */
+  virtual void WriteData( wxDataFormat& format, void *dest ) const;
+  
+  /* implementation */
+
+public:
+  
+  wxList    m_dataObjects;
+  size_t    m_preferred;

 };
 
 };
 

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------
+// wxDataObject to be placed in wxDataBroker
+//----------------------------------------------------------------------------
+
+class wxDataObject : public wxObject
+{
+  DECLARE_DYNAMIC_CLASS( wxDataObject )
+  
+public:
+
+  /* constructor */
+  wxDataObject();
+  
+  /* destructor */
+  ~wxDataObject();
+  
+  /* write data to dest */  
+  virtual void WriteData( void *dest ) const = 0;
+ 
+  /* get size of data */ 
+  virtual size_t GetSize() const = 0;
+  
+  /* implementation */
+  
+  wxDataFormat &GetFormat();
+  
+  wxDataType GetFormatType() const;
+  wxString   GetFormatId() const;
+  GdkAtom    GetFormatAtom() const;
+  
+  wxDataFormat m_format;
+};
+
+//----------------------------------------------------------------------------

 // wxTextDataObject is a specialization of wxDataObject for text data
 // wxTextDataObject is a specialization of wxDataObject for text data

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 class wxTextDataObject : public wxDataObject
 {
 
 class wxTextDataObject : public wxDataObject
 {


@@ -59,27 +178,38 @@ class wxTextDataObject : public wxDataObject
 
 public:
 
 
 public:
 

-  wxTextDataObject() {}
-  wxTextDataObject( const wxString& strText ) 
-    : m_strText(strText) { }
+  /* default constructor. call SetText() later or override
+     WriteData() and GetSize() for working on-demand */
+  wxTextDataObject();

   
   

-  virtual wxDataFormat GetFormat() const
-    { return wxDF_TEXT; }
-    
-  void SetText( const wxString& strText) 
-    { m_strText = strText; }
+  /* constructor */
+  wxTextDataObject( const wxString& data );
+  
+  /* set current text data */
+  void SetText( const wxString& data );

     
     

-  wxString GetText() const
-    { return m_strText; }
+  /* get current text data */
+  wxString GetText() const;

 
 

-private:
-  wxString  m_strText;
+  /* by default calls WriteString() with string set by constructor or
+     by SetText(). can be overridden for working on-demand */
+  virtual void WriteData( void *dest ) const;
+  
+  /* by default, returns length of string as set by constructor or 
+     by SetText(). can be overridden for working on-demand */
+  virtual size_t GetSize() const;
+  
+  /* write string to dest */
+  void WriteString( const wxString &str, void *dest ) const;
+  
+  /* implementation */

 
 

+  wxString  m_data;

 };
 
 };
 

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 // wxFileDataObject is a specialization of wxDataObject for file names
 // wxFileDataObject is a specialization of wxDataObject for file names

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 class wxFileDataObject : public wxDataObject
 {
 
 class wxFileDataObject : public wxDataObject
 {


@@ -87,25 +217,30 @@ class wxFileDataObject : public wxDataObject
 
 public:
 
 
 public:
 

-  wxFileDataObject(void) {}
-  
-  virtual wxDataFormat GetFormat() const
-    { return wxDF_FILENAME; }
+  /* default constructor */
+  wxFileDataObject();

     
     

-  void AddFile( const wxString &file )
-    { m_files += file; m_files += (char)0; }
+  /* add file name to list */
+  void AddFile( const wxString &file );

     
     

-  wxString GetFiles() const
-    { return m_files; }
+  /* get all filename as one string. each file name is 0 terminated,
+     the list is double zero terminated */
+  wxString GetFiles() const;

     
     

-private:
-  wxString  m_files;
+  /* write list of filenames */
+  virtual void WriteData( void *dest ) const;
+
+  /* return length of list of filenames */  
+  virtual size_t GetSize() const;

   
   

+  /* implementation */
+
+  wxString  m_files;

 };
 
 };
 

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 // wxBitmapDataObject is a specialization of wxDataObject for bitmaps
 // wxBitmapDataObject is a specialization of wxDataObject for bitmaps

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 class wxBitmapDataObject : public wxDataObject
 {
 
 class wxBitmapDataObject : public wxDataObject
 {


@@ -113,24 +248,28 @@ class wxBitmapDataObject : public wxDataObject
 
 public:
 
 
 public:
 

-  wxBitmapDataObject(void) {}
+  /* see wxTextDataObject for explanation */
+
+  wxBitmapDataObject();
+  wxBitmapDataObject( const wxBitmap& bitmap );

   
   

-  virtual wxDataFormat GetFormat() const
-    { return wxDF_BITMAP; }
-    
-  void SetBitmap( const wxBitmap &bitmap )
-    { m_bitmap = bitmap; }
-    
-  wxBitmap GetBitmap() const
-    { return m_bitmap; }
+  void SetBitmap( const wxBitmap &bitmap );
+  wxBitmap GetBitmap() const;
+  
+  virtual void WriteData( void *dest ) const;
+  virtual size_t GetSize() const;
+  
+  void WriteBitmap( const wxBitmap &bitmap, void *dest ) const;

     
     

-private:
+  // implementation
+

   wxBitmap  m_bitmap;
   wxBitmap  m_bitmap;

+  

 };
 
 };
 

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 // wxPrivateDataObject is a specialization of wxDataObject for app specific data
 // wxPrivateDataObject is a specialization of wxDataObject for app specific data

-// ----------------------------------------------------------------------------
+//----------------------------------------------------------------------------

 
 class wxPrivateDataObject : public wxDataObject
 {
 
 class wxPrivateDataObject : public wxDataObject
 {


@@ -138,33 +277,35 @@ class wxPrivateDataObject : public wxDataObject
 
 public:
 
 
 public:
 

+  /* see wxTextDataObject for explanation of functions */
+  

   wxPrivateDataObject();
   wxPrivateDataObject();

-    

   ~wxPrivateDataObject();
   
   ~wxPrivateDataObject();
   

-  virtual wxDataFormat GetFormat() const
-    { return wxDF_PRIVATE; }
-    
-  // the string ID identifies the format of clipboard or DnD data. a word
-  // processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
-  // to the clipboard - the latter with the Id "WXWORD_FORMAT".
+  /* the string Id identifies the format of clipboard or DnD data. a word
+   * processor would e.g. add a wxTextDataObject and a wxPrivateDataObject
+   * to the clipboard - the latter with the Id "application/wxword", an
+   * image manipulation program would put a wxBitmapDataObject and a
+   * wxPrivateDataObject to the clipboard - the latter with "image/png". */

     
     

-  void SetId( const wxString& id )
-    { m_id = id; }
+  void SetId( const wxString& id );

     
     

-  wxString GetId() const
-    { return m_id; }
+  /* get id */
+  wxString GetId() const;

 
 

-  // will make internal copy
+  /* set data. will make internal copy. */

   void SetData( const char *data, size_t size );
     
   void SetData( const char *data, size_t size );
     

-  size_t GetDataSize() const
-    { return m_size; }
-    
-  char* GetData() const
-    { return m_data; }
+  /* returns pointer to data */
+  char* GetData() const;
+  
+  virtual void WriteData( void *dest ) const;
+  virtual size_t GetSize() const;
+  
+  void WriteData( const char *data, void *dest ) const;

     
     

-private:
+  // implementation
+

   size_t     m_size;
   char*      m_data;
   wxString   m_id;
   size_t     m_size;
   char*      m_data;
   wxString   m_id;