Add new sample project files.

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

diff --git a/interface/wx/choice.h b/interface/wx/choice.h
index 7ea14bb7a3845bbf167cbf4cc5640706bc926dbd..fff0dfbfde4db063c39cf418f8176bda6416d8c9 100644 (file)
--- a/interface/wx/choice.h
+++ b/interface/wx/choice.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxChoice
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxChoice
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
 /////////////////////////////////////////////////////////////////////////////
 
 /**


@@ -18,9 +18,9 @@
            Sorts the entries alphabetically.
     @endStyleTable
 
            Sorts the entries alphabetically.
     @endStyleTable
 

-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}

     @event{EVT_CHOICE(id, func)}
     @event{EVT_CHOICE(id, func)}

-           Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
+           Process a @c wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the

            list is selected.
     @endEventTable
 
            list is selected.
     @endEventTable
 


@@ -40,7 +40,6 @@ public:
     */
     wxChoice();
 
     */
     wxChoice();
 

-    //@{

     /**
         Constructor, creating and showing a choice.
 
     /**
         Constructor, creating and showing a choice.
 


@@ -50,9 +49,10 @@ public:
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.
             Window identifier. The value wxID_ANY indicates a default value.
         @param pos
             Window position.

+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @param size

-            Window size. If wxDefaultSize is specified then the choice is sized
-            appropriately.
+            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
         @param n
             Number of strings with which to initialise the choice control.
         @param choices


@@ -72,14 +72,18 @@ public:
         arguments to a single argument, which is a list of strings.
 
         @endWxPythonOnly
         arguments to a single argument, which is a list of strings.
 
         @endWxPythonOnly

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
     */

-    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 = wxDefaultPosition,
+            const wxSize& size = wxDefaultSize,
+            int n = 0, const wxString choices[] = NULL,
+            long style = 0,
+            const wxValidator& validator = wxDefaultValidator,
+            const wxString& name = wxChoiceNameStr );

 
     /**
         Constructor, creating and showing a choice.
 
     /**
         Constructor, creating and showing a choice.


@@ -110,15 +114,18 @@ public:
         arguments to a single argument, which is a list of strings.
 
         @endWxPythonOnly
         arguments to a single argument, which is a list of strings.
 
         @endWxPythonOnly

+
+        @beginWxPerlOnly
+        Use an array reference for the @a choices parameter.
+        @endWxPerlOnly

     */
     */

-    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");
-    //@}
+    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 );

 
     /**
         Destructor, destroying the choice item.
 
     /**
         Destructor, destroying the choice item.


@@ -129,25 +136,26 @@ public:
     /**
         Creates the choice for two-step construction. See 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");
+    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 );

     //@}
 
     /**
         Gets the number of columns in this choice item.
 
     //@}
 
     /**
         Gets the number of columns in this choice item.
 

-        @remarks This is implemented for GTK and Motif only and always 
+        @remarks This is implemented for GTK and Motif only and always

                  returns 1 for the other platforms.
     */
     virtual int GetColumns() const;
                  returns 1 for the other platforms.
     */
     virtual int GetColumns() const;


@@ -172,7 +180,7 @@ public:
         @param n
             Number of columns.
 
         @param n
             Number of columns.
 

-        @remarks This is implemented for GTK and Motif only and doesn’t do 
+        @remarks This is implemented for GTK and Motif only and doesn’t do

                  anything under other platforms.
     */
     virtual void SetColumns(int n = 1);
                  anything under other platforms.
     */
     virtual void SetColumns(int n = 1);