X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/880efa2a137ce3e3f39236d0dc85f5d2dacdda12..4e15d1caa03346c126015019c1fdf093033ef40b:/docs/doxygen/overviews/commondialogs.h diff --git a/docs/doxygen/overviews/commondialogs.h b/docs/doxygen/overviews/commondialogs.h index 4f4f35d47e..b956bafd15 100644 --- a/docs/doxygen/overviews/commondialogs.h +++ b/docs/doxygen/overviews/commondialogs.h @@ -3,25 +3,14 @@ // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @page overview_cmndlg Common Dialogs -Classes: - -@li wxColourDialog -@li wxFontDialog -@li wxPrintDialog -@li wxFileDialog -@li wxDirDialog -@li wxTextEntryDialog -@li wxPasswordEntryDialog -@li wxMessageDialog -@li wxSingleChoiceDialog -@li wxMultiChoiceDialog +@tableofcontents Common dialog classes and functions encapsulate commonly-needed dialog box requirements. They are all 'modal', grabbing the flow of control until the user @@ -36,19 +25,8 @@ and a macro defines wxColourDialog to be the same as wxGenericColourDialog on non-MS Windows platforms. However, under MS Windows, the generic dialog can also be used, for testing or other purposes. -@li @ref overview_cmndlg_colour -@li @ref overview_cmndlg_font -@li @ref overview_cmndlg_print -@li @ref overview_cmndlg_file -@li @ref overview_cmndlg_dir -@li @ref overview_cmndlg_textentry -@li @ref overview_cmndlg_password -@li @ref overview_cmndlg_msg -@li @ref overview_cmndlg_singlechoice -@li @ref overview_cmndlg_multichoice - +@see @ref group_class_cmndlg -
@section overview_cmndlg_colour wxColourDialog Overview @@ -109,6 +87,7 @@ if (dialog.ShowModal() == wxID_OK) @endcode + @section overview_cmndlg_font wxFontDialog Overview Classes: wxFontDialog, wxFontData @@ -155,6 +134,7 @@ if (dialog.ShowModal() == wxID_OK) @endcode + @section overview_cmndlg_print wxPrintDialog Overview Classes: wxPrintDialog, wxPrintData @@ -166,6 +146,7 @@ The samples/printing example shows how to use it: see @ref overview_printing for an excerpt from this example. + @section overview_cmndlg_file wxFileDialog Overview Classes: wxFileDialog @@ -197,6 +178,7 @@ description for each, such as: @endverbatim + @section overview_cmndlg_dir wxDirDialog Overview Classes: wxDirDialog @@ -205,6 +187,7 @@ This dialog shows a directory selector dialog, allowing the user to select a single directory. + @section overview_cmndlg_textentry wxTextEntryDialog Overview Classes: wxTextEntryDialog @@ -213,6 +196,7 @@ This is a dialog with a text entry field. The value that the user entered is obtained using wxTextEntryDialog::GetValue(). + @section overview_cmndlg_password wxPasswordEntryDialog Overview Classes: wxPasswordEntryDialog @@ -221,6 +205,7 @@ This is a dialog with a password entry field. The value that the user entered is obtained using wxTextEntryDialog::GetValue(). + @section overview_cmndlg_msg wxMessageDialog Overview Classes: wxMessageDialog @@ -233,6 +218,7 @@ The return value of wxMessageDialog::ShowModal() indicates which button the user pressed. + @section overview_cmndlg_singlechoice wxSingleChoiceDialog Overview Classes: wxSingleChoiceDialog @@ -242,6 +228,7 @@ can select one of them. The selection can be obtained from the dialog as an index, a string or client data. + @section overview_cmndlg_multichoice wxMultiChoiceDialog Overview Classes: wxMultiChoiceDialog @@ -250,4 +237,3 @@ This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can select one or more of them. */ -