Added wxPGChoices::Copy(), tweaked related documentation

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

diff --git a/include/wx/gtk/choice.h b/include/wx/gtk/choice.h
index a6e0ecd1beb46ae62c3d6e9f41c23bfe75a87f47..31704b746c943d1e04ffad6c91a5e672212742cf 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$
@@ -7,23 +7,23 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef __GTKCHOICEH__
-#define __GTKCHOICEH__
+#ifndef _WX_GTK_CHOICE_H_
+#define _WX_GTK_CHOICE_H_
 
-#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
 //-----------------------------------------------------------------------------
 
-class wxChoice : public wxChoiceBase
+class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase
 {
 public:
-    wxChoice();
+    wxChoice()
+    {
+        Init();
+    }
     wxChoice( wxWindow *parent, wxWindowID id,
             const wxPoint& pos = wxDefaultPosition,
             const wxSize& size = wxDefaultSize,
@@ -32,56 +32,87 @@ public:
             const wxValidator& validator = wxDefaultValidator,
             const wxString& name = wxChoiceNameStr )
     {
-        m_strings = (wxSortedArrayString *)NULL;
-
+        Init();
         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,
-            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
-    void Delete(int n);
-    void Clear();
+    void SendSelectionChangedEvent(wxEventType evt_type);
 
     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 void SetColumns(int n=1);
+    virtual int GetColumns() const;
+
+    virtual void DisableEvents();
+    virtual void EnableEvents();
 
-    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
+    // 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;
 
-    void ApplyWidgetStyle();
-    virtual int DoAppend(const wxString& item);
-    virtual int DoInsert(const wxString& item, int pos);
+    // contains the client data for the items
+    wxArrayPtrVoid m_clientData;
 
-    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;
+    // index to GtkListStore cell which displays the item text
+    int m_stringCellIndex;
 
     virtual wxSize DoGetBestSize() 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 bool IsOwnGtkWindow( GdkWindow *window );
-private:
-    // common part of Create() and DoAppend()
-    int GtkAddHelper(GtkWidget *menu, int pos, const wxString& item);
+    virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
+    virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 
-    // 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;
+    // 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)
 };
 
 
-#endif // __GTKCHOICEH__
+#endif // _WX_GTK_CHOICE_H_