From 0032ddbb32de472a9ed5e96879b1a23d70df023a Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Sun, 8 Feb 2004 12:45:37 +0000 Subject: [PATCH] Misc doc fixes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@25620 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/checkbox.tex | 2 +- docs/latex/wx/dialog.tex | 19 ++++++++++--------- docs/latex/wx/frame.tex | 3 +-- docs/latex/wx/gauge.tex | 4 ---- 4 files changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/latex/wx/checkbox.tex b/docs/latex/wx/checkbox.tex index 9026628a39..57147c8184 100644 --- a/docs/latex/wx/checkbox.tex +++ b/docs/latex/wx/checkbox.tex @@ -20,7 +20,7 @@ Often this is used as a "Does Not Apply" state. \twocolwidtha{7cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox (This is the default).} +\twocolitem{\windowstyle{wxCHK\_2STATE}}{Create a 2-state checkbox. This is the default.} \twocolitem{\windowstyle{wxCHK\_3STATE}}{Create a 3-state checkbox.} \twocolitem{\windowstyle{wxCHK\_ALLOW\_3RD\_STATE\_FOR\_USER}}{By default a user can't set a 3-state checkbox to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking. } diff --git a/docs/latex/wx/dialog.tex b/docs/latex/wx/dialog.tex index 2c856f35bc..c1b06e9285 100644 --- a/docs/latex/wx/dialog.tex +++ b/docs/latex/wx/dialog.tex @@ -19,12 +19,12 @@ 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 \begin{verbatim} @@ -63,15 +63,16 @@ 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 a wxEVT\_HELP event if the user clicked on an application window. {\it Note}\ that this is an extended diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index c42b8db335..63ce820394 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -35,7 +35,6 @@ application windows. \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of all other windows, see also wxFRAME\_FLOAT\_ON\_PARENT. Windows only.} \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu.} -\twocolitem{\windowstyle{wxSIMPLE\_BORDER}}{Displays no border or decorations. GTK and Windows only.} \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.} \twocolitem{\windowstyle{wxFRAME\_TOOL\_WINDOW}}{Causes a frame with a small titlebar to be created; the frame does not appear in the taskbar under Windows.} @@ -54,7 +53,7 @@ style and must be set by calling \helpref{SetExtraStyle}{wxwindowsetextrastyle} You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so you should use {\tt wxDEFAULT\_FRAME\_STYLE \& (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the -frames having this style (the dialogs don't have minimize nor maximize box by +frames having this style (the dialogs don't have a minimize or a maximize box by default)} \twocolitem{\windowstyle{wxFRAME\_SHAPED}}{Windows with this style are allowed to have their shape changed with the \helpref{SetShape}{wxframesetshape} method.} diff --git a/docs/latex/wx/gauge.tex b/docs/latex/wx/gauge.tex index 4bf0ea82c6..d615f8ec88 100644 --- a/docs/latex/wx/gauge.tex +++ b/docs/latex/wx/gauge.tex @@ -138,10 +138,6 @@ This method is not implemented (returns $0$) for most platforms. Returns the current position of the gauge. -\wxheading{Remarks} - -This method is not implemented (doesn't do anything) for most platforms. - \wxheading{See also} \helpref{wxGauge::SetValue}{wxgaugesetvalue}