Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/choice.h b/include/wx/gtk1/choice.h
index a6e0ecd1beb46ae62c3d6e9f41c23bfe75a87f47..139b8811e20ce2acaa09c41fe1fbe7b84948e86e 100644 (file)
--- a/include/wx/gtk1/choice.h
+++ b/include/wx/gtk1/choice.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        choice.h
+// Name:        wx/gtk1/choice.h

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


@@ -10,17 +10,14 @@
 #ifndef __GTKCHOICEH__
 #define __GTKCHOICEH__
 
 #ifndef __GTKCHOICEH__
 #define __GTKCHOICEH__
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "choice.h"
-#endif
-
-class WXDLLIMPEXP_BASE wxSortedArrayString;
+class WXDLLIMPEXP_FWD_BASE wxSortedArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

 
 //-----------------------------------------------------------------------------
 // wxChoice
 //-----------------------------------------------------------------------------
 
 
 //-----------------------------------------------------------------------------
 // wxChoice
 //-----------------------------------------------------------------------------
 

-class wxChoice : public wxChoiceBase
+class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase

 {
 public:
     wxChoice();
 {
 public:
     wxChoice();


@@ -32,54 +29,82 @@ public:
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {

-        m_strings = (wxSortedArrayString *)NULL;
+        m_strings = NULL;

 
         Create(parent, id, pos, size, n, choices, style, validator, name);
     }
 
         Create(parent, id, pos, size, n, choices, style, validator, name);
     }

-    ~wxChoice();
+    wxChoice( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos,
+            const wxSize& size,
+            const wxArrayString& choices,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr )
+    {
+        m_strings = NULL;
+
+        Create(parent, id, pos, size, choices, style, validator, name);
+    }
+    virtual ~wxChoice();

     bool Create( wxWindow *parent, wxWindowID id,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
     bool Create( wxWindow *parent, wxWindowID id,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,

-            int n = 0, const wxString choices[] = (wxString *) NULL,
+            int n = 0, const wxString choices[] = NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );
+    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 = wxChoiceNameStr );
 
     // implement base class pure virtuals
             long style = 0,
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr );
 
     // implement base class pure virtuals

-    void Delete(int n);
-    void Clear();
+    void DoDeleteOneItem(unsigned int n);
+    void DoClear();

 
     int GetSelection() const;
 
     int GetSelection() const;

-    void SetSelection( int n );
+    virtual void SetSelection(int n);
+
+    virtual unsigned int GetCount() const;
+    virtual int FindString(const wxString& s, bool bCase = false) const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& string);

 
 

-    virtual int GetCount() const;
-    int FindString( const wxString& string ) const;
-    wxString GetString( int n ) const;
-    void SetString( int n, const wxString& string );
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 
 protected:
     wxList m_clientList;    // contains the client data for the items
 
 
 protected:
     wxList m_clientList;    // contains the client data for the items
 

-    void ApplyWidgetStyle();
-    virtual int DoAppend(const wxString& item);
-    virtual int DoInsert(const wxString& item, int pos);
+    void DoApplyWidgetStyle(GtkRcStyle *style);
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);

 
 

-    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;

 
     virtual wxSize DoGetBestSize() const;
 
     virtual bool IsOwnGtkWindow( GdkWindow *window );
 
     virtual wxSize DoGetBestSize() const;
 
     virtual bool IsOwnGtkWindow( GdkWindow *window );

+

 private:
 private:

-    // common part of Create() and DoAppend()
-    int GtkAddHelper(GtkWidget *menu, int pos, const wxString& item);
+    // DoInsertItems() helper
+    int GtkAddHelper(GtkWidget *menu, unsigned int pos, const wxString& item);

 
     // this array is only used for controls with wxCB_SORT style, so only
     // allocate it if it's needed (hence using pointer)
     wxSortedArrayString *m_strings;
 
 
     // this array is only used for controls with wxCB_SORT style, so only
     // allocate it if it's needed (hence using pointer)
     wxSortedArrayString *m_strings;
 

+public:
+    // this circumvents a GTK+ 2.0 bug so that the selection is
+    // invalidated properly
+    int m_selection_hack;
+
+private:

     DECLARE_DYNAMIC_CLASS(wxChoice)
 };
 
     DECLARE_DYNAMIC_CLASS(wxChoice)
 };