splitted wxApp docs in wxApp+wxAppConsole docs; fix the signature of the documented...

[wxWidgets.git] / src / gtk / dataobj.cpp

diff --git a/src/gtk/dataobj.cpp b/src/gtk/dataobj.cpp
index dc7effd7477fb4abcebe67a95b4533294cab031c..0791e6e092feaecc0415e31b37dc3ded3c0b05e2 100644 (file)
--- a/src/gtk/dataobj.cpp
+++ b/src/gtk/dataobj.cpp
@@ -1,5 +1,5 @@
 ///////////////////////////////////////////////////////////////////////////////
 ///////////////////////////////////////////////////////////////////////////////

-// Name:        dataobj.cpp
+// Name:        src/gtk/dataobj.cpp

 // Purpose:     wxDataObject class
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:     wxDataObject class
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,23 +7,30 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-#ifdef __GNUG__
-    #pragma implementation "dataobj.h"
-#endif
+// For compilers that support precompilation, includes "wx.h".
+#include "wx/wxprec.h"
+
+#if wxUSE_DATAOBJ

 
 #include "wx/dataobj.h"
 
 #include "wx/dataobj.h"

-#include "wx/app.h"
-#include "wx/debug.h"
+
+#ifndef WX_PRECOMP
+    #include "wx/log.h"
+    #include "wx/app.h"
+    #include "wx/image.h"
+#endif
+

 #include "wx/mstream.h"
 #include "wx/mstream.h"

-#include "wx/image.h"
+#include "wx/uri.h"

 
 

-#include "gdk/gdk.h"
+#include "wx/gtk/private.h"

 
 //-------------------------------------------------------------------------
 // global data
 //-------------------------------------------------------------------------
 
 GdkAtom  g_textAtom        = 0;
 
 //-------------------------------------------------------------------------
 // global data
 //-------------------------------------------------------------------------
 
 GdkAtom  g_textAtom        = 0;

+GdkAtom  g_altTextAtom     = 0;

 GdkAtom  g_pngAtom         = 0;
 GdkAtom  g_fileAtom        = 0;
 
 GdkAtom  g_pngAtom         = 0;
 GdkAtom  g_fileAtom        = 0;
 


@@ -33,7 +40,14 @@ GdkAtom  g_fileAtom        = 0;
 
 wxDataFormat::wxDataFormat()
 {
 
 wxDataFormat::wxDataFormat()
 {

-    PrepareFormats();
+    // do *not* call PrepareFormats() from here for 2 reasons:
+    //
+    // 1. we will have time to do it later because some other Set function
+    //    must be called before we really need them
+    //
+    // 2. doing so prevents us from declaring global wxDataFormats because
+    //    calling PrepareFormats (and thus gdk_atom_intern) before GDK is
+    //    initialised will result in a crash

     m_type = wxDF_INVALID;
     m_format = (GdkAtom) 0;
 }
     m_type = wxDF_INVALID;
     m_format = (GdkAtom) 0;
 }


@@ -44,13 +58,7 @@ wxDataFormat::wxDataFormat( wxDataFormatId type )
     SetType( type );
 }
 
     SetType( type );
 }
 

-wxDataFormat::wxDataFormat( const wxChar *id )
-{
-    PrepareFormats();
-    SetId( id );
-}
-
-wxDataFormat::wxDataFormat( const wxString &id )
+void wxDataFormat::InitFromString( const wxString &id )

 {
     PrepareFormats();
     SetId( id );
 {
     PrepareFormats();
     SetId( id );


@@ -64,10 +72,19 @@ wxDataFormat::wxDataFormat( NativeFormat format )
 
 void wxDataFormat::SetType( wxDataFormatId type )
 {
 
 void wxDataFormat::SetType( wxDataFormatId type )
 {

+    PrepareFormats();
+

     m_type = type;
 
     m_type = type;
 

-    if (m_type == wxDF_TEXT)
+#if wxUSE_UNICODE
+    if (m_type == wxDF_UNICODETEXT)

         m_format = g_textAtom;
         m_format = g_textAtom;

+    else if (m_type == wxDF_TEXT)
+        m_format = g_altTextAtom;
+#else
+    if (m_type == wxDF_TEXT || m_type == wxDF_UNICODETEXT)
+        m_format = g_textAtom;
+#endif

     else
     if (m_type == wxDF_BITMAP)
         m_format = g_pngAtom;
     else
     if (m_type == wxDF_BITMAP)
         m_format = g_pngAtom;


@@ -87,15 +104,23 @@ wxDataFormatId wxDataFormat::GetType() const
 
 wxString wxDataFormat::GetId() const
 {
 
 wxString wxDataFormat::GetId() const
 {

-    wxString ret( gdk_atom_name( m_format ) );  // this will convert from ascii to Unicode
-    return ret;
+    wxGtkString atom_name(gdk_atom_name(m_format));
+    return wxString::FromAscii(atom_name);

 }
 
 void wxDataFormat::SetId( NativeFormat format )
 {
 }
 
 void wxDataFormat::SetId( NativeFormat format )
 {

+    PrepareFormats();

     m_format = format;
 
     if (m_format == g_textAtom)
     m_format = format;
 
     if (m_format == g_textAtom)

+#if wxUSE_UNICODE
+        m_type = wxDF_UNICODETEXT;
+#else
+        m_type = wxDF_TEXT;
+#endif
+    else
+    if (m_format == g_altTextAtom)

         m_type = wxDF_TEXT;
     else
     if (m_format == g_pngAtom)
         m_type = wxDF_TEXT;
     else
     if (m_format == g_pngAtom)


@@ -107,49 +132,63 @@ void wxDataFormat::SetId( NativeFormat format )
         m_type = wxDF_PRIVATE;
 }
 
         m_type = wxDF_PRIVATE;
 }
 

-void wxDataFormat::SetId( const wxChar *id )
+void wxDataFormat::SetId( const wxString& id )

 {
 {

+    PrepareFormats();

     m_type = wxDF_PRIVATE;
     m_type = wxDF_PRIVATE;

-    wxString tmp( id );
-    m_format = gdk_atom_intern( wxMBSTRINGCAST tmp.mbc_str(), FALSE );  // what is the string cast for?
+    m_format = gdk_atom_intern( id.ToAscii(), FALSE );

 }
 
 void wxDataFormat::PrepareFormats()
 {
 }
 
 void wxDataFormat::PrepareFormats()
 {

+    // VZ: GNOME included in RedHat 6.1 uses the MIME types below and not the
+    //     atoms STRING and file:ALL as the old code was, but normal X apps
+    //     use STRING for text selection when transfering the data via
+    //     clipboard, for example, so do use STRING for now (GNOME apps will
+    //     probably support STRING as well for compatibility anyhow), but use
+    //     text/uri-list for file dnd because compatibility is not important
+    //     here (with whom?)

     if (!g_textAtom)
     if (!g_textAtom)

-        g_textAtom = gdk_atom_intern( "STRING", FALSE );
+#if wxUSE_UNICODE
+        g_textAtom = gdk_atom_intern( "UTF8_STRING", FALSE );
+        g_altTextAtom = gdk_atom_intern( "STRING", FALSE );
+#else
+        g_textAtom = gdk_atom_intern( "STRING" /* "text/plain" */, FALSE );
+#endif

     if (!g_pngAtom)
         g_pngAtom = gdk_atom_intern( "image/png", FALSE );
     if (!g_fileAtom)
     if (!g_pngAtom)
         g_pngAtom = gdk_atom_intern( "image/png", FALSE );
     if (!g_fileAtom)

-        g_fileAtom = gdk_atom_intern( "file:ALL", FALSE );
+        g_fileAtom = gdk_atom_intern( "text/uri-list", FALSE );

 }
 
 //-------------------------------------------------------------------------
 // wxDataObject
 //-------------------------------------------------------------------------
 
 }
 
 //-------------------------------------------------------------------------
 // wxDataObject
 //-------------------------------------------------------------------------
 

-IMPLEMENT_ABSTRACT_CLASS( wxDataObject, wxObject )
-

 wxDataObject::wxDataObject()
 {
 }
 
 wxDataObject::~wxDataObject()
 {
 wxDataObject::wxDataObject()
 {
 }
 
 wxDataObject::~wxDataObject()
 {

+    // dtor is empty but needed for Darwin and AIX -- otherwise it doesn't link

 }
 
 }
 

-bool wxDataObject::IsSupportedFormat(const wxDataFormat& format) const
+bool wxDataObject::IsSupportedFormat(const wxDataFormat& format, Direction dir) const

 {
 {

-    size_t nFormatCount = GetFormatCount();
-    if ( nFormatCount == 1 ) {
+    size_t nFormatCount = GetFormatCount(dir);
+    if ( nFormatCount == 1 )
+    {

         return format == GetPreferredFormat();
     }
         return format == GetPreferredFormat();
     }

-    else {
+    else
+    {

         wxDataFormat *formats = new wxDataFormat[nFormatCount];
         wxDataFormat *formats = new wxDataFormat[nFormatCount];

-        GetAllFormats(formats);
+        GetAllFormats(formats,dir);

 
         size_t n;
 
         size_t n;

-        for ( n = 0; n < nFormatCount; n++ ) {
+        for ( n = 0; n < nFormatCount; n++ )
+        {

             if ( formats[n] == format )
                 break;
         }
             if ( formats[n] == format )
                 break;
         }


@@ -161,28 +200,117 @@ bool wxDataObject::IsSupportedFormat(const wxDataFormat& format) const
     }
 }
 
     }
 }
 

+// ----------------------------------------------------------------------------
+// wxTextDataObject
+// ----------------------------------------------------------------------------
+
+#if wxUSE_UNICODE
+
+void
+wxTextDataObject::GetAllFormats(wxDataFormat *formats,
+                                wxDataObjectBase::Direction WXUNUSED(dir)) const
+{
+    *formats++ = GetPreferredFormat();
+    *formats = g_altTextAtom;
+}
+
+#endif // wxUSE_UNICODE
+

 // ----------------------------------------------------------------------------
 // wxFileDataObject
 // ----------------------------------------------------------------------------
 
 bool wxFileDataObject::GetDataHere(void *buf) const
 {
 // ----------------------------------------------------------------------------
 // wxFileDataObject
 // ----------------------------------------------------------------------------
 
 bool wxFileDataObject::GetDataHere(void *buf) const
 {

-    const wxString& filenames = GetFilenames();
-    memcpy( buf, filenames.mbc_str(), filenames.Len() + 1 );
+    wxString filenames;

 
 

-    return TRUE;
+    for (size_t i = 0; i < m_filenames.GetCount(); i++)
+    {
+        filenames += wxT("file:");
+        filenames += m_filenames[i];
+        filenames += wxT("\r\n");
+    }
+
+    memcpy( buf, filenames.mbc_str(), filenames.length() + 1 );
+
+    return true;

 }
 
 size_t wxFileDataObject::GetDataSize() const
 {
 }
 
 size_t wxFileDataObject::GetDataSize() const
 {

-    return GetFilenames().Len() + 1;
+    size_t res = 0;
+
+    for (size_t i = 0; i < m_filenames.GetCount(); i++)
+    {
+        // This is junk in UTF-8
+        res += m_filenames[i].length();
+        res += 5 + 2; // "file:" (5) + "\r\n" (2)
+    }
+
+    return res + 1;

 }
 
 }
 

-bool wxFileDataObject::SetData(const void *buf)
+bool wxFileDataObject::SetData(size_t WXUNUSED(size), const void *buf)

 {
 {

-    SetFilenames((const wxChar *)buf);
+    // we get data in the text/uri-list format, i.e. as a sequence of URIs
+    // (filenames prefixed by "file:") delimited by "\r\n". size includes
+    // the trailing zero (in theory, not for Nautilus in early GNOME
+    // versions).
+    
+    m_filenames.Empty();
+
+    const gchar *nexttemp = (const gchar*) buf;
+    for ( ; ; )
+    {
+        int len = 0;
+        const gchar *temp = nexttemp;
+        for (;;)
+        {
+            if (temp[len] == 0)
+            {
+                if (len > 0)
+                {
+                    // if an app omits '\r''\n'
+                    nexttemp = temp+len;
+                    break;
+                }
+                    
+                return true;
+            }
+            if (temp[len] == '\r')
+            {
+                if (temp[len+1] == '\n')
+                    nexttemp = temp+len+2;
+                else
+                    nexttemp = temp+len+1;
+                break;
+            }
+            len++;
+        }
+        
+        if (len == 0)
+            break;
+        
+        // required to give it a trailing zero
+        gchar *uri = g_strndup( temp, len );
+    
+        gchar *fn = g_filename_from_uri( uri, NULL, NULL );
+        
+        g_free( uri );
+    
+        if (fn)
+        {
+            AddFile( wxConvFileName->cMB2WX( fn ) );
+            g_free( fn );
+        }
+    }
+
+    return true;
+}

 
 

-    return TRUE;
+void wxFileDataObject::AddFile( const wxString &filename )
+{
+   m_filenames.Add( filename );

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------


@@ -222,97 +350,105 @@ bool wxBitmapDataObject::GetDataHere(void *buf) const
     {
         wxFAIL_MSG( wxT("attempt to copy empty bitmap failed") );
 
     {
         wxFAIL_MSG( wxT("attempt to copy empty bitmap failed") );
 

-        return FALSE;
+        return false;

     }
 
     memcpy(buf, m_pngData, m_pngSize);
 
     }
 
     memcpy(buf, m_pngData, m_pngSize);
 

-    return TRUE;
+    return true;

 }
 
 bool wxBitmapDataObject::SetData(size_t size, const void *buf)
 {
     Clear();
 
 }
 
 bool wxBitmapDataObject::SetData(size_t size, const void *buf)
 {
     Clear();
 

+    wxCHECK_MSG( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
+                 false, wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
+

     m_pngSize = size;
     m_pngData = malloc(m_pngSize);
 
     m_pngSize = size;
     m_pngData = malloc(m_pngSize);
 

-    memcpy( m_pngData, buf, m_pngSize );
+    memcpy(m_pngData, buf, m_pngSize);

 
 

-    wxMemoryInputStream mstream( (char*) m_pngData, m_pngSize );
+    wxMemoryInputStream mstream((char*) m_pngData, m_pngSize);

     wxImage image;
     wxImage image;

-    wxPNGHandler handler;
-    if ( !handler.LoadFile( &image, mstream ) )
+    if ( !image.LoadFile( mstream, wxBITMAP_TYPE_PNG ) )

     {
     {

-        return FALSE;
+        return false;

     }
 
     }
 

-    m_bitmap = image.ConvertToBitmap();
+    m_bitmap = wxBitmap(image);
+
+    return m_bitmap.Ok();

 }
 
 void wxBitmapDataObject::DoConvertToPng()
 {
 }
 
 void wxBitmapDataObject::DoConvertToPng()
 {

-    if (!m_bitmap.Ok())
+    if ( !m_bitmap.Ok() )

         return;
 
         return;
 

-    wxImage image( m_bitmap );
-    wxPNGHandler handler;
+    wxCHECK_RET( wxImage::FindHandler(wxBITMAP_TYPE_PNG) != NULL,
+                 wxT("You must call wxImage::AddHandler(new wxPNGHandler); to be able to use clipboard with bitmaps!") );
+
+    wxImage image = m_bitmap.ConvertToImage();

 
     wxCountingOutputStream count;
 
     wxCountingOutputStream count;

-    handler.SaveFile( &image, count );
+    image.SaveFile(count, wxBITMAP_TYPE_PNG);

 
     m_pngSize = count.GetSize() + 100; // sometimes the size seems to vary ???
     m_pngData = malloc(m_pngSize);
 
 
     m_pngSize = count.GetSize() + 100; // sometimes the size seems to vary ???
     m_pngData = malloc(m_pngSize);
 

-    wxMemoryOutputStream mstream( (char*) m_pngData, m_pngSize );
-    handler.SaveFile( &image, mstream );
+    wxMemoryOutputStream mstream((char*) m_pngData, m_pngSize);
+    image.SaveFile(mstream, wxBITMAP_TYPE_PNG);

 }
 
 // ----------------------------------------------------------------------------
 }
 
 // ----------------------------------------------------------------------------

-// wxPrivateDataObject
+// wxURLDataObject

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

-IMPLEMENT_CLASS( wxPrivateDataObject, wxDataObject )
-
-void wxPrivateDataObject::Free()
-{
-    if ( m_data )
-        free(m_data);
-}
-
-wxPrivateDataObject::wxPrivateDataObject()
+wxURLDataObject::wxURLDataObject(const wxString& url) :
+   wxDataObjectSimple( wxDataFormat( gdk_atom_intern("text/x-moz-url",FALSE) ) )

 {
 {

-    wxString id = wxT("application/");
-    id += wxTheApp->GetAppName();
-
-    m_format.SetId( id );
-
-    m_size = 0;
-    m_data = (void *)NULL;
+   m_url = url;

 }
 
 }
 

-void wxPrivateDataObject::SetData( const void *data, size_t size )
-{
-    Free();
-
-    m_size = size;
-    m_data = malloc(size);
-
-    memcpy( m_data, data, size );
+size_t wxURLDataObject::GetDataSize() const
+{ 
+    if (m_url.empty())
+        return 0;
+        
+    return 2*m_url.Len()+2;

 }
 
 }
 

-void wxPrivateDataObject::WriteData( void *dest ) const
-{
-    WriteData( m_data, dest );
+bool wxURLDataObject::GetDataHere(void *buf) const
+{ 
+    if (m_url.empty())
+        return false;
+    
+    wxCSConv conv( "UCS2" );
+    conv.FromWChar( (char*) buf, 2*m_url.Len()+2, m_url.wc_str() );
+    
+    return true;

 }
 
 }
 

-size_t wxPrivateDataObject::GetSize() const
-{
-    return m_size;
+    // copy data from buffer to our data
+bool wxURLDataObject::SetData(size_t len, const void *buf)
+{ 
+    if (len == 0)
+    {
+        m_url = wxEmptyString;
+        return false;
+    }
+    
+    wxCSConv conv( "UCS2" );
+    wxWCharBuffer res = conv.cMB2WC( (const char*) buf );
+    m_url = res;
+    int pos = m_url.Find( '\n' );
+    if (pos != wxNOT_FOUND)
+        m_url.Remove( pos, m_url.Len() - pos );
+    
+    return true;

 }
 
 }
 

-void wxPrivateDataObject::WriteData( const void *data, void *dest ) const
-{
-    memcpy( dest, data, GetSize() );
-}

 
 

+#endif // wxUSE_DATAOBJ