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

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

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_CHOICE_H_
+#define _WX_GTK_CHOICE_H_

 
 

-#ifndef __GTKCHOICEH__
-#define __GTKCHOICEH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/list.h"
-#include "wx/control.h"
+class WXDLLIMPEXP_FWD_BASE wxSortedArrayString;
+class WXDLLIMPEXP_FWD_BASE wxArrayString;

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// classes
+// wxChoice

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxChoice;
+class wxGtkCollatedArrayString;

 
 

-//-----------------------------------------------------------------------------
-// global data
-//-----------------------------------------------------------------------------
+class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase
+{
+public:
+    wxChoice()
+    {
+        Init();
+    }
+    wxChoice( wxWindow *parent, wxWindowID id,
+            const wxPoint& pos = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = (const wxString *) NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr )
+    {
+        Init();
+        Create(parent, id, pos, size, n, choices, style, validator, name);
+    }
+    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[] = 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 );

 
 

-extern const char *wxChoiceNameStr;
+    int GetSelection() const;
+    void SetSelection(int n);

 
 

-//-----------------------------------------------------------------------------
-// wxChoice
-//-----------------------------------------------------------------------------
+    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);

 
 

-class wxChoice: public wxControl
-{
-  DECLARE_DYNAMIC_CLASS(wxChoice)
+    virtual void SetColumns(int n=1);
+    virtual int GetColumns() const;

 
 

-public:
+    virtual void GTKDisableEvents();
+    virtual void GTKEnableEvents();
+
+    static wxVisualAttributes
+    GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
+
+protected:
+    // 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;
+
+    // contains the client data for the items
+    wxArrayPtrVoid m_clientData;
+
+    // index to GtkListStore cell which displays the item text
+    int m_stringCellIndex;

 
 

-  wxChoice();
-  inline wxChoice( wxWindow *parent, wxWindowID id,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   int n = 0, const wxString choices[] = (const wxString *) NULL,
-                   long style = 0,
-                   const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = wxChoiceNameStr )
-  {
-      Create(parent, id, pos, size, n, choices, style, validator, name);
-  }
-  ~wxChoice();
-  bool Create( wxWindow *parent, wxWindowID id,
-               const wxPoint& pos = wxDefaultPosition,
-               const wxSize& size = wxDefaultSize,
-               int n = 0, const wxString choices[] = (wxString *) NULL,
-               long style = 0,
-               const wxValidator& validator = wxDefaultValidator,
-               const wxString& name = wxChoiceNameStr );
-
-  void Append( const wxString &item );
-  void Append( const wxString &item, void* clientData );
-  void Append( const wxString &item, wxClientData* clientData );
-  
-  void SetClientData( int n, void* clientData );
-  void* GetClientData( int n );
-  void SetClientObject( int n, wxClientData* clientData );
-  wxClientData* GetClientObject( int n );
-  
-  void Clear();
-  void Delete(int n);
-  
-  int FindString( const wxString &string ) const;
-  int GetColumns() const;
-  int GetSelection();
-  wxString GetString( int n ) const;
-  wxString GetStringSelection() const;
-  int Number() const;
-  void SetColumns( int n = 1 );
-  void SetSelection( int n );
-  void SetStringSelection( const wxString &string );
-    
-// implementation
-    
-  wxList   m_clientDataList;
-  wxList   m_clientObjectList;
-
-  void AppendCommon( const wxString &item );
-  void ApplyWidgetStyle();
+    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)

 };
 
 };
 

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