Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/listbox.h b/include/wx/gtk1/listbox.h
index 5ffaa706c4e9cc6136f742fb4d58beb97f87897c..c9d6a48501f98d83e01a9090af0760227557ec35 100644 (file)
--- a/include/wx/gtk1/listbox.h
+++ b/include/wx/gtk1/listbox.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        listbox.h
+// Name:        wx/gtk1/listbox.h
 // Purpose:     wxListBox class declaration
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,21 +7,20 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
 #ifndef __GTKLISTBOXH__
 #define __GTKLISTBOXH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/list.h"
 
+typedef struct _GtkList GtkList;
+
+class WXDLLIMPEXP_FWD_BASE wxSortedArrayString;
+
 //-----------------------------------------------------------------------------
 // wxListBox
 //-----------------------------------------------------------------------------
 
-class wxListBox : public wxListBoxBase
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
 {
 public:
     // ctors and such
@@ -35,10 +34,23 @@ public:
             const wxString& name = wxListBoxNameStr )
     {
 #if wxUSE_CHECKLISTBOX
-        m_hasCheckBoxes = FALSE;
+        m_hasCheckBoxes = false;
 #endif // wxUSE_CHECKLISTBOX
         Create(parent, id, pos, size, n, choices, style, validator, name);
     }
+    wxListBox( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxListBoxNameStr )
+    {
+#if wxUSE_CHECKLISTBOX
+        m_hasCheckBoxes = false;
+#endif // wxUSE_CHECKLISTBOX
+        Create(parent, id, pos, size, choices, style, validator, name);
+    }
     virtual ~wxListBox();
 
     bool Create(wxWindow *parent, wxWindowID id,
@@ -48,31 +60,39 @@ public:
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxListBoxNameStr);
+    bool Create(wxWindow *parent, wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
 
     // implement base class pure virtuals
-    virtual void Clear();
-    virtual void Delete(int n);
+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);
 
-    virtual int GetCount() const;
-    virtual wxString GetString(int n) const;
-    virtual void SetString(int n, const wxString& s);
-    virtual int FindString(const wxString& s) const;
+    virtual unsigned int GetCount() const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& s);
+    virtual int FindString(const wxString& s, bool bCase = false) const;
 
     virtual bool IsSelected(int n) const;
-    virtual void SetSelection(int n, bool select = TRUE);
+    virtual void DoSetSelection(int n, bool select);
     virtual int GetSelection() const;
     virtual int GetSelections(wxArrayInt& aSelections) const;
 
-    virtual int DoAppend(const wxString& item);
-    virtual void DoInsertItems(const wxArrayString& items, int pos);
-    virtual void DoSetItems(const wxArrayString& items, void **clientData);
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);
 
     virtual void DoSetFirstItem(int n);
 
-    virtual void DoSetItemClientData(int n, void* clientData);
-    virtual void* DoGetItemClientData(int n) const;
-    virtual void DoSetItemClientObject(int n, wxClientData* clientData);
-    virtual wxClientData* DoGetItemClientObject(int n) const;
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     // implementation from now on
 
@@ -80,7 +100,7 @@ public:
     int GtkGetIndex( GtkWidget *item ) const;
     GtkWidget *GetConnectWidget();
     bool IsOwnGtkWindow( GdkWindow *window );
-    void ApplyWidgetStyle();
+    void DoApplyWidgetStyle(GtkRcStyle *style);
     void OnInternalIdle();
 
 #if wxUSE_TOOLTIPS
@@ -96,10 +116,19 @@ public:
 
     int        m_prevSelection;
     bool       m_blockEvent;
-    
+
+    virtual void FixUpMouseEvent(GtkWidget *widget, wxCoord& x, wxCoord& y);
+
 protected:
     virtual wxSize DoGetBestSize() const;
 
+    // return the string label for the given item
+    wxString GetRealLabel(struct _GList *item) const;
+
+    // Widgets that use the style->base colour for the BG colour should
+    // override this and return true.
+    virtual bool UseGTKStyleBase() const { return true; }
+
 private:
     // this array is only used for controls with wxCB_SORT style, so only
     // allocate it if it's needed (hence using pointer)