Fixed typo in wxFileName::GetHumanReadableSize docs.

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

diff --git a/interface/wx/choicdlg.h b/interface/wx/choicdlg.h
index bd2238a33b7831d2cdb210d4044840d28c138c45..c10074aad91a9ae1b11dbb448d50c19327d234b6 100644 (file)
--- a/interface/wx/choicdlg.h
+++ b/interface/wx/choicdlg.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wx[Multi|Single]ChoiceDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wx[Multi|Single]ChoiceDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

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


@@ -60,6 +60,10 @@ public:
         strings.
 
         @endWxPythonOnly
         strings.
 
         @endWxPythonOnly

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

     */
     wxMultiChoiceDialog(wxWindow* parent, const wxString& message,
                         const wxString& caption,
     */
     wxMultiChoiceDialog(wxWindow* parent, const wxString& message,
                         const wxString& caption,


@@ -103,6 +107,10 @@ public:
         strings.
 
         @endWxPythonOnly
         strings.
 
         @endWxPythonOnly

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

     */
     wxMultiChoiceDialog(wxWindow* parent,
                         const wxString& message,
     */
     wxMultiChoiceDialog(wxWindow* parent,
                         const wxString& message,


@@ -189,6 +197,10 @@ public:
         strings.
 
         @endWxPythonOnly
         strings.
 
         @endWxPythonOnly

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

     */
     wxSingleChoiceDialog(wxWindow* parent, const wxString& message,
                          const wxString& caption,
     */
     wxSingleChoiceDialog(wxWindow* parent, const wxString& message,
                          const wxString& caption,


@@ -237,6 +249,10 @@ public:
         strings.
 
         @endWxPythonOnly
         strings.
 
         @endWxPythonOnly

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

     */
     wxSingleChoiceDialog(wxWindow* parent,
                          const wxString& message,
     */
     wxSingleChoiceDialog(wxWindow* parent,
                          const wxString& message,


@@ -287,6 +303,10 @@ public:
     selected string. If the user pressed cancel, -1 is returned.
 
     @header{wx/choicdlg.h}
     selected string. If the user pressed cancel, -1 is returned.
 
     @header{wx/choicdlg.h}

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

 */
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
 */
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,


@@ -296,7 +316,9 @@ int wxGetSingleChoiceIndex(const wxString& message,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int y = -1,
                            bool centre = true,
                            int width = 150,

-                           int height = 200);
+                           int height = 200,
+                           int initialSelection = 0);
+

 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            int n,
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            int n,


@@ -306,8 +328,21 @@ int wxGetSingleChoiceIndex(const wxString& message,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int y = -1,
                            bool centre = true,
                            int width = 150,

-                           int height = 200);
+                           int height = 200,
+                           int initialSelection = 0);
+

 
 

+int wxGetSingleChoiceIndex(const wxString& message,
+                           const wxString& caption,
+                           const wxArrayString& choices,
+                           int initialSelection,
+                           wxWindow *parent = NULL);
+
+int wxGetSingleChoiceIndex(const wxString& message,
+                           const wxString& caption,
+                           int n, const wxString *choices,
+                           int initialSelection,
+                           wxWindow *parent = NULL);

 //@}
 
 /** @addtogroup group_funcmacro_dialog */
 //@}
 
 /** @addtogroup group_funcmacro_dialog */


@@ -328,6 +363,10 @@ int wxGetSingleChoiceIndex(const wxString& message,
     characters) is centred; if @false, the message is left-justified.
 
     @header{wx/choicdlg.h}
     characters) is centred; if @false, the message is left-justified.
 
     @header{wx/choicdlg.h}

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

 */
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
 */
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,


@@ -337,7 +376,8 @@ wxString wxGetSingleChoice(const wxString& message,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int y = -1,
                            bool centre = true,
                            int width = 150,

-                           int height = 200);
+                           int height = 200
+                           int initialSelection = 0);

 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            int n,
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            int n,


@@ -347,7 +387,21 @@ wxString wxGetSingleChoice(const wxString& message,
                            int y = -1,
                            bool centre = true,
                            int width = 150,
                            int y = -1,
                            bool centre = true,
                            int width = 150,

-                           int height = 200);
+                           int height = 200
+                           int initialSelection = 0);
+
+
+wxString wxGetSingleChoice(const wxString& message,
+                           const wxString& caption,
+                           const wxArrayString& choices,
+                           int initialSelection,
+                           wxWindow *parent = NULL);
+
+wxString wxGetSingleChoice(const wxString& message,
+                           const wxString& caption,
+                           int n, const wxString *choices,
+                           int initialSelection,
+                           wxWindow *parent = NULL);

 
 //@}
 
 
 //@}
 


@@ -361,6 +415,10 @@ wxString wxGetSingleChoice(const wxString& message,
     of elements as @c choices or @c aChoices!
 
     @header{wx/choicdlg.h}
     of elements as @c choices or @c aChoices!
 
     @header{wx/choicdlg.h}

+
+    @beginWxPerlOnly
+    Use an array reference for the @a aChoices and @a client_data parameters.
+    @endWxPerlOnly

 */
 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
 */
 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,


@@ -371,7 +429,9 @@ wxString wxGetSingleChoiceData(const wxString& message,
                                int y = -1,
                                bool centre = true,
                                int width = 150,
                                int y = -1,
                                bool centre = true,
                                int width = 150,

-                               int height = 200);
+                               int height = 200
+                               int initialSelection = 0);
+

 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
                                int n,
 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
                                int n,


@@ -382,7 +442,22 @@ wxString wxGetSingleChoiceData(const wxString& message,
                                int y = -1,
                                bool centre = true,
                                int width = 150,
                                int y = -1,
                                bool centre = true,
                                int width = 150,

-                               int height = 200);
+                               int height = 200
+                               int initialSelection = 0);
+
+void* wxGetSingleChoiceData(const wxString& message,
+                            const wxString& caption,
+                            const wxArrayString& choices,
+                            void **client_data,
+                            int initialSelection,
+                            wxWindow *parent = NULL);
+
+void* wxGetSingleChoiceData(const wxString& message,
+                            const wxString& caption,
+                            int n, const wxString *choices,
+                            void **client_data,
+                            int initialSelection,
+                            wxWindow *parent = NULL);

 
 //@}
 
 
 //@}
 


@@ -394,7 +469,8 @@ wxString wxGetSingleChoiceData(const wxString& message,
     multiple-selection listbox. The user may choose an arbitrary (including 0)
     number of items in the listbox whose indices will be returned in
     @c selections array. The initial contents of this array will be used to
     multiple-selection listbox. The user may choose an arbitrary (including 0)
     number of items in the listbox whose indices will be returned in
     @c selections array. The initial contents of this array will be used to

-    select the items when the dialog is shown.
+    select the items when the dialog is shown. If the user cancels the dialog,
+    the function returns -1 and @c selections array is left unchanged.

 
     You may pass the list of strings to choose from either using @c choices
     which is an array of @a n strings for the listbox or by using a single
 
     You may pass the list of strings to choose from either using @c choices
     which is an array of @a n strings for the listbox or by using a single


@@ -404,8 +480,14 @@ wxString wxGetSingleChoiceData(const wxString& message,
     characters) is centred; if @false, the message is left-justified.
 
     @header{wx/choicdlg.h}
     characters) is centred; if @false, the message is left-justified.
 
     @header{wx/choicdlg.h}

+
+    @beginWxPerlOnly
+    Use an array reference for the @a choices parameter.
+    In wxPerl there is no @a selections parameter; the function
+    returns an array containing the user selections.
+    @endWxPerlOnly

 */
 */

-size_t wxGetMultipleChoices(wxArrayInt& selections,
+int wxGetSelectedChoices(wxArrayInt& selections,

                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,
                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,


@@ -415,7 +497,8 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
                             bool centre = true,
                             int width = 150,
                             int height = 200);
                             bool centre = true,
                             int width = 150,
                             int height = 200);

-size_t wxGetMultipleChoices(wxArrayInt& selections,
+
+int wxGetSelectedChoices(wxArrayInt& selections,

                             const wxString& message,
                             const wxString& caption,
                             int n,
                             const wxString& message,
                             const wxString& caption,
                             int n,