Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finished review of Dialogs category of functions and macros as well as choicdlg.h (assigned to myself).

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52618 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-18 19:30:01 +00:00
parent 0c2d0fcf98
commit ba2874ff30
11 changed files with 385 additions and 328 deletions
Download Patch File Download Diff File Expand all files Collapse all files

191
interface/choicdlg.h
View File

@@ -1,6 +1,6 @@
/////////////////////////////////////////////////////////////////////////////
// Name: choicdlg.h
// Purpose: interface of wxMultiChoiceDialog
// Purpose: interface of wx[Multi|Single]ChoiceDialog
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@@ -16,8 +16,7 @@
@library{wxbase}
@category{cmndlg}
@see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview",
wxSingleChoiceDialog
@see @ref overview_cmndlg_multichoice, wxSingleChoiceDialog
*/
class wxMultiChoiceDialog : public wxDialog
{
@@ -25,7 +24,7 @@ public:
//@{
/**
Constructor taking an array of wxString choices.
@param parent
Parent window.
@param message
@@ -38,52 +37,21 @@ public:
An array of strings, or a string list, containing the choices.
@param style
A dialog style (bitlist) containing flags chosen from standard
dialog styles and the following:
wxOK
Show an OK button.
wxCANCEL
Show a Cancel button.
wxCENTRE
Centre the message. Not Windows.
The default value is equivalent to wxDEFAULT_DIALOG_STYLE |
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
dialog style and the ones listed below. The default value is
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
wxCANCEL | wxCENTRE.
@param pos
Dialog position. Not Windows.
@beginStyleTable
@style{wxOK}:
Show an OK button.
@style{wxCANCEL}:
Show a Cancel button.
@style{wxCENTRE}:
Centre the message. Not Windows.
@endStyleTable
@remarks Use ShowModal() to show the dialog.
*/
wxMultiChoiceDialog(wxWindow* parent, const wxString& message,
@@ -122,23 +90,23 @@ public:
@class wxSingleChoiceDialog
@wxheader{choicdlg.h}
This class represents a dialog that shows a list of strings, and allows the
user to select one. Double-clicking on a list item is equivalent to
This class represents a dialog that shows a list of strings, and allows
the user to select one. Double-clicking on a list item is equivalent to
single-clicking and then pressing OK.
@library{wxbase}
@category{cmndlg}
@see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog
overview", wxMultiChoiceDialog
@see @ref overview_cmndlg_singlechoice, wxMultiChoiceDialog
*/
class wxSingleChoiceDialog : public wxDialog
{
public:
//@{
/**
Constructor, taking an array of wxString choices and optional client data.
Constructor, taking an array of wxString choices and optional client
data.
@param parent
Parent window.
@param message
@@ -154,52 +122,21 @@ public:
See GetSelectionClientData.
@param style
A dialog style (bitlist) containing flags chosen from standard
dialog styles and the following:
wxOK
Show an OK button.
wxCANCEL
Show a Cancel button.
wxCENTRE
Centre the message. Not Windows.
The default value is equivalent to wxDEFAULT_DIALOG_STYLE |
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
dialog styles and the ones listed below. The default value is
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
wxCANCEL | wxCENTRE.
@param pos
Dialog position. Not Windows.
@beginStyleTable
@style{wxOK}:
Show an OK button.
@style{wxCANCEL}:
Show a Cancel button.
@style{wxCENTRE}:
Centre the message. Not Windows.
@endStyleTable
@remarks Use ShowModal() to show the dialog.
*/
wxSingleChoiceDialog(wxWindow* parent, const wxString& message,
@@ -250,10 +187,14 @@ public:
// Global functions/macros
// ============================================================================
/** @ingroup group_funcmacro_dialog */
//@{
/**
As @b wxGetSingleChoice but returns the index representing the selected
string. If the user pressed cancel, -1 is returned.
Same as wxGetSingleChoice() but returns the index representing the
selected string. If the user pressed cancel, -1 is returned.
@header{wx/choicdlg.h}
*/
int wxGetSingleChoiceIndex(const wxString& message,
const wxString& caption,
@@ -274,20 +215,27 @@ int wxGetSingleChoiceIndex(const wxString& message,
bool centre = true,
int width = 150,
int height = 200);
//@}
/** @ingroup group_funcmacro_dialog */
//@{
/**
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
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
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 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 @c choices
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
@c aChoices parameter of type wxArrayString.
If @c centre is @true, the message text (which may include new line
characters) is centred; if @false, the message is left-justified.
@header{wx/choicdlg.h}
*/
wxString wxGetSingleChoice(const wxString& message,
const wxString& caption,
@@ -308,14 +256,19 @@ wxString wxGetSingleChoice(const wxString& message,
bool centre = true,
int width = 150,
int height = 200);
//@}
/** @ingroup group_funcmacro_dialog */
//@{
/**
As @b wxGetSingleChoice but takes an array of client data pointers
corresponding to the strings, and returns one of these pointers or @NULL if
Cancel was pressed. The @e client_data array must have the same number of
elements as @e choices or @e aChoices!
Same as wxGetSingleChoice but takes an array of client data pointers
corresponding to the strings, and returns one of these pointers or @NULL
if Cancel was pressed. The @c client_data array must have the same number
of elements as @c choices or @c aChoices!
@header{wx/choicdlg.h}
*/
wxString wxGetSingleChoiceData(const wxString& message,
const wxString& caption,
@@ -338,20 +291,27 @@ wxString wxGetSingleChoiceData(const wxString& message,
bool centre = true,
int width = 150,
int height = 200);
//@}
/** @ingroup group_funcmacro_dialog */
//@{
/**
Pops up a dialog box containing a message, OK/Cancel buttons and a
multiple-selection listbox. The user may choose an arbitrary (including 0)
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
@c selections 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 @c choices
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
@c aChoices parameter of type wxArrayString.
If @c centre is @true, the message text (which may include new line
characters) is centred; if @false, the message is left-justified.
@header{wx/choicdlg.h}
*/
size_t wxGetMultipleChoices(wxArrayInt& selections,
const wxString& message,
@@ -374,5 +334,6 @@ size_t wxGetMultipleChoices(wxArrayInt& selections,
bool centre = true,
int width = 150,
int height = 200);
//@}