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 a58c6bb5830345a6cec554072243727a7e2bfc1f..eb1fe8989bd44c423016ee6d30f1ef6cff3e8ed9 100644 (file)
--- a/include/wx/gtk/choice.h
+++ b/include/wx/gtk/choice.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

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


@@ -7,21 +7,25 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

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

 
 

-#ifdef __GNUG__
-    #pragma interface "choice.h"
-#endif
+class WXDLLIMPEXP_FWD_BASE wxSortedArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

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

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

 {
 public:
 {
 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,


@@ -30,57 +34,86 @@ 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);
     }
         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 )
+    {
+        Init();
+        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 );
             long style = 0,
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr );

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

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

-    void SetSelection( int n );
+    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 );
+    virtual void SetColumns(int n=1);
+    virtual int GetColumns() const;

 
 

-    // implementation
-    wxList m_clientList;    // contains the client data for the items
+    virtual void GTKDisableEvents();
+    virtual void GTKEnableEvents();

 
 

-    void DisableEvents();
-    void EnableEvents();
-    void AppendCommon( const wxString &item );
-    void ApplyWidgetStyle();
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);

 
 protected:
 
 protected:

-    virtual int DoAppend(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)
+    wxGtkCollatedArrayString *m_strings;

 
 

-    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;
+    // contains the client data for the items
+    wxArrayPtrVoid m_clientData;

 
 

-private:
-    // common part of Create() and DoAppend()
-    size_t AppendHelper(GtkWidget *menu, const wxString& item);
+    // index to GtkListStore cell which displays the item text
+    int m_stringCellIndex;

 
 

-    // 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 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);
+
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
+
+    // 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:
+    void Init();

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

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