changed wxCondition API to take a reference, not pointer, to wxMutex

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

diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex
index 67c3c68ad489c64d4f29c408ba9467bf4866a865..d1b7a17f098b1410064e8fb301fba3abbc93af83 100644 (file)
--- a/docs/latex/wx/dialog.tex
+++ b/docs/latex/wx/dialog.tex
@@ -22,7 +22,10 @@ like a frame in that program flow continues, and input on other windows is still
 You specify the type of dialog with the {\bf wxDIALOG\_MODAL} and {\bf wxDIALOG\_MODELESS} window
 styles.
 
-A dialog may be loaded from a wxWindows resource file (extension {\tt wxr}).
+A dialog may be loaded from a wxWindows resource file (extension {\tt wxr}), which may itself
+be created by Dialog Editor. For details,
+see \helpref{The wxWindows resource system}{resourceformats}, \helpref{wxWindows resource functions}{resourcefuncs} and
+the resource sample.
 
 An application can define an \helpref{OnCloseWindow}{wxwindowonclosewindow} handler for the
 dialog to respond to system close events.
@@ -31,18 +34,29 @@ dialog to respond to system close events.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the dialog box (Motif only).}
+\twocolitem{\windowstyle{wxDIALOG\_MODAL}}{Specifies that the dialog box will be modal.}
+\twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the dialog box.}
 \twocolitem{\windowstyle{wxDEFAULT\_DIALOG\_STYLE}}{Equivalent to a combination of wxCAPTION, wxSYSTEM\_MENU and wxTHICK\_FRAME}
-\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Display a resizeable frame around the window (Unix only).}
+\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Display a resizeable frame around the window.}
 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Display a system menu.}
 \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Display a thick frame around the window.}
 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{The dialog stays on top of all other windows (Windows only).}
 \twocolitem{\windowstyle{wxNO\_3D}}{Under Windows, specifies that the child controls
 should not have 3D borders unless specified in the control.}
+\twocolitem{\windowstyle{wxDIALOG\_NO\_PARENT}}{By default, the dialogs crated
+with {\tt NULL} parent window will be given the 
+\helpref{applications top level window}{wxappgettopwindow} as parent. Use this
+style to prevent this from happening and create a really orphan dialog (note
+that this is not recommended for modal dialogs).}
+\twocolitem{\windowstyle{wxDIALOG\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the
+caption. When pressed, Windows will go into a context-sensitive help mode and wxWindows will send
+a wxEVT\_HELP event if the user clicked on an application window. {\it Note} that this is an extended
+style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} before Create is called (two-step construction).}
 \end{twocollist}
 
-Under Unix or Linux, MWM (the Motif Window Manager) or other window managers reckognizing
-the MHM hints should be running for any of these styles to have an effect.
+Under Unix or Linux, MWM (the Motif Window Manager) or other window managers
+reckognizing the MHM hints should be running for any of these styles to have an
+effect.
 
 See also \helpref{Generic window styles}{windowstyles}.
 
@@ -275,10 +289,37 @@ propagate the notification to child windows and controls.
 
 \helpref{wxSysColourChangedEvent}{wxsyscolourchangedevent}
 
+\membersection{wxDialog::SetIcon}\label{wxdialogseticon}
+
+\func{void}{SetIcon}{\param{const wxIcon\& }{icon}}
+
+Sets the icon for this dialog.
+
+\wxheading{Parameters}
+
+\docparam{icon}{The icon to associate with this dialog.}
+
+See also \helpref{wxIcon}{wxicon}.
+
+\membersection{wxDialog::SetIcons}\label{wxdialogseticons}
+
+\func{void}{SetIcons}{\param{const wxIconBundle\& }{icons}}
+
+Sets the icons for this dialog.
+
+\wxheading{Parameters}
+
+\docparam{icons}{The icons to associate with this dialog.}
+
+See also \helpref{wxIconBundle}{wxiconbundle}.
+
 \membersection{wxDialog::SetModal}\label{wxdialogsetmodal}
 
 \func{void}{SetModal}{\param{const bool}{ flag}}
 
+{\bf NB:} This function is deprecated and doesn't work for all ports, just use 
+\helpref{ShowModal}{wxdialogshowmodal} to show a modal dialog instead.
+
 Allows the programmer to specify whether the dialog box is modal (wxDialog::Show blocks control
 until the dialog is hidden) or modeless (control returns immediately).
 
@@ -349,4 +390,3 @@ The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialo
 \helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
 \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
 
-