Some doc corrections

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25999 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2004-02-29 13:02:01 +00:00
parent ced5554416
commit 04bf08b7e2
5 changed files with 13 additions and 27 deletions

View File

@@ -63,13 +63,12 @@ in an application.
\twocolitem{\helpref{wxDirDialog}{wxdirdialog}}{Directory selector dialog}
\twocolitem{\helpref{wxFileDialog}{wxfiledialog}}{File selector dialog}
\twocolitem{\helpref{wxFindReplaceDialog}{wxfindreplacedialog}}{Text search/replace dialog}
\twocolitem{\helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}}{Dialog to get one or more selections from a list}
\twocolitem{\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}}{Dialog to get one or more selections from a list}
\twocolitem{\helpref{wxSingleChoiceDialog}{wxsinglechoicedialog}}{Dialog to get a single selection from a list and return the string}
\twocolitem{\helpref{wxTextEntryDialog}{wxtextentrydialog}}{Dialog to get a single line of text from the user}
\twocolitem{\helpref{wxFontDialog}{wxfontdialog}}{Font chooser dialog}
\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
\twocolitem{\helpref{wxPrintDialog}{wxprintdialog}}{Standard print dialog}
\twocolitem{\helpref{wxPageSetupDialog}{wxpagesetupdialog}}{Standard page setup dialog}
\twocolitem{\helpref{wxMessageDialog}{wxmessagedialog}}{Simple message box dialog}
\twocolitem{\helpref{wxWizard}{wxwizard}}{A wizard dialog.}
\end{twocollist}

View File

@@ -62,10 +62,7 @@ The default value is black.
\func{wxFont}{GetChosenFont}{\void}
Gets the font chosen by the user. If the user pressed OK (wxFontDialog::Show returned true), this returns
a new font which is now `owned' by the application, and should be deleted
if not required. If the user pressed Cancel (wxFontDialog::Show returned false) or
the colour dialog has not been invoked yet, this will return NULL.
Gets the font chosen by the user if the user pressed OK (wxFontDialog::ShowModal returned wxID\_OK).
\membersection{wxFontData::GetEnableEffects}

View File

@@ -1,10 +1,8 @@
\section{\class{wxMultipleChoiceDialog}}\label{wxmultiplechoicedialog}
\section{\class{wxMultiChoiceDialog}}\label{wxmultichoicedialog}
This class represents a dialog that shows a list of strings, and allows
the user to select one or more.
{\bf NOTE:} this class is not yet implemented.
\wxheading{Derived from}
\helpref{wxDialog}{wxdialog}\\
@@ -18,8 +16,7 @@ the user to select one or more.
\wxheading{See also}
\helpref{wxMultipleChoiceDialog overview}{wxmultiplechoicedialogoverview}
\helpref{wxMultiChoiceDialog overview}{wxmultichoicedialogoverview}
\latexignore{\rtfignore{\wxheading{Members}}}

View File

@@ -4,7 +4,7 @@ Classes: \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxFontDialog}{wxfont
\rtfsp\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxFileDialog}{wxfiledialog},\rtfsp
\helpref{wxDirDialog}{wxdirdialog}, \helpref{wxTextEntryDialog}{wxtextentrydialog},\rtfsp
\helpref{wxMessageDialog}{wxmessagedialog}, \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog},\rtfsp
\helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}
\helpref{wxMultiChoiceDialog}{wxmultichoicedialog}
Common dialog classes and functions encapsulate commonly-needed dialog box requirements.
They are all `modal', grabbing the flow of control until the user dismisses the dialog,
@@ -95,8 +95,7 @@ font is shown on a white area of the dialog box. Note that
in the translation from full MS Windows fonts to wxWindows font
conventions, strikeout is ignored and a font family (such as
Swiss or Modern) is deduced from the actual font name (such as Arial
or Courier). The full range of Windows fonts cannot be used in wxWindows
at present.
or Courier).
{\bf The generic font selector}
@@ -106,11 +105,6 @@ underlining and text foreground colour are provided, and
a sample is shown upon a white background. The generic font selector
is also available under MS Windows; use the name wxGenericFontDialog.
In both cases, the application is responsible for deleting the
new font returned from calling wxFontDialog::Show (if any).
This returned font is guaranteed to be a new object and not
one currently in use in the application.
{\bf Example}
In the samples/dialogs directory, there is an example of using
@@ -202,11 +196,10 @@ This dialog shows a list of choices, plus OK and (optionally) Cancel. The user c
select one of them. The selection can be obtained from the dialog as an index,
a string or client data.
\subsection{wxMultipleChoiceDialog overview}\label{wxmultiplechoicedialogoverview}
\subsection{wxMultiChoiceDialog overview}\label{wxmultichoicedialogoverview}
Classes: \helpref{wxMultipleChoiceDialog}{wxmultiplechoicedialog}
Classes: \helpref{wxMultiChoiceDialog}{wxmultichoicedialog}
This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can
select one or more of them.

View File

@@ -101,16 +101,16 @@ this:
\begin{verbatim}
void wxDialog::OnOK(wxCommandEvent& event)
{
if ( Validate() && TransferDataFromWindow() )
{
if ( Validate() && TransferDataFromWindow() )
{
if ( IsModal() )
EndModal(wxID_OK);
else
{
SetReturnCode(wxID_OK);
this->Show(false);
SetReturnCode(wxID_OK);
this->Show(false);
}
}
}
}
\end{verbatim}