Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/choice.h b/include/wx/choice.h
index 5a421268ed8617bf01e0cf3a4d6360ae921b01ff..369dbb517a0d55ba7f1b5508b12202ee117b9f4c 100644 (file)
--- a/include/wx/choice.h
+++ b/include/wx/choice.h
@@ -1,13 +1,98 @@
-#ifndef __CHOICEH_BASE__
-#define __CHOICEH_BASE__
-
-#if defined(__WINDOWS__)
-#include "wx/msw/choice.h"
-#elif defined(__MOTIF__)
-#include "wx/xt/choice.h"
-#elif defined(__GTK__)
-#include "wx/gtk/choice.h"
-#endif
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/choice.h
+// Purpose:     wxChoice class interface
+// Author:      Vadim Zeitlin
+// Modified by:
+// Created:     26.07.99
+// RCS-ID:      $Id$
+// Copyright:   (c) wxWidgets team
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_CHOICE_H_BASE_
+#define _WX_CHOICE_H_BASE_
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#include "wx/defs.h"
+
+#if wxUSE_CHOICE
+
+#include "wx/ctrlsub.h"     // the base class
+
+// ----------------------------------------------------------------------------
+// global data
+// ----------------------------------------------------------------------------
+
+extern WXDLLIMPEXP_DATA_CORE(const char) wxChoiceNameStr[];
+
+// ----------------------------------------------------------------------------
+// wxChoice allows to select one of a non-modifiable list of strings
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_CORE wxChoiceBase : public wxControlWithItems
+{
+public:
+    wxChoiceBase() { }
+    virtual ~wxChoiceBase();
 
+    // all generic methods are in wxControlWithItems
+
+    // get the current selection: this can only be different from the normal
+    // selection if the popup items list is currently opened and the user
+    // selected some item in it but didn't close the list yet; otherwise (and
+    // currently always on platforms other than MSW) this is the same as
+    // GetSelection()
+    virtual int GetCurrentSelection() const { return GetSelection(); }
+
+    // set/get the number of columns in the control (as they're not supported on
+    // most platforms, they do nothing by default)
+    virtual void SetColumns(int WXUNUSED(n) = 1 ) { }
+    virtual int GetColumns() const { return 1 ; }
+
+    // emulate selecting the item event.GetInt()
+    void Command(wxCommandEvent& event);
+
+    // override wxItemContainer::IsSorted
+    virtual bool IsSorted() const { return HasFlag(wxCB_SORT); }
+
+protected:
+    // The generic implementation doesn't determine the height correctly and
+    // doesn't account for the width of the arrow but does take into account
+    // the string widths, so the derived classes should override it and set the
+    // height and add the arrow width to the size returned by this version.
+    virtual wxSize DoGetBestSize() const;
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxChoiceBase);
+};
+
+// ----------------------------------------------------------------------------
+// include the platform-dependent class definition
+// ----------------------------------------------------------------------------
+
+#if defined(__WXUNIVERSAL__)
+    #include "wx/univ/choice.h"
+#elif defined(__SMARTPHONE__) && defined(__WXWINCE__)
+    #include "wx/msw/wince/choicece.h"
+#elif defined(__WXMSW__)
+    #include "wx/msw/choice.h"
+#elif defined(__WXMOTIF__)
+    #include "wx/motif/choice.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/choice.h"
+#elif defined(__WXGTK__)
+    #include "wx/gtk1/choice.h"
+#elif defined(__WXMAC__)
+    #include "wx/osx/choice.h"
+#elif defined(__WXCOCOA__)
+    #include "wx/cocoa/choice.h"
+#elif defined(__WXPM__)
+    #include "wx/os2/choice.h"
 #endif
-    // __CHOICEH_BASE__
+
+#endif // wxUSE_CHOICE
+
+#endif // _WX_CHOICE_H_BASE_