replace @seealso with @see; as Vaclav pointed out we shouldn't use custom aliases...

[wxWidgets.git] / interface / choicdlg.h

diff --git a/interface/choicdlg.h b/interface/choicdlg.h
index 4f6f99974fa389a10346f8453a2ef0163267ef0c..969b77c2d8cd367ffa7a8eb3a44c6042b7f3d2bd 100644 (file)
--- a/interface/choicdlg.h
+++ b/interface/choicdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        choicdlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        choicdlg.h

-// Purpose:     documentation for wxMultiChoiceDialog class
+// Purpose:     interface of wxMultiChoiceDialog

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -16,8 +16,7 @@
     @library{wxbase}
     @category{cmndlg}
 
     @library{wxbase}
     @category{cmndlg}
 

-    @seealso
-    @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
+    @see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",

     wxSingleChoiceDialog
 */
 class wxMultiChoiceDialog : public wxDialog
     wxSingleChoiceDialog
 */
 class wxMultiChoiceDialog : public wxDialog


@@ -28,45 +27,62 @@ public:
         Constructor taking an array of wxString choices.
         
         @param parent
         Constructor taking an array of wxString choices.
         
         @param parent

-        Parent window.
-        
+            Parent window.

         @param message
         @param message

-        Message to show on the dialog.
-        
+            Message to show on the dialog.

         @param caption
         @param caption

-        The dialog caption.
-        
+            The dialog caption.

         @param n
         @param n

-        The number of choices.
-        
+            The number of choices.

         @param choices
         @param choices

-        An array of strings, or a string list, containing the choices.
-        
+            An array of strings, or a string list, containing the choices.

         @param style
         @param style

-        A dialog style (bitlist) containing flags chosen from standard
-        dialog styles and the following:
+            A dialog style (bitlist) containing flags chosen from standard
+            dialog styles and the following:
+        
+        
+        
+        
+        
+        
+        
+            wxOK
+        
+        
+        
+        
+            Show an OK button.

         
         
         
         

-        wxOK

         
         
         
         

-        Show an OK button.

         
         

-        wxCANCEL
+            wxCANCEL

         
         
         
         

-        Show a Cancel button.

         
         

-        wxCENTRE

         
         

+            Show a Cancel button.

         
         

-        Centre the message. Not Windows.

         
         

-        The default value is equivalent to wxDEFAULT_DIALOG_STYLE |  wxRESIZE_BORDER |
-        wxOK |  wxCANCEL |  wxCENTRE.

         
         

+        
+        
+            wxCENTRE
+        
+        
+        
+        
+            Centre the message. Not Windows.
+        
+        
+        
+        
+        
+            The default value is equivalent to wxDEFAULT_DIALOG_STYLE |
+        wxRESIZE_BORDER |  wxOK |  wxCANCEL |  wxCENTRE.

         @param pos
         @param pos

-        Dialog position. Not Windows.
+            Dialog position. Not Windows.

         
         @remarks Use ShowModal() to show the dialog.
     */
         
         @remarks Use ShowModal() to show the dialog.
     */


@@ -87,12 +103,12 @@ public:
     /**
         Returns array with indexes of selected items.
     */
     /**
         Returns array with indexes of selected items.
     */

-    wxArrayInt GetSelection();
+    wxArrayInt GetSelection() const;

 
     /**
         Sets selected items from the array of selected items' indexes.
     */
 
     /**
         Sets selected items from the array of selected items' indexes.
     */

-    void SetSelections(const wxArrayInt& selections);
+    void SetSelections(const wxArrayInt& selections) const;

 
     /**
         Shows the dialog, returning either wxID_OK or wxID_CANCEL.
 
     /**
         Shows the dialog, returning either wxID_OK or wxID_CANCEL.


@@ -101,6 +117,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxSingleChoiceDialog
     @wxheader{choicdlg.h}
 /**
     @class wxSingleChoiceDialog
     @wxheader{choicdlg.h}


@@ -112,9 +129,8 @@ public:
     @library{wxbase}
     @category{cmndlg}
 
     @library{wxbase}
     @category{cmndlg}
 

-    @seealso
-    @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog overview",
-    wxMultiChoiceDialog
+    @see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog
+    overview", wxMultiChoiceDialog

 */
 class wxSingleChoiceDialog : public wxDialog
 {
 */
 class wxSingleChoiceDialog : public wxDialog
 {


@@ -124,49 +140,65 @@ public:
         Constructor, taking an array of wxString choices and optional client data.
         
         @param parent
         Constructor, taking an array of wxString choices and optional client data.
         
         @param parent

-        Parent window.
-        
+            Parent window.

         @param message
         @param message

-        Message to show on the dialog.
-        
+            Message to show on the dialog.

         @param caption
         @param caption

-        The dialog caption.
-        
+            The dialog caption.

         @param n
         @param n

-        The number of choices.
-        
+            The number of choices.

         @param choices
         @param choices

-        An array of strings, or a string list, containing the choices.
-        
+            An array of strings, or a string list, containing the choices.

         @param clientData
         @param clientData

-        An array of client data to be associated with the items.
-        See GetSelectionClientData.
-        
+            An array of client data to be associated with the items.
+            See GetSelectionClientData.

         @param style
         @param style

-        A dialog style (bitlist) containing flags chosen from standard
-        dialog styles and the following:
+            A dialog style (bitlist) containing flags chosen from standard
+            dialog styles and the following:
+        
+        
+        
+        
+        
+        
+        
+            wxOK
+        
+        
+        
+        
+            Show an OK button.
+        

         
         
         
         

-        wxOK

         
         
         
         

-        Show an OK button.
+            wxCANCEL

         
         

-        wxCANCEL

         
         
         
         

-        Show a Cancel button.

         
         

-        wxCENTRE
+            Show a Cancel button.

         
         
         
         

-        Centre the message. Not Windows.

         
         

-        The default value is equivalent to wxDEFAULT_DIALOG_STYLE |  wxRESIZE_BORDER |
-        wxOK |  wxCANCEL |  wxCENTRE.

         
         

+        
+            wxCENTRE
+        
+        
+        
+        
+            Centre the message. Not Windows.
+        
+        
+        
+        
+        
+            The default value is equivalent to wxDEFAULT_DIALOG_STYLE |
+        wxRESIZE_BORDER |  wxOK |  wxCANCEL |  wxCENTRE.

         @param pos
         @param pos

-        Dialog position. Not Windows.
+            Dialog position. Not Windows.

         
         @remarks Use ShowModal() to show the dialog.
     */
         
         @remarks Use ShowModal() to show the dialog.
     */


@@ -174,14 +206,14 @@ public:
                          const wxString& caption,
                          int n,
                          const wxString* choices,
                          const wxString& caption,
                          int n,
                          const wxString* choices,

-                         void** clientData = @NULL,
+                         void** clientData = NULL,

                          long style = wxCHOICEDLG_STYLE,
                          const wxPoint& pos = wxDefaultPosition);
     wxSingleChoiceDialog(wxWindow* parent,
                          const wxString& message,
                          const wxString& caption,
                          const wxArrayString& choices,
                          long style = wxCHOICEDLG_STYLE,
                          const wxPoint& pos = wxDefaultPosition);
     wxSingleChoiceDialog(wxWindow* parent,
                          const wxString& message,
                          const wxString& caption,
                          const wxArrayString& choices,

-                         void** clientData = @NULL,
+                         void** clientData = NULL,

                          long style = wxCHOICEDLG_STYLE,
                          const wxPoint& pos = wxDefaultPosition);
     //@}
                          long style = wxCHOICEDLG_STYLE,
                          const wxPoint& pos = wxDefaultPosition);
     //@}


@@ -189,22 +221,22 @@ public:
     /**
         Returns the index of selected item.
     */
     /**
         Returns the index of selected item.
     */

-    int GetSelection();
+    int GetSelection() const;

 
     /**
         Returns the client data associated with the selection.
     */
 
     /**
         Returns the client data associated with the selection.
     */

-    char* GetSelectionClientData();
+    char* GetSelectionClientData() const;

 
     /**
         Returns the selected string.
     */
 
     /**
         Returns the selected string.
     */

-    wxString GetStringSelection();
+    wxString GetStringSelection() const;

 
     /**
         Sets the index of the initially selected item.
     */
 
     /**
         Sets the index of the initially selected item.
     */

-    void SetSelection(int selection);
+    void SetSelection(int selection) const;

 
     /**
         Shows the dialog, returning either wxID_OK or wxID_CANCEL.
 
     /**
         Shows the dialog, returning either wxID_OK or wxID_CANCEL.


@@ -213,6 +245,7 @@ public:
 };
 
 
 };
 
 

+

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 // ============================================================================
 // Global functions/macros
 // ============================================================================


@@ -225,22 +258,22 @@ public:
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            const wxArrayString& aChoices,
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            const wxArrayString& aChoices,

-                           wxWindow * parent = @NULL,
+                           wxWindow* parent = NULL,

                            int x = -1,
                            int y = -1,
                            int x = -1,
                            int y = -1,

-                           bool centre = @true,
-                           int width=150,
-                           int height=200);
+                           bool centre = true,
+                           int width = 150,
+                           int height = 200);

 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            int n,
                            const wxString& choices[],
 int wxGetSingleChoiceIndex(const wxString& message,
                            const wxString& caption,
                            int n,
                            const wxString& choices[],

-                           wxWindow * parent = @NULL,
+                           wxWindow* parent = NULL,

                            int x = -1,
                            int y = -1,
                            int x = -1,
                            int y = -1,

-                           bool centre = @true,
-                           int width=150,
-                           int height=200);
+                           bool centre = true,
+                           int width = 150,
+                           int height = 200);

 //@}
 
 //@{
 //@}
 
 //@{


@@ -248,35 +281,33 @@ int wxGetSingleChoiceIndex(const wxString& message,
     Pops up a dialog box containing a message, OK/Cancel buttons and a
     single-selection listbox. The user may choose an item and press OK to return a
     string or Cancel to return the empty string. Use
     Pops up a dialog box containing a message, OK/Cancel buttons and a
     single-selection listbox. The user may choose an item and press OK to return a
     string or Cancel to return the empty string. Use

-    wxGetSingleChoiceIndex if empty string is a
+    wxGetSingleChoiceIndex() if empty string is a

     valid choice and if you want to be able to detect pressing Cancel reliably.
     valid choice and if you want to be able to detect pressing Cancel reliably.

-

     You may pass the list of strings to choose from either using @e choices
     You may pass the list of strings to choose from either using @e choices

-    which is an array of @e n strings for the listbox or by using a single
-    @e aChoices parameter of type wxArrayString.
-
-    If @e centre is @true, the message text (which may include new line
+    which is an array of @a n strings for the listbox or by using a single
+    @a aChoices parameter of type wxArrayString.
+    If @a centre is @true, the message text (which may include new line

     characters) is centred; if @false, the message is left-justified.
 */
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            const wxArrayString& aChoices,
     characters) is centred; if @false, the message is left-justified.
 */
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            const wxArrayString& aChoices,

-                           wxWindow * parent = @NULL,
+                           wxWindow* parent = NULL,

                            int x = -1,
                            int y = -1,
                            int x = -1,
                            int y = -1,

-                           bool centre = @true,
-                           int width=150,
-                           int height=200);
+                           bool centre = true,
+                           int width = 150,
+                           int height = 200);

 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            int n,
                            const wxString& choices[],
 wxString wxGetSingleChoice(const wxString& message,
                            const wxString& caption,
                            int n,
                            const wxString& choices[],

-                           wxWindow * parent = @NULL,
+                           wxWindow* parent = NULL,

                            int x = -1,
                            int y = -1,
                            int x = -1,
                            int y = -1,

-                           bool centre = @true,
-                           int width=150,
-                           int height=200);
+                           bool centre = true,
+                           int width = 150,
+                           int height = 200);

 //@}
 
 //@{
 //@}
 
 //@{


@@ -290,23 +321,23 @@ wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
                                const wxArrayString& aChoices,
                                const wxString& client_data[],
                                const wxString& caption,
                                const wxArrayString& aChoices,
                                const wxString& client_data[],

-                               wxWindow * parent = @NULL,
+                               wxWindow* parent = NULL,

                                int x = -1,
                                int y = -1,
                                int x = -1,
                                int y = -1,

-                               bool centre = @true,
-                               int width=150,
-                               int height=200);
+                               bool centre = true,
+                               int width = 150,
+                               int height = 200);

 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
                                int n,
                                const wxString& choices[],
                                const wxString& client_data[],
 wxString wxGetSingleChoiceData(const wxString& message,
                                const wxString& caption,
                                int n,
                                const wxString& choices[],
                                const wxString& client_data[],

-                               wxWindow * parent = @NULL,
+                               wxWindow* parent = NULL,

                                int x = -1,
                                int y = -1,
                                int x = -1,
                                int y = -1,

-                               bool centre = @true,
-                               int width=150,
-                               int height=200);
+                               bool centre = true,
+                               int width = 150,
+                               int height = 200);

 //@}
 
 //@{
 //@}
 
 //@{


@@ -316,34 +347,32 @@ wxString wxGetSingleChoiceData(const wxString& message,
     number of items in the listbox whose indices will be returned in
     @e selection array. The initial contents of this array will be used to
     select the items when the dialog is shown.
     number of items in the listbox whose indices will be returned in
     @e selection array. The initial contents of this array will be used to
     select the items when the dialog is shown.

-

     You may pass the list of strings to choose from either using @e choices
     You may pass the list of strings to choose from either using @e choices

-    which is an array of @e n strings for the listbox or by using a single
-    @e aChoices parameter of type wxArrayString.
-
-    If @e centre is @true, the message text (which may include new line
+    which is an array of @a n strings for the listbox or by using a single
+    @a aChoices parameter of type wxArrayString.
+    If @a centre is @true, the message text (which may include new line

     characters) is centred; if @false, the message is left-justified.
 */
 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,
     characters) is centred; if @false, the message is left-justified.
 */
 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,
                             const wxArrayString& aChoices,

-                            wxWindow * parent = @NULL,
+                            wxWindow* parent = NULL,

                             int x = -1,
                             int y = -1,
                             int x = -1,
                             int y = -1,

-                            bool centre = @true,
-                            int width=150,
-                            int height=200);
+                            bool centre = true,
+                            int width = 150,
+                            int height = 200);

 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,
                             int n,
                             const wxString& choices[],
 size_t wxGetMultipleChoices(wxArrayInt& selections,
                             const wxString& message,
                             const wxString& caption,
                             int n,
                             const wxString& choices[],

-                            wxWindow * parent = @NULL,
+                            wxWindow* parent = NULL,

                             int x = -1,
                             int y = -1,
                             int x = -1,
                             int y = -1,

-                            bool centre = @true,
-                            int width=150,
-                            int height=200);
+                            bool centre = true,
+                            int width = 150,
+                            int height = 200);

 //@}
 
 //@}