Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2008-06-27 16:22:58 +00:00
parent 92b6654b66
commit ae3c17b401
277 changed files with 0 additions and 0 deletions
--- a/interface/wx/choice.h
+++ b/interface/wx/choice.h
@@ -0,0 +1,150 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        choice.h
+// Purpose:     interface of wxChoice
+// Author:      wxWidgets team
+// RCS-ID:      $Id$
+// Licence:     wxWindows license
+/////////////////////////////////////////////////////////////////////////////
+
+/**
+    @class wxChoice
+    @wxheader{choice.h}
+
+    A choice item is used to select one of a list of strings. Unlike a
+    wxListBox, only the selection is visible until the user pulls down the
+    menu of choices.
+
+    @beginStyleTable
+    @style{wxCB_SORT}
+           Sorts the entries alphabetically.
+    @endStyleTable
+
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_CHOICE(id, func)}
+           Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
+           list is selected.
+    @endEventTable
+
+    @library{wxcore}
+    @category{ctrl}
+    <!-- @appearance{choice.png} -->
+
+    @see wxListBox, wxComboBox, wxCommandEvent
+*/
+class wxChoice : public wxControlWithItems
+{
+public:
+    /**
+        Default constructor.
+
+        @see Create(), wxValidator
+    */
+    wxChoice();
+
+    //@{
+    /**
+        Constructor, creating and showing a choice.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param pos
+            Window position.
+        @param size
+            Window size. If wxDefaultSize is specified then the choice is sized
+            appropriately.
+        @param n
+            Number of strings with which to initialise the choice control.
+        @param choices
+            An array of strings with which to initialise the choice control.
+        @param style
+            Window style. See wxChoice.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
+
+        @see Create(), wxValidator
+
+        @beginWxPythonOnly
+
+        The wxChoice constructor in wxPython reduces the @a n and @a choices
+        arguments to a single argument, which is a list of strings.
+
+        @endWxPythonOnly
+    */
+    wxChoice(wxWindow* parent, wxWindowID id,
+             const wxPoint& pos,
+             const wxSize& size, int n,
+             const wxString choices[],
+             long style = 0,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = "choice");
+    wxChoice(wxWindow* parent, wxWindowID id,
+             const wxPoint& pos,
+             const wxSize& size,
+             const wxArrayString& choices,
+             long style = 0,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = "choice");
+    //@}
+
+    /**
+        Destructor, destroying the choice item.
+    */
+    ~wxChoice();
+
+    //@{
+    /**
+        Creates the choice for two-step construction. See wxChoice().
+    */
+    bool Create(wxWindow* parent, wxWindowID id, const wxPoint& pos,
+                const wxSize& size, int n,
+                const wxString choices[],
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = "choice");
+    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 = "choice");
+    //@}
+
+    /**
+        Gets the number of columns in this choice item.
+
+        @remarks This is implemented for GTK and Motif only and always 
+                 returns 1 for the other platforms.
+    */
+    int GetColumns() const;
+
+    /**
+        Unlike wxControlWithItems::GetSelection() which only returns the
+        accepted selection value, i.e. the selection in the control once the
+        user closes the dropdown list, this function returns the current
+        selection. That is, while the dropdown list is shown, it returns the
+        currently selected item in it. When it is not shown, its result is the
+        same as for the other function.
+
+        @since 2.6.2.
+               In older versions, wxControlWithItems::GetSelection() itself
+               behaved like this.
+    */
+    int GetCurrentSelection() const;
+
+    /**
+        Sets the number of columns in this choice item.
+
+        @param n
+            Number of columns.
+
+        @remarks This is implemented for GTK and Motif only and doesn’t do 
+                 anything under other platforms.
+    */
+    void SetColumns(int n = 1);
+};
+