Document wx{Single,Multi}ChoiceDialog styles in class documentation.
The styles should be documented in the class documentation, not the documentation of individual constructors. Closes #14162. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@71068 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -30,6 +30,15 @@
|
|||||||
This class represents a dialog that shows a list of strings, and allows the
|
This class represents a dialog that shows a list of strings, and allows the
|
||||||
user to select one or more.
|
user to select one or more.
|
||||||
|
|
||||||
|
@beginStyleTable
|
||||||
|
@style{wxOK}
|
||||||
|
Show an OK button.
|
||||||
|
@style{wxCANCEL}
|
||||||
|
Show a Cancel button.
|
||||||
|
@style{wxCENTRE}
|
||||||
|
Centre the message. Not Windows.
|
||||||
|
@endStyleTable
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{cmndlg}
|
@category{cmndlg}
|
||||||
|
|
||||||
@@ -54,21 +63,12 @@ public:
|
|||||||
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
|
A dialog style (bitlist) containing flags chosen from standard
|
||||||
dialog style and the ones listed below. The default value is
|
dialog styles and the ones listed in the class documentation. The
|
||||||
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
|
default value is equivalent to wxDEFAULT_DIALOG_STYLE |
|
||||||
wxCANCEL | wxCENTRE.
|
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
|
||||||
@param pos
|
@param pos
|
||||||
Dialog position. Not Windows.
|
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.
|
@remarks Use ShowModal() to show the dialog.
|
||||||
|
|
||||||
@beginWxPythonOnly
|
@beginWxPythonOnly
|
||||||
@@ -101,21 +101,12 @@ public:
|
|||||||
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
|
A dialog style (bitlist) containing flags chosen from standard
|
||||||
dialog style and the ones listed below. The default value is
|
dialog styles and the ones listed in the class documentation. The
|
||||||
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
|
default value is equivalent to wxDEFAULT_DIALOG_STYLE |
|
||||||
wxCANCEL | wxCENTRE.
|
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
|
||||||
@param pos
|
@param pos
|
||||||
Dialog position. Not Windows.
|
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.
|
@remarks Use ShowModal() to show the dialog.
|
||||||
|
|
||||||
@beginWxPythonOnly
|
@beginWxPythonOnly
|
||||||
@@ -163,6 +154,15 @@ public:
|
|||||||
user to select one. Double-clicking on a list item is equivalent to
|
user to select one. Double-clicking on a list item is equivalent to
|
||||||
single-clicking and then pressing OK.
|
single-clicking and then pressing OK.
|
||||||
|
|
||||||
|
@beginStyleTable
|
||||||
|
@style{wxOK}
|
||||||
|
Show an OK button.
|
||||||
|
@style{wxCANCEL}
|
||||||
|
Show a Cancel button.
|
||||||
|
@style{wxCENTRE}
|
||||||
|
Centre the message. Not Windows.
|
||||||
|
@endStyleTable
|
||||||
|
|
||||||
@library{wxbase}
|
@library{wxbase}
|
||||||
@category{cmndlg}
|
@category{cmndlg}
|
||||||
|
|
||||||
@@ -191,21 +191,12 @@ public:
|
|||||||
GetSelectionData().
|
GetSelectionData().
|
||||||
@param style
|
@param style
|
||||||
A dialog style (bitlist) containing flags chosen from standard
|
A dialog style (bitlist) containing flags chosen from standard
|
||||||
dialog styles and the ones listed below. The default value is
|
dialog styles and the ones listed in the class documentation. The
|
||||||
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
|
default value is equivalent to wxDEFAULT_DIALOG_STYLE |
|
||||||
wxCANCEL | wxCENTRE.
|
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
|
||||||
@param pos
|
@param pos
|
||||||
Dialog position. Not Windows.
|
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.
|
@remarks Use ShowModal() to show the dialog.
|
||||||
|
|
||||||
@beginWxPythonOnly
|
@beginWxPythonOnly
|
||||||
@@ -243,21 +234,12 @@ public:
|
|||||||
GetSelectionData().
|
GetSelectionData().
|
||||||
@param style
|
@param style
|
||||||
A dialog style (bitlist) containing flags chosen from standard
|
A dialog style (bitlist) containing flags chosen from standard
|
||||||
dialog styles and the ones listed below. The default value is
|
dialog styles and the ones listed in the class documentation. The
|
||||||
equivalent to wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxOK |
|
default value is equivalent to wxDEFAULT_DIALOG_STYLE |
|
||||||
wxCANCEL | wxCENTRE.
|
wxRESIZE_BORDER | wxOK | wxCANCEL | wxCENTRE.
|
||||||
@param pos
|
@param pos
|
||||||
Dialog position. Not Windows.
|
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.
|
@remarks Use ShowModal() to show the dialog.
|
||||||
|
|
||||||
@beginWxPythonOnly
|
@beginWxPythonOnly
|
||||||
|
Reference in New Issue
Block a user