GetCurrentSelection() was documented but not present in all ports (just MSW and GTK...

[wxWidgets.git] / docs / latex / wx / tcommdlg.tex

diff --git a/docs/latex/wx/tcommdlg.tex b/docs/latex/wx/tcommdlg.tex
index 6f6fc688dad2fabc2a5db805bc862cdb0e2e7be8..0e83a9f4b66b0155730760f14c4ba5e78f0f99fa 100644 (file)
--- a/docs/latex/wx/tcommdlg.tex
+++ b/docs/latex/wx/tcommdlg.tex
@@ -3,15 +3,16 @@
 Classes: \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxFontDialog}{wxfontdialog},
 \rtfsp\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxFileDialog}{wxfiledialog},\rtfsp
 \helpref{wxDirDialog}{wxdirdialog}, \helpref{wxTextEntryDialog}{wxtextentrydialog},\rtfsp
 Classes: \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxFontDialog}{wxfontdialog},
 \rtfsp\helpref{wxPrintDialog}{wxprintdialog}, \helpref{wxFileDialog}{wxfiledialog},\rtfsp
 \helpref{wxDirDialog}{wxdirdialog}, \helpref{wxTextEntryDialog}{wxtextentrydialog},\rtfsp

+\helpref{wxPasswordEntryDialog}{wxpasswordentrydialog},\rtfsp

 \helpref{wxMessageDialog}{wxmessagedialog}, \helpref{wxSingleChoiceDialog}{wxsinglechoicedialog},\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,
 to make them easy to use within an application.
 
 Some dialogs have both platform-dependent and platform-independent implementations,
 
 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,
 to make them easy to use within an application.
 
 Some dialogs have both platform-dependent and platform-independent implementations,

-so that if underlying windowing systems that do not provide the required functionality,
+so that if underlying windowing systems do not provide the required functionality,

 the generic classes and functions can stand in. For example, under MS Windows, wxColourDialog
 uses the standard colour selector. There is also an equivalent called wxGenericColourDialog
 for other platforms, and a macro defines wxColourDialog to be the same as wxGenericColourDialog
 the generic classes and functions can stand in. For example, under MS Windows, wxColourDialog
 uses the standard colour selector. There is also an equivalent called wxGenericColourDialog
 for other platforms, and a macro defines wxColourDialog to be the same as wxGenericColourDialog


@@ -55,11 +56,11 @@ the wxColourDialog class. Here is an excerpt, which
 sets various parameters of a wxColourData object, including
 a grey scale for the custom colours. If the user did not cancel
 the dialog, the application retrieves the selected colour and
 sets various parameters of a wxColourData object, including
 a grey scale for the custom colours. If the user did not cancel
 the dialog, the application retrieves the selected colour and

-uses it to set the background of a canvas.
+uses it to set the background of a window.

 
 \begin{verbatim}
   wxColourData data;
 
 \begin{verbatim}
   wxColourData data;

-  data.SetChooseFull(TRUE);
+  data.SetChooseFull(true);

   for (int i = 0; i < 16; i++)
   {
     wxColour colour(i*16, i*16, i*16);
   for (int i = 0; i < 16; i++)
   {
     wxColour colour(i*16, i*16, i*16);


@@ -72,9 +73,9 @@ uses it to set the background of a canvas.
     wxColourData retData = dialog.GetColourData();
     wxColour col = retData.GetColour();
     wxBrush brush(col, wxSOLID);
     wxColourData retData = dialog.GetColourData();
     wxColour col = retData.GetColour();
     wxBrush brush(col, wxSOLID);

-    myCanvas->SetBackground(brush);
-    myCanvas->Clear();
-    myCanvas->Refresh();
+    myWindow->SetBackground(brush);
+    myWindow->Clear();
+    myWindow->Refresh();

   }
 \end{verbatim}
 
   }
 \end{verbatim}
 


@@ -92,11 +93,10 @@ Under Windows, the native font selector common dialog is used. This
 presents a dialog box with controls for font name, point size, style, weight,
 underlining, strikeout and text foreground colour. A sample of the
 font is shown on a white area of the dialog box. Note that
 presents a dialog box with controls for font name, point size, style, weight,
 underlining, strikeout and text foreground colour. A sample of the
 font is shown on a white area of the dialog box. Note that

-in the translation from full MS Windows fonts to wxWindows font
+in the translation from full MS Windows fonts to wxWidgets font

 conventions, strikeout is ignored and a font family (such as
 Swiss or Modern) is deduced from the actual font name (such as Arial
 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}
 
 
 {\bf The generic font selector}
 


@@ -106,11 +106,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.
 
 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
 {\bf Example}
 
 In the samples/dialogs directory, there is an example of using


@@ -128,7 +123,7 @@ and colour for drawing text on a canvas. Here is an excerpt:
     wxFontData retData = dialog.GetFontData();
     canvasFont = retData.GetChosenFont();
     canvasTextColour = retData.GetColour();
     wxFontData retData = dialog.GetFontData();
     canvasFont = retData.GetChosenFont();
     canvasTextColour = retData.GetColour();

-    myCanvas->Refresh();
+    myWindow->Refresh();

   }
 \end{verbatim}
 
   }
 \end{verbatim}
 


@@ -147,15 +142,15 @@ an excerpt from this example.
 
 Classes: \helpref{wxFileDialog}{wxfiledialog}
 
 
 Classes: \helpref{wxFileDialog}{wxfiledialog}
 

-Pops up a file selector box. In Windows, this is the common file selector
-dialog. In X, this is a file selector box with somewhat less functionality.
-The path and filename are distinct elements of a full file pathname.
+Pops up a file selector box. In Windows and GTK2.4+, this is the common
+file selector dialog. In X, this is a file selector box with somewhat less
+functionality. The path and filename are distinct elements of a full file pathname.

 If path is ``", the current directory will be used. If filename is ``",
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,
 If path is ``", the current directory will be used. If filename is ``",
 no default filename will be supplied. The wildcard determines what files
 are displayed in the file selector, and file extension supplies a type
 extension for the required filename. Flags may be a combination of wxOPEN,

-wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, or 0. They are only significant
-at present in Windows.
+wxSAVE, wxOVERWRITE\_PROMPT, wxHIDE\_READONLY, wxFILE\_MUST\_EXIST,
+wxMULTIPLE, wxCHANGE\_DIR or 0.

 
 Both the X and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and
 
 Both the X and Windows versions implement a wildcard filter. Typing a
 filename containing wildcards (*, ?) in the filename text item, and


@@ -164,11 +159,11 @@ displayed. In the X version, supplying no default name will result in the
 wildcard filter being inserted in the filename text item; the filter is
 ignored if a default name is supplied.
 
 wildcard filter being inserted in the filename text item; the filter is
 ignored if a default name is supplied.
 

-Under Windows (only), the wildcard may be a specification for multiple
+The wildcard may be a specification for multiple

 types of file with a description for each, such as:
 
 \begin{verbatim}
 types of file with a description for each, such as:
 
 \begin{verbatim}

- "BMP files (*.bmp) | *.bmp | GIF files (*.gif) | *.gif"
+ "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"

 \end{verbatim}
 
 \subsection{wxDirDialog overview}\label{wxdirdialogoverview}
 \end{verbatim}
 
 \subsection{wxDirDialog overview}\label{wxdirdialogoverview}


@@ -185,6 +180,13 @@ Classes: \helpref{wxTextEntryDialog}{wxtextentrydialog}
 This is a dialog with a text entry field. The value that the user
 entered is obtained using \helpref{wxTextEntryDialog::GetValue}{wxtextentrydialoggetvalue}.
 
 This is a dialog with a text entry field. The value that the user
 entered is obtained using \helpref{wxTextEntryDialog::GetValue}{wxtextentrydialoggetvalue}.
 

+\subsection{wxPasswordEntryDialog overview}\label{wxpasswordentrydialogoverview}
+
+Classes: \helpref{wxPasswordEntryDialog}{wxpasswordentrydialog}
+
+This is a dialog with a password entry field. The value that the user
+entered is obtained using \helpref{wxTextEntryDialog::GetValue}{wxtextentrydialoggetvalue}.
+

 \subsection{wxMessageDialog overview}\label{wxmessagedialogoverview}
 
 Classes: \helpref{wxMessageDialog}{wxmessagedialog}
 \subsection{wxMessageDialog overview}\label{wxmessagedialogoverview}
 
 Classes: \helpref{wxMessageDialog}{wxmessagedialog}


@@ -203,10 +205,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.
 
 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
 
 This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can

-select one or more of them. TODO.
+select one or more of them.