]> git.saurik.com Git - wxWidgets.git/blobdiff - src/gtk/listbox.cpp
Improve wxMenu docs
[wxWidgets.git] / src / gtk / listbox.cpp
index 1a53e991677d6ef581b1a45ba3f4a16546bcfb22..b159d8de729b175416e23088efab6f15163d5e4a 100644 (file)
@@ -62,9 +62,9 @@ extern bool           g_blockEventsOnScroll;
 
 extern "C" {
 static void
-gtk_listbox_row_activated_callback(GtkTreeView        *treeview,
+gtk_listbox_row_activated_callback(GtkTreeView        * WXUNUSED(treeview),
                                    GtkTreePath        *path,
-                                   GtkTreeViewColumn  *col,
+                                   GtkTreeViewColumn  * WXUNUSED(col),
                                    wxListBox          *listbox)
 {
     if (g_blockEventsOnDrag) return;
@@ -104,7 +104,7 @@ gtk_listbox_row_activated_callback(GtkTreeView        *treeview,
         event.SetInt(-1);
     }
 
-    listbox->GetEventHandler()->ProcessEvent( event );
+    listbox->HandleWindowEvent( event );
 }
 }
 
@@ -114,7 +114,8 @@ gtk_listbox_row_activated_callback(GtkTreeView        *treeview,
 
 extern "C" {
 static void
-gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
+gtk_listitem_changed_callback(GtkTreeSelection * WXUNUSED(selection),
+                              wxListBox *listbox )
 {
     if (g_blockEventsOnDrag) return;
 
@@ -134,7 +135,7 @@ gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
             event.SetExtraLong( 0 );
             event.SetInt( -1 );
 
-            listbox->GetEventHandler()->ProcessEvent( event );
+            listbox->HandleWindowEvent( event );
 
             return;
         }
@@ -144,7 +145,7 @@ gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
             event.SetExtraLong( 1 );
             event.SetInt( selections[0] );
 
-            listbox->GetEventHandler()->ProcessEvent( event );
+            listbox->HandleWindowEvent( event );
         }
     }
     else
@@ -156,7 +157,7 @@ gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
             event.SetExtraLong( 0 );
             event.SetInt( -1 );
 
-            listbox->GetEventHandler()->ProcessEvent( event );
+            listbox->HandleWindowEvent( event );
 
             return;
         }
@@ -177,7 +178,7 @@ gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
             else if ( listbox->HasClientUntypedData() )
                 event.SetClientData( gtk_tree_entry_get_userdata(entry) );
 
-            listbox->GetEventHandler()->ProcessEvent( event );
+            listbox->HandleWindowEvent( event );
 
             g_object_unref (entry);
         }
@@ -185,6 +186,69 @@ gtk_listitem_changed_callback( GtkTreeSelection* selection, wxListBox *listbox )
 }
 }
 
+//-----------------------------------------------------------------------------
+// "key_press_event"
+//-----------------------------------------------------------------------------
+
+extern "C" {
+static gint
+gtk_listbox_key_press_callback( GtkWidget *WXUNUSED(widget),
+                                GdkEventKey *gdk_event,
+                                wxListBox *listbox )
+{
+    if ((gdk_event->keyval == GDK_Return) || 
+        (gdk_event->keyval == GDK_ISO_Enter) ||
+        (gdk_event->keyval == GDK_KP_Enter))
+    {
+        int index = listbox->GetSelection();
+        if (index != wxNOT_FOUND)
+        {
+        
+            wxCommandEvent event(wxEVT_COMMAND_LISTBOX_DOUBLECLICKED, listbox->GetId() );
+            event.SetEventObject( listbox );
+            
+            GtkTreeEntry* entry = listbox->GtkGetEntry( index );
+
+            // indicate that this is a selection
+            event.SetExtraLong( 1 );
+
+            event.SetInt( index );
+            event.SetString(wxConvUTF8.cMB2WX(gtk_tree_entry_get_label(entry)));
+
+            if ( listbox->HasClientObjectData() )
+                event.SetClientObject(
+                    (wxClientData*) gtk_tree_entry_get_userdata(entry)
+                                 );
+            else if ( listbox->HasClientUntypedData() )
+                event.SetClientData( gtk_tree_entry_get_userdata(entry) );
+
+            /* bool ret = */ listbox->HandleWindowEvent( event );
+
+            g_object_unref (entry);
+            
+//          wxMac and wxMSW always invoke default action
+//          if (!ret)
+            {
+                // DClick not handled -> invoke default action
+                wxWindow *tlw = wxGetTopLevelParent( listbox );
+                if (tlw)
+                {
+                    GtkWindow *gtk_window = GTK_WINDOW( tlw->GetHandle() );
+                    if (gtk_window)
+                        gtk_window_activate_default( gtk_window );
+                }
+            }
+            
+            // Always intercept, otherwise we'd get another dclick
+            // event from row_activated
+            return TRUE;
+        }
+    }
+    
+    return FALSE;
+}
+}
+
 //-----------------------------------------------------------------------------
 // GtkTreeEntry destruction (to destroy client data)
 //-----------------------------------------------------------------------------
@@ -207,7 +271,7 @@ static void gtk_tree_entry_destroy_cb(GtkTreeEntry* entry,
 //-----------------------------------------------------------------------------
 
 extern "C" {
-static gint gtk_listbox_sort_callback(GtkTreeModel *model,
+static gint gtk_listbox_sort_callback(GtkTreeModel * WXUNUSED(model),
                                       GtkTreeIter  *a,
                                       GtkTreeIter  *b,
                                       wxListBox    *listbox)
@@ -228,8 +292,8 @@ static gint gtk_listbox_sort_callback(GtkTreeModel *model,
 
     //We compare collate keys here instead of calling g_utf8_collate
     //as it is rather slow (and even the docs reccommend this)
-    int ret = strcasecmp(gtk_tree_entry_get_collate_key(entry),
-                         gtk_tree_entry_get_collate_key(entry2));
+    int ret = strcmp(gtk_tree_entry_get_collate_key(entry),
+                     gtk_tree_entry_get_collate_key(entry2));
 
     g_object_unref (entry);
     g_object_unref (entry2);
@@ -243,8 +307,8 @@ static gint gtk_listbox_sort_callback(GtkTreeModel *model,
 //-----------------------------------------------------------------------------
 
 extern "C" {
-static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model,
-                                                 gint column,
+static gboolean gtk_listbox_searchequal_callback(GtkTreeModel * WXUNUSED(model),
+                                                 gint WXUNUSED(column),
                                                  const gchar* key,
                                                  GtkTreeIter* iter,
                                                  wxListBox* listbox)
@@ -258,8 +322,8 @@ static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model,
     wxCHECK_MSG(entry, 0, wxT("Could not get entry"));
     wxGtkString keycollatekey(g_utf8_collate_key(key, -1));
 
-    int ret = strcasecmp(keycollatekey,
-                         gtk_tree_entry_get_collate_key(entry));
+    int ret = strcmp(keycollatekey,
+                     gtk_tree_entry_get_collate_key(entry));
 
     g_object_unref (entry);
 
@@ -271,7 +335,7 @@ static gboolean gtk_listbox_searchequal_callback(GtkTreeModel* model,
 // wxListBox
 //-----------------------------------------------------------------------------
 
-IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControl)
+IMPLEMENT_DYNAMIC_CLASS(wxListBox, wxControlWithItems)
 
 // ----------------------------------------------------------------------------
 // construction
@@ -303,7 +367,6 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
                         long style, const wxValidator& validator,
                         const wxString &name )
 {
-    m_needParent = true;
     m_blockEvent = false;
 
     if (!PreCreation( parent, pos, size ) ||
@@ -397,7 +460,7 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
     gtk_tree_selection_set_mode( selection, mode );
 
     // Handle sortable stuff
-    if(style & wxLB_SORT)
+    if(HasFlag(wxLB_SORT))
     {
         // Setup sorting in ascending (wx) order
         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(m_liststore),
@@ -419,12 +482,16 @@ bool wxListBox::Create( wxWindow *parent, wxWindowID id,
     gtk_widget_show( GTK_WIDGET(m_treeview) );
     m_focusWidget = GTK_WIDGET(m_treeview);
 
-    wxListBox::DoInsertItems(wxArrayString(n, choices), 0); // insert initial items
+    Append(n, choices); // insert initial items
 
     // generate dclick events
     g_signal_connect_after(m_treeview, "row-activated",
                      G_CALLBACK(gtk_listbox_row_activated_callback), this);
 
+    // for intercepting dclick generation by <ENTER>
+    g_signal_connect (m_treeview, "key_press_event",
+                      G_CALLBACK (gtk_listbox_key_press_callback),
+                           this);
     m_parent->DoAddChild( this );
 
     PostCreation(size);
@@ -444,92 +511,53 @@ wxListBox::~wxListBox()
 // adding items
 // ----------------------------------------------------------------------------
 
-void wxListBox::GtkInsertItems(const wxArrayString& items,
-                               void** clientData, unsigned int pos)
+int wxListBox::DoInsertItems(const wxArrayStringsAdapter& items,
+                             unsigned int pos,
+                             void **clientData,
+                             wxClientDataType type)
 {
-    wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
+    wxCHECK_MSG( m_treeview != NULL, wxNOT_FOUND, wxT("invalid listbox") );
 
     InvalidateBestSize();
 
-    // Create and set column ids and GValues
-
-    unsigned int nNum = items.GetCount();
-    unsigned int nCurCount = wxListBox::GetCount();
-    wxASSERT_MSG(pos <= nCurCount, wxT("Invalid index passed to wxListBox"));
-
     GtkTreeIter* pIter = NULL; // append by default
     GtkTreeIter iter;
-    if (pos != nCurCount)
+    if ( pos != GetCount() )
     {
-        wxCHECK_RET( GtkGetIteratorFor(pos, &iter),
+        wxCHECK_MSG( GtkGetIteratorFor(pos, &iter), wxNOT_FOUND,
                      wxT("internal wxListBox error in insertion") );
 
         pIter = &iter;
     }
 
-    for (unsigned int i = 0; i < nNum; ++i)
+    const unsigned int numItems = items.GetCount();
+    for ( unsigned int i = 0; i < numItems; ++i )
     {
-        wxString label = items[i];
-
         GtkTreeEntry* entry = gtk_tree_entry_new();
-        gtk_tree_entry_set_label(entry, wxGTK_CONV(label));
+        gtk_tree_entry_set_label(entry, wxGTK_CONV(items[i]));
         gtk_tree_entry_set_destroy_func(entry,
                 (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
                             this);
 
-        if (clientData)
-            gtk_tree_entry_set_userdata(entry, clientData[i]);
-
         GtkTreeIter itercur;
         gtk_list_store_insert_before(m_liststore, &itercur, pIter);
 
         GtkSetItem(itercur, entry);
 
         g_object_unref (entry);
-    }
-}
-
-void wxListBox::DoInsertItems(const wxArrayString& items, unsigned int pos)
-{
-    wxCHECK_RET( IsValidInsert(pos), wxT("invalid index in wxListBox::InsertItems") );
-
-    GtkInsertItems(items, NULL, pos);
-}
-
-int wxListBox::DoAppend( const wxString& item )
-{
-    wxCHECK_MSG( m_treeview != NULL, -1, wxT("invalid listbox") );
-
-    InvalidateBestSize();
-
-    GtkTreeEntry* entry = gtk_tree_entry_new();
-    gtk_tree_entry_set_label( entry, wxGTK_CONV(item) );
-    gtk_tree_entry_set_destroy_func(entry,
-                (GtkTreeEntryDestroy)gtk_tree_entry_destroy_cb,
-                            this);
 
-    GtkTreeIter itercur;
-    gtk_list_store_insert_before( m_liststore, &itercur, NULL );
-
-    GtkSetItem(itercur, entry);
-
-    g_object_unref (entry);
-
-    return GtkGetIndexFor(itercur);
-}
+        if (clientData)
+            AssignNewItemClientData(GtkGetIndexFor(itercur), clientData, i, type);
+    }
 
-void wxListBox::DoSetItems( const wxArrayString& items,
-                            void **clientData)
-{
-    Clear();
-    GtkInsertItems(items, clientData, 0);
+    return pos + numItems - 1;
 }
 
 // ----------------------------------------------------------------------------
 // deleting items
 // ----------------------------------------------------------------------------
 
-void wxListBox::Clear()
+void wxListBox::DoClear()
 {
     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 
@@ -538,7 +566,7 @@ void wxListBox::Clear()
     gtk_list_store_clear( m_liststore ); /* well, THAT was easy :) */
 }
 
-void wxListBox::Delete(unsigned int n)
+void wxListBox::DoDeleteOneItem(unsigned int n)
 {
     wxCHECK_RET( m_treeview != NULL, wxT("invalid listbox") );
 
@@ -633,11 +661,6 @@ void* wxListBox::DoGetItemClientData(unsigned int n) const
     return userdata;
 }
 
-wxClientData* wxListBox::DoGetItemClientObject(unsigned int n) const
-{
-    return (wxClientData*) wxListBox::DoGetItemClientData(n);
-}
-
 void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
 {
     wxCHECK_RET( IsValid(n),
@@ -650,12 +673,6 @@ void wxListBox::DoSetItemClientData(unsigned int n, void* clientData)
     g_object_unref (entry);
 }
 
-void wxListBox::DoSetItemClientObject(unsigned int n, wxClientData* clientData)
-{
-    // wxItemContainer already deletes data for us
-    wxListBox::DoSetItemClientData(n, (void*) clientData);
-}
-
 // ----------------------------------------------------------------------------
 // string list access
 // ----------------------------------------------------------------------------
@@ -819,10 +836,17 @@ void wxListBox::GtkSetSelection(int n, const bool select, const bool blockEvent)
     else
         gtk_tree_selection_unselect_iter(selection, &iter);
 
+    GtkTreePath* path = gtk_tree_model_get_path(
+                        GTK_TREE_MODEL(m_liststore), &iter);
+
+    gtk_tree_view_scroll_to_cell(m_treeview, path, NULL, FALSE, 0.0f, 0.0f);
+
+    gtk_tree_path_free(path);
+
     m_blockEvent = false;
 }
 
-void wxListBox::DoSetFirstItem( int n )
+void wxListBox::DoScrollToCell(int n, float alignY, float alignX)
 {
     wxCHECK_RET( m_treeview, wxT("invalid listbox") );
     wxCHECK_RET( IsValid(n), wxT("invalid index"));
@@ -840,11 +864,21 @@ void wxListBox::DoSetFirstItem( int n )
 
     // Scroll to the desired cell (0.0 == topleft alignment)
     gtk_tree_view_scroll_to_cell(m_treeview, path, NULL,
-                                 TRUE, 0.0f, 0.0f);
+                                 TRUE, alignY, alignX);
 
     gtk_tree_path_free(path);
 }
 
+void wxListBox::DoSetFirstItem(int n)
+{
+    DoScrollToCell(n, 0, 0);
+}
+
+void wxListBox::EnsureVisible(int n)
+{
+    DoScrollToCell(n, 0.5, 0);
+}
+
 // ----------------------------------------------------------------------------
 // hittest
 // ----------------------------------------------------------------------------
@@ -887,10 +921,10 @@ int wxListBox::DoListHitTest(const wxPoint& point) const
 // ----------------------------------------------------------------------------
 
 #if wxUSE_TOOLTIPS
-void wxListBox::ApplyToolTip( GtkTooltips *tips, const wxChar *tip )
+void wxListBox::ApplyToolTip( GtkTooltips *tips, const gchar *tip )
 {
     // RN: Is this needed anymore?
-    gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), wxGTK_CONV(tip), (gchar*) NULL );
+    gtk_tooltips_set_tip( tips, GTK_WIDGET( m_treeview ), tip, (gchar*) NULL );
 }
 #endif // wxUSE_TOOLTIPS
 
@@ -929,43 +963,40 @@ wxSize wxListBox::DoGetBestSize() const
     // Start with a minimum size that's not too small
     int cx, cy;
     GetTextExtent( wxT("X"), &cx, &cy);
-    int lbWidth = 3 * cx;
+    int lbWidth = 0;
     int lbHeight = 10;
 
-    // Get the visible area of the tree view (limit to the 10th item
-    // so that it isn't too big)
-    unsigned int count = GetCount();
-    if (count)
+    // Find the widest string.
+    const unsigned int count = GetCount();
+    if ( count )
     {
         int wLine;
-
-        // Find the widest line
-        for(unsigned int i = 0; i < count; i++) {
-            wxString str(GetString(i));
-            GetTextExtent(str, &wLine, NULL);
-            lbWidth = wxMax(lbWidth, wLine);
+        for ( unsigned int i = 0; i < count; i++ )
+        {
+            GetTextExtent(GetString(i), &wLine, NULL);
+            if ( wLine > lbWidth )
+                lbWidth = wLine;
         }
+    }
 
-        lbWidth += 3 * cx;
+    lbWidth += 3 * cx;
 
-        // And just a bit more for the checkbox if present and then some
-        // (these are rough guesses)
+    // And just a bit more for the checkbox if present and then some
+    // (these are rough guesses)
 #if wxUSE_CHECKLISTBOX
-        if ( m_hasCheckBoxes )
-        {
-            lbWidth += 35;
-            cy = cy > 25 ? cy : 25; // rough height of checkbox
-        }
-#endif
-
-        // don't make the listbox too tall (limit height to around 10 items) but don't
-        // make it too small neither
-        lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
+    if ( m_hasCheckBoxes )
+    {
+        lbWidth += 35;
+        cy = cy > 25 ? cy : 25; // rough height of checkbox
     }
+#endif
 
     // Add room for the scrollbar
     lbWidth += wxSystemSettings::GetMetric(wxSYS_VSCROLL_X);
 
+    // Don't make the listbox too tall but don't make it too small neither
+    lbHeight = (cy+4) * wxMin(wxMax(count, 3), 10);
+
     wxSize best(lbWidth, lbHeight);
     CacheBestSize(best);
     return best;