/////////////////////////////////////////////////////////////////////////////
// Name: choicdlg.h
-// Purpose: documentation for wxMultiChoiceDialog class
+// Purpose: interface of wxMultiChoiceDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxbase}
@category{cmndlg}
- @seealso
- @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
+ @see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
wxSingleChoiceDialog
*/
class wxMultiChoiceDialog : public wxDialog
/**
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.
};
+
/**
@class wxSingleChoiceDialog
@wxheader{choicdlg.h}
@library{wxbase}
@category{cmndlg}
- @seealso
- @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog overview",
- wxMultiChoiceDialog
+ @see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog
+ overview", wxMultiChoiceDialog
*/
class wxSingleChoiceDialog : public wxDialog
{
/**
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.
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
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