Doc tweaks

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

diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex
index b8a30107b08a5a0aee86b5340d9ff5a0cd333444..b3b7d56918ea29d197fd3d1fdb479fb02c25fe67 100644 (file)
--- a/docs/latex/wx/dialog.tex
+++ b/docs/latex/wx/dialog.tex
@@ -10,6 +10,10 @@ the screen. It can contain controls and other windows.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/dialog.h>
+

 \wxheading{Remarks}
 
 There are two kinds of dialog - {\it modal} and {\it modeless}. A modal dialog
 \wxheading{Remarks}
 
 There are two kinds of dialog - {\it modal} and {\it modeless}. A modal dialog


@@ -29,14 +33,16 @@ dialog to respond to system close events.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the dialog box (Motif only).}
 \twocolitem{\windowstyle{wxDEFAULT\_DIALOG\_STYLE}}{Equivalent to a combination of wxCAPTION, wxSYSTEM\_MENU and wxTHICK\_FRAME}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the dialog box (Motif only).}
 \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 (Motif only).}
-\twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Display a system menu (Motif only).}
-\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Display a thick frame around the window (Motif only).}
+\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Display a resizeable frame around the window (Unix only).}
+\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.}
 \end{twocollist}
 
 \twocolitem{\windowstyle{wxNO\_3D}}{Under Windows, specifies that the child controls
 should not have 3D borders unless specified in the control.}
 \end{twocollist}
 

-Under Motif, MWM (the Motif Window Manager) 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}.
 
 
 See also \helpref{Generic window styles}{windowstyles}.
 


@@ -53,11 +59,11 @@ See also \helpref{Generic window styles}{windowstyles}.
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxDialog}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{}{wxDialog}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxString\& }{title},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxString\& }{title},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{const long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp
+\param{long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp

 \param{const wxString\& }{name = ``dialogBox"}}
 
 Constructor.
 \param{const wxString\& }{name = ``dialogBox"}}
 
 Constructor.


@@ -94,7 +100,7 @@ Destructor. Deletes any child windows before deleting the physical window.
 
 \membersection{wxDialog::Centre}\label{wxdialogcentre}
 
 
 \membersection{wxDialog::Centre}\label{wxdialogcentre}
 

-\func{void}{Centre}{\param{const int}{ direction = wxBOTH}}
+\func{void}{Centre}{\param{int}{ direction = wxBOTH}}

 
 Centres the dialog box on the display.
 
 
 Centres the dialog box on the display.
 


@@ -104,11 +110,11 @@ Centres the dialog box on the display.
 
 \membersection{wxDialog::Create}\label{wxdialogcreate}
 
 
 \membersection{wxDialog::Create}\label{wxdialogcreate}
 

-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxString\& }{title},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxString\& }{title},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{const long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp
+\param{long}{ style = wxDEFAULT\_DIALOG\_STYLE},\rtfsp

 \param{const wxString\& }{name = ``dialogBox"}}
 
 Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogconstr}\rtfsp
 \param{const wxString\& }{name = ``dialogBox"}}
 
 Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogconstr}\rtfsp


@@ -128,8 +134,24 @@ invocation.
 \wxheading{See also}
 
 \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp
 \wxheading{See also}
 
 \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp

-\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode},\rtfsp
-\helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}
+\helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode},\rtfsp
+\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}
+
+\membersection{wxDialog::GetReturnCode}\label{wxdialoggetreturncode}
+
+\func{int}{GetReturnCode}{\void}
+
+Gets the return code for this window.
+
+\wxheading{Remarks}
+
+A return code is normally associated with a modal dialog, where \helpref{wxDialog::ShowModal}{wxdialogshowmodal} returns
+a code to the application.
+
+\wxheading{See also}
+
+\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp
+\helpref{wxDialog::EndModal}{wxdialogendmodal}

 
 \membersection{wxDialog::GetTitle}\label{wxdialoggettitle}
 
 
 \membersection{wxDialog::GetTitle}\label{wxdialoggettitle}
 


@@ -141,7 +163,7 @@ Returns the title of the dialog box.
 
 \func{void}{Iconize}{\param{const bool}{ iconize}}
 
 
 \func{void}{Iconize}{\param{const bool}{ iconize}}
 

-Iconizes or restores the dialog.
+Iconizes or restores the dialog. Windows only.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -159,7 +181,7 @@ calling {\tt Iconize(FALSE)} will bring the window to the front, as does
 
 \constfunc{bool}{IsIconized}{\void}
 
 
 \constfunc{bool}{IsIconized}{\void}
 

-Returns TRUE if the dialog box is iconized.
+Returns TRUE if the dialog box is iconized. Windows only.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -264,6 +286,26 @@ until the dialog is hidden) or modeless (control returns immediately).
 
 \docparam{flag}{If TRUE, the dialog will be modal, otherwise it will be modeless.}
 
 
 \docparam{flag}{If TRUE, the dialog will be modal, otherwise it will be modeless.}
 

+\membersection{wxDialog::SetReturnCode}\label{wxdialogsetreturncode}
+
+\func{void}{SetReturnCode}{\param{int }{retCode}}
+
+Sets the return code for this window.
+
+\wxheading{Parameters}
+
+\docparam{retCode}{The integer return code, usually a control identifier.}
+
+\wxheading{Remarks}
+
+A return code is normally associated with a modal dialog, where \helpref{wxDialog::ShowModal}{wxdialogshowmodal} returns
+a code to the application. The function \helpref{wxDialog::EndModal}{wxdialogendmodal} calls {\bf SetReturnCode}.
+
+\wxheading{See also}
+
+\helpref{wxDialog::GetReturnCode}{wxdialoggetreturncode}, \helpref{wxDialog::ShowModal}{wxdialogshowmodal},\rtfsp
+\helpref{wxDialog::EndModal}{wxdialogendmodal}
+

 \membersection{wxDialog::SetTitle}\label{wxdialogsettitle}
 
 \func{void}{SetTitle}{\param{const wxString\& }{ title}}
 \membersection{wxDialog::SetTitle}\label{wxdialogsettitle}
 
 \func{void}{SetTitle}{\param{const wxString\& }{ title}}


@@ -299,12 +341,11 @@ Shows a modal dialog. Program flow does not return until the dialog has been dis
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-The return value is the value set with \helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}.
+The return value is the value set with \helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}.

 
 \wxheading{See also}
 
 \helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp
 
 \wxheading{See also}
 
 \helpref{wxDialog::EndModal}{wxdialogendmodal},\rtfsp

-\helpref{wxWindow::GetReturnCode}{wxwindowgetreturncode},\rtfsp
-\helpref{wxWindow::SetReturnCode}{wxwindowsetreturncode}
-
+\helpref{wxDialog:GetReturnCode}{wxdialoggetreturncode},\rtfsp
+\helpref{wxDialog::SetReturnCode}{wxdialogsetreturncode}