Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/choice.h b/include/wx/gtk/choice.h
index 12d9a3a5fb719ac3b1b7501bd09a4819edac5192..eb1fe8989bd44c423016ee6d30f1ef6cff3e8ed9 100644 (file)
--- a/include/wx/gtk/choice.h
+++ b/include/wx/gtk/choice.h
@@ -7,20 +7,25 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __GTKCHOICEH__
-#define __GTKCHOICEH__
+#ifndef _WX_GTK_CHOICE_H_
+#define _WX_GTK_CHOICE_H_

 
 

-class WXDLLIMPEXP_BASE wxSortedArrayString;
-class WXDLLIMPEXP_BASE wxArrayString;
+class WXDLLIMPEXP_FWD_BASE wxSortedArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

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

+class wxGtkCollatedArrayString;
+

 class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase
 {
 public:
 class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase
 {
 public:

-    wxChoice();
+    wxChoice()
+    {
+        Init();
+    }

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


@@ -29,8 +34,7 @@ public:
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {

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

         Create(parent, id, pos, size, n, choices, style, validator, name);
     }
     wxChoice( wxWindow *parent, wxWindowID id,
         Create(parent, id, pos, size, n, choices, style, validator, name);
     }
     wxChoice( wxWindow *parent, wxWindowID id,


@@ -41,15 +45,14 @@ public:
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {

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

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

-    ~wxChoice();
+    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 );
             long style = 0,
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr );


@@ -61,12 +64,7 @@ public:
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr );
 
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr );
 

-    // implement base class pure virtuals
-    void Delete(unsigned int n);
-    void Clear();
-

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

-    int GetCurrentSelection() const { return GetSelection(); }

     void SetSelection(int n);
 
     virtual unsigned int GetCount() const;
     void SetSelection(int n);
 
     virtual unsigned int GetCount() const;


@@ -74,41 +72,48 @@ public:
     virtual wxString GetString(unsigned int n) const;
     virtual void SetString(unsigned int n, const wxString& string);
 
     virtual wxString GetString(unsigned int n) const;
     virtual void SetString(unsigned int n, const wxString& string);
 

+    virtual void SetColumns(int n=1);
+    virtual int GetColumns() const;
+
+    virtual void GTKDisableEvents();
+    virtual void GTKEnableEvents();
+

     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 
     static wxVisualAttributes
     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 

-    virtual bool IsOwnGtkWindow( GdkWindow *window );
-

 protected:
 protected:

-    wxList m_clientList;    // contains the client data for the items
+    // this array is only used for controls with wxCB_SORT style, so only
+    // allocate it if it's needed (hence using pointer)
+    wxGtkCollatedArrayString *m_strings;

 
 

-    void DoApplyWidgetStyle(GtkRcStyle *style);
-    virtual int DoAppend(const wxString& item);
-    virtual int DoInsert(const wxString& item, unsigned int pos);
+    // contains the client data for the items
+    wxArrayPtrVoid m_clientData;

 
 

-    virtual void DoSetItemClientData(unsigned int n, void* clientData);
-    virtual void* DoGetItemClientData(unsigned int n) const;
-    virtual void DoSetItemClientObject(unsigned int n, wxClientData* clientData);
-    virtual wxClientData* DoGetItemClientObject(unsigned int n) const;
+    // index to GtkListStore cell which displays the item text
+    int m_stringCellIndex;

 
     virtual wxSize DoGetBestSize() const;
 
     virtual wxSize DoGetBestSize() const;

+    virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);

 
 

-private:
-    // common part of Create() and DoAppend()
-    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;
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);

 
 

-public:
-    // this circumvents a GTK+ 2.0 bug so that the selection is
-    // invalidated properly
-    int m_selection_hack;
+    // in derived classes, implement this to insert list store entry
+    // with all items default except text
+    virtual void GTKInsertComboBoxTextItem( unsigned int n, const wxString& text );

 
 private:
 
 private:

+    void Init();
+

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

-#endif // __GTKCHOICEH__
+#endif // _WX_GTK_CHOICE_H_