]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/dialog.tex
Previosly removed BuildWhereStmt really did exist, but as BuildWhereClause - not...
[wxWidgets.git] / docs / latex / wx / dialog.tex
index 2c856f35bcc2aae7cb88011d26b89301c365f018..2b88b05145a2be591e866cddfeb2c9bcf228738c 100644 (file)
@@ -6,6 +6,7 @@ is usually used to allow the user to make some choice or to answer a question.
 
 \wxheading{Derived from}
 
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -19,14 +20,15 @@ is usually used to allow the user to make some choice or to answer a question.
 There are two kinds of dialog -- {\it modal}\ and {\it modeless}. A modal dialog
 blocks program flow and user input on other windows until it is dismissed,
 whereas a modeless dialog behaves more like a frame in that program flow
-continues, and input on other windows is still possible. To show a modal dialog
-you should use \helpref{ShowModal}{wxdialogshowmodal} method while to show
-dialog modelessly you simply use \helpref{Show}{wxdialogshow}, just as with the
+continues, and input in other windows is still possible. To show a modal dialog
+you should use the \helpref{ShowModal}{wxdialogshowmodal} method while to show
+a dialog modelessly you simply use \helpref{Show}{wxdialogshow}, just as with
 frames.
 
-Note that the modal dialogs are one of the very few examples of
+Note that the modal dialog is one of the very few examples of
 wxWindow-derived objects which may be created on the stack and not on the heap.
-In other words, although this code snippet
+In other words, although this code snippet:
+
 \begin{verbatim}
     void AskUser()
     {
@@ -38,8 +40,10 @@ In other words, although this code snippet
         dlg->Destroy();
     }
 \end{verbatim}
+
 works, you can also achieve the same result by using a simpler code fragment
 below:
+
 \begin{verbatim}
     void AskUser()
     {
@@ -51,7 +55,7 @@ below:
     }
 \end{verbatim}
 
-An application can define an \helpref{wxCloseEvent}{wxcloseevent} handler for
+An application can define a \helpref{wxCloseEvent}{wxcloseevent} handler for
 the dialog to respond to system close events.
 
 \wxheading{Window styles}
@@ -63,17 +67,18 @@ the dialog to respond to system close events.
 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Display a resizeable frame around the window.}
 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Display a system menu.}
 \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.}
+\twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the dialog.}
+\twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the dialog.}
 \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 created
-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\_NO\_PARENT}}{By default, a dialog created
+with a {\tt NULL} parent window will be given the 
+\helpref{application's top level window}{wxappgettopwindow} as parent. Use this
+style to prevent this from happening and create an orphan dialog. 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
+caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets 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}
@@ -91,7 +96,7 @@ See also \helpref{Generic window styles}{windowstyles}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxDialog::wxDialog}\label{wxdialogconstr}
+\membersection{wxDialog::wxDialog}\label{wxdialogctor}
 
 \func{}{wxDialog}{\void}
 
@@ -115,10 +120,10 @@ Constructor.
 \docparam{title}{The title of the dialog.}
 
 \docparam{pos}{The dialog position. A value of (-1, -1) indicates a default position, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{size}{The dialog size. A value of (-1, -1) indicates a default size, chosen by
-either the windowing system or wxWindows, depending on platform.}
+either the windowing system or wxWidgets, depending on platform.}
 
 \docparam{style}{The window style. See \helpref{wxDialog}{wxdialog}.}
 
@@ -130,7 +135,7 @@ individual dialog boxes.}
 
 \helpref{wxDialog::Create}{wxdialogcreate}
 
-\membersection{wxDialog::\destruct{wxDialog}}
+\membersection{wxDialog::\destruct{wxDialog}}\label{wxdialogdtor}
 
 \func{}{\destruct{wxDialog}}{\void}
 
@@ -155,7 +160,7 @@ Centres the dialog box on the display.
 \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
+Used for two-step dialog box construction. See \helpref{wxDialog::wxDialog}{wxdialogctor}\rtfsp
 for details.
 
 \membersection{wxDialog::EndModal}\label{wxdialogendmodal}
@@ -231,20 +236,6 @@ Always returns false under Windows since dialogs cannot be iconized.
 
 Returns true if the dialog box is modal, false otherwise.
 
-\membersection{wxDialog::OnCharHook}\label{wxdialogoncharhook}
-
-\func{void}{OnCharHook}{\param{wxKeyEvent\&}{ event}}
-
-This member is called to allow the window to intercept keyboard events
-before they are processed by child windows.
-
-%For more information, see \helpref{wxWindow::OnCharHook}{wxwindowoncharhook}
-
-\wxheading{Remarks}
-
-wxDialog implements this handler to fake a cancel command if the escape key has been
-pressed. This will dismiss the dialog.
-
 \membersection{wxDialog::OnApply}\label{wxdialogonapply}
 
 \func{void}{OnApply}{\param{wxCommandEvent\& }{event}}