]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/choicdlg.h
replace @seealso with @see; as Vaclav pointed out we shouldn't use custom aliases...
[wxWidgets.git] / interface / choicdlg.h
index 44de9f59eaf0d77fcdd69df1507dd2d47480e1b0..969b77c2d8cd367ffa7a8eb3a44c6042b7f3d2bd 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        choicdlg.h
-// Purpose:     documentation for wxMultiChoiceDialog class
+// Purpose:     interface of wxMultiChoiceDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -16,8 +16,7 @@
     @library{wxbase}
     @category{cmndlg}
 
-    @seealso
-    @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
+    @see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
     wxSingleChoiceDialog
 */
 class wxMultiChoiceDialog : public wxDialog
@@ -104,12 +103,12 @@ public:
     /**
         Returns array with indexes of selected items.
     */
-    wxArrayInt GetSelection();
+    wxArrayInt GetSelection() const;
 
     /**
         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.
@@ -118,6 +117,7 @@ public:
 };
 
 
+
 /**
     @class wxSingleChoiceDialog
     @wxheader{choicdlg.h}
@@ -129,9 +129,8 @@ public:
     @library{wxbase}
     @category{cmndlg}
 
-    @seealso
-    @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog overview",
-    wxMultiChoiceDialog
+    @see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog
+    overview", wxMultiChoiceDialog
 */
 class wxSingleChoiceDialog : public wxDialog
 {
@@ -222,22 +221,22 @@ public:
     /**
         Returns the index of selected item.
     */
-    int GetSelection();
+    int GetSelection() const;
 
     /**
         Returns the client data associated with the selection.
     */
-    char* GetSelectionClientData();
+    char* GetSelectionClientData() const;
 
     /**
         Returns the selected string.
     */
-    wxString GetStringSelection();
+    wxString GetStringSelection() const;
 
     /**
         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.
@@ -246,6 +245,7 @@ public:
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
@@ -281,7 +281,7 @@ 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
-    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.
     You may pass the list of strings to choose from either using @e choices
     which is an array of @a n strings for the listbox or by using a single