little doc updates

[wxWidgets.git] / include / wx / gtk1 / listbox.h

diff --git a/include/wx/gtk1/listbox.h b/include/wx/gtk1/listbox.h
index 028422912dfb19da6fadb05cd1fb3465f65b0e47..6fa8de11cdbaa67835feb199d6e7ec7c82c81359 100644 (file)
--- a/include/wx/gtk1/listbox.h
+++ b/include/wx/gtk1/listbox.h
@@ -1,11 +1,10 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        listbox.h
-// Purpose:
+// Purpose:     wxListBox class declaration
 // Author:      Robert Roebling
-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -38,66 +37,82 @@ extern const char *wxListBoxNameStr;
 // wxListBox
 //-----------------------------------------------------------------------------
 
-class wxListBox: public wxControl
+class wxListBox : public wxControl
 {
-  DECLARE_DYNAMIC_CLASS(wxListBox)
-
-  public:
-
-    wxListBox(void);
-    inline wxListBox( wxWindow *parent, wxWindowID id,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           int n = 0, const wxString choices[] = (const wxString *) NULL,
-           long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxListBoxNameStr )
+DECLARE_DYNAMIC_CLASS(wxListBox)
+
+public:
+    wxListBox();
+    wxListBox( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = (const wxString *) NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxListBoxNameStr )
     {
-      Create(parent, id, pos, size, n, choices, style, validator, name);
+        m_hasCheckBoxes = FALSE;
+        Create(parent, id, pos, size, n, choices, style, validator, name);
     }
-    bool Create( wxWindow *parent, wxWindowID id,
-           const wxPoint& pos = wxDefaultPosition,
-           const wxSize& size = wxDefaultSize,
-           int n = 0, const wxString choices[] = (const wxString *) NULL,
-           long style = 0,
-           const wxValidator& validator = wxDefaultValidator,
-           const wxString& name = wxListBoxNameStr );
+    virtual ~wxListBox();
+
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                int n = 0, const wxString choices[] = (const wxString *) NULL,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
+
     void Append( const wxString &item );
-    void Append( const wxString &item, char *clientData );
-    void Clear(void);
+    void Append( const wxString &item, void* clientData );
+    void Append( const wxString &item, wxClientData* clientData );
+
+    void InsertItems(int nItems, const wxString items[], int pos);
+
+    void SetClientData( int n, void* clientData );
+    void* GetClientData( int n );
+    void SetClientObject( int n, wxClientData* clientData );
+    wxClientData* GetClientObject( int n );
+
+    void Clear();
     void Delete( int n );
+
     void Deselect( int n );
     int FindString( const wxString &item ) const;
-    char *GetClientData( int n ) const;
     int GetSelection(void) const;
     int GetSelections( class wxArrayInt &) const;
     wxString GetString( int n ) const;
     wxString GetStringSelection(void) const;
-    int Number(void);
+    int Number();
     bool Selected( int n );
     void Set( int n, const wxString *choices );
-    void SetClientData( int n, char *clientData );
     void SetFirstItem( int n );
     void SetFirstItem( const wxString &item );
     void SetSelection( int n, bool select = TRUE );
     void SetString( int n, const wxString &string );
     void SetStringSelection( const wxString &string, bool select = TRUE );
-    
-    void SetFont( const wxFont &font );
+
+#if wxUSE_DRAG_AND_DROP
     void SetDropTarget( wxDropTarget *dropTarget );
-    virtual void SetBackgroundColour(const wxColour &colour);
+#endif
 
-  // implementation
-    
+    // implementation
+
+    void AppendCommon( const wxString &item );
     int GetIndex( GtkWidget *item ) const;
-    GtkWidget *GetConnectWidget(void);
+    GtkWidget *GetConnectWidget();
     bool IsOwnGtkWindow( GdkWindow *window );
-    
-  private:
-  
+    void ApplyWidgetStyle();
+
+#if wxUSE_TOOLTIPS
+    void ApplyToolTip( GtkTooltips *tips, const char *tip );
+#endif // wxUSE_TOOLTIPS
+
     GtkList   *m_list;
-    wxList     m_clientData;
-    
+    wxList     m_clientDataList;
+    wxList     m_clientObjectList;
+    bool       m_hasCheckBoxes;
 };
 
 #endif // __GTKLISTBOXH__