From: Julian Smart Date: Fri, 11 Feb 2005 20:08:51 +0000 (+0000) Subject: Misc doc fixes X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/dceb1c097c8c24b398f48b482220c358bc7b4db4?ds=sidebyside Misc doc fixes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31933 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/latex/wx/artprov.tex b/docs/latex/wx/artprov.tex index c30aaaf824..5ed81edb2f 100644 --- a/docs/latex/wx/artprov.tex +++ b/docs/latex/wx/artprov.tex @@ -29,8 +29,7 @@ provider with \end{verbatim} There's another way of taking advantage of this class: you can use it in your code and use -platform native icons as provided by -\helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or +platform native icons as provided by \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too small). diff --git a/docs/latex/wx/calctrl.tex b/docs/latex/wx/calctrl.tex index a6bf325c70..31141b041d 100644 --- a/docs/latex/wx/calctrl.tex +++ b/docs/latex/wx/calctrl.tex @@ -11,9 +11,9 @@ \section{\class{wxCalendarCtrl}}\label{wxcalendarctrl} -The calendar control allows the user to pick a date interactively. For this, -it displays a window containing several parts: the control to pick the month -and the year at the top (either or both of them may be disabled) and a month +The calendar control allows the user to pick a date. For this, +it displays a window containing several parts: a control at the top to pick the month +and the year (either or both of them may be disabled), and a month area below them which shows all the days in the month. The user can move the current selection using the keyboard and select the date (generating {\tt EVT\_CALENDAR} event) by pressing {\tt } or double clicking it. diff --git a/docs/latex/wx/cmdlpars.tex b/docs/latex/wx/cmdlpars.tex index f3a2c4eca8..79209f2a11 100644 --- a/docs/latex/wx/cmdlpars.tex +++ b/docs/latex/wx/cmdlpars.tex @@ -11,7 +11,7 @@ \section{\class{wxCmdLineParser}}\label{wxcmdlineparser} -wxCmdLineParser is a class for parsing command line. +wxCmdLineParser is a class for parsing the command line. It has the following features: diff --git a/docs/latex/wx/config.tex b/docs/latex/wx/config.tex index 92a853dab8..82e3e7938c 100644 --- a/docs/latex/wx/config.tex +++ b/docs/latex/wx/config.tex @@ -803,3 +803,4 @@ implements the following methods:\par \twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean} \end{twocollist} }} + diff --git a/docs/latex/wx/cppconst.tex b/docs/latex/wx/cppconst.tex index b3f0fbe711..91ac999f2b 100644 --- a/docs/latex/wx/cppconst.tex +++ b/docs/latex/wx/cppconst.tex @@ -1,11 +1,10 @@ \section{Preprocesser symbols defined by wxWidgets}\label{cppconst} -Here is the list of preprocessor symbols used in the wxWidgets source grouped +These are preprocessor symbols used in the wxWidgets source, grouped by category (and sorted by alphabetical order inside each category). All of -these macros except for \texttt{wxUSE\_XXX} variety is defined if the +these macros except for the \texttt{wxUSE\_XXX} variety is defined if the corresponding condition is true and undefined if it isn't, so they should be -always tested usin \texttt{#ifdef} and not \texttt{#if}. - +always tested using \texttt{#ifdef} and not \texttt{#if}. \subsection{GUI system}\label{guisystemconst} diff --git a/docs/latex/wx/datectrl.tex b/docs/latex/wx/datectrl.tex index 637a661b3e..8ef6c026da 100644 --- a/docs/latex/wx/datectrl.tex +++ b/docs/latex/wx/datectrl.tex @@ -10,13 +10,15 @@ \section{\class{wxDatePickerCtrl}}\label{wxdatepickerctrl} -This control allows the user to select a date. Unlike +This control allows the user to select a date. Unlike \helpref{wxCalendarCtrl}{wxcalendarctrl}, which is a relatively big control, -it is implemented as a small window showing the currently selected date and -allowing to edit it directly using the keyboard and may also display a popup +wxDatePickerCtrl is implemented as a small window showing the currently selected date. +The control can be edited using the keyboard, and can also display a popup window for more user-friendly date selection, depending on the styles used and the platform. +It is only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$. + \wxheading{Derived from} \helpref{wxControl}{wxcontrol}\\ @@ -28,8 +30,6 @@ the platform. -(only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$) - \wxheading{Window styles} \twocolwidtha{5cm}% @@ -170,4 +170,3 @@ in the currently selected range, if any. Calling this method does not result in a date change event. - diff --git a/docs/latex/wx/dateevt.tex b/docs/latex/wx/dateevt.tex index 510badc09d..ec2016b124 100644 --- a/docs/latex/wx/dateevt.tex +++ b/docs/latex/wx/dateevt.tex @@ -10,8 +10,8 @@ \section{\class{wxDateEvent}}\label{wxdateevent} -This event class carries information about a date change and is used together -with \helpref{wxDatePickerCtrl}{wxdatepickerctrl} and serves as a base class +This event class holds information about a date change and is used together +with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}. It also serves as a base class for \helpref{wxCalendarEvent}{wxcalendarevent}. \wxheading{Derived from} @@ -24,7 +24,6 @@ for \helpref{wxCalendarEvent}{wxcalendarevent}. - \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxDateEvent::GetDate}\label{wxdateeventgetdate} @@ -41,4 +40,3 @@ Returns the date. Sets the date carried by the event, normally only used by the library internally. - diff --git a/docs/latex/wx/portnote.tex b/docs/latex/wx/portnote.tex index a2f782580a..a603df90f2 100644 --- a/docs/latex/wx/portnote.tex +++ b/docs/latex/wx/portnote.tex @@ -4,9 +4,9 @@ wxWidgets defines a common API across platforms, but uses the native graphical user interface (GUI) on each platform, so your program will take on the native -look and feel that users are familiar with. Unfortunatelly native toolkits and -dedicated hardware not always support complete set of API functionality. This -chapter collects notes about differences among supported platforms and ports. +look and feel that users are familiar with. Unfortunately native toolkits and +hardware do not always support the functionality that the wxWidgets API +requires. This chapter collects notes about differences among supported platforms and ports. \input wxgtk.tex \input wxmsw.tex diff --git a/docs/latex/wx/renderer.tex b/docs/latex/wx/renderer.tex index 4217e25c48..70de6cedbb 100644 --- a/docs/latex/wx/renderer.tex +++ b/docs/latex/wx/renderer.tex @@ -14,7 +14,7 @@ First, a brief introduction to wxRenderer and why it is needed. Usually wxWidgets uses the underlying low level GUI system to draw all the -controls -- this is what we mean when we say that it is a ``native'' framework. +controls - this is what we mean when we say that it is a ``native'' framework. However not all controls exist under all (or even any) platforms and in this case wxWidgets provides a default, generic, implementation of them written in wxWidgets itself. diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex index a3f1240511..c21fd63c30 100644 --- a/docs/latex/wx/slider.tex +++ b/docs/latex/wx/slider.tex @@ -3,8 +3,7 @@ A slider is a control with a handle which can be pulled back and forth to change the value. -In Windows versions below Windows 95, a scrollbar is used to simulate the slider. In Windows 95, -the track bar control is used. +On Windows, the track bar control is used. Slider events are handled in the same way as a scrollbar. diff --git a/docs/latex/wx/stackwalker.tex b/docs/latex/wx/stackwalker.tex index 33e495d534..3d827f4818 100644 --- a/docs/latex/wx/stackwalker.tex +++ b/docs/latex/wx/stackwalker.tex @@ -10,15 +10,15 @@ \section{\class{wxStackWalker}}\label{wxstackwalker} -wxStackWalker allows to enumerate, or walk, the stack frames or, in other -words, the functions callstack. It is mostly useful in only two situations: +wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack). +It is mostly useful in only two situations: inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to programmatically get the location of the crash and, in debug builds, in \helpref{wxApp::OnAssert}{wxapponassert} to report the caller of the failed assert. -wxStackWalker works by repeatedly calling -\helpref{OnStackFrame}{wxstackwalkeronstackframe} method for each frame in the +wxStackWalker works by repeatedly calling +the \helpref{OnStackFrame}{wxstackwalkeronstackframe} method for each frame in the stack, so to use it you must derive your own class from it and override this method. diff --git a/docs/latex/wx/stdbtnsz.tex b/docs/latex/wx/stdbtnsz.tex index 04ce68ebe4..63e0ae5af6 100644 --- a/docs/latex/wx/stdbtnsz.tex +++ b/docs/latex/wx/stdbtnsz.tex @@ -1,12 +1,19 @@ \section{\class{wxStdDialogButtonSizer}}\label{wxstddialogbuttonsizer} -This class creates button layouts which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist). By using this class, you can ensure that all your standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK and Mac OS X human interface guidelines. +This class creates button layouts which conform to the standard button spacing and ordering defined by the platform +or toolkit's user interface guidelines (if such things exist). By using this class, you can ensure that all your +standard dialogs look correct on all major platforms. Currently it conforms to the Windows, GTK+ and Mac OS X +human interface guidelines. -When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts to the Windows implementation. +When there aren't interface guidelines defined for a particular platform or toolkit, wxStdDialogButtonSizer reverts +to the Windows implementation. -TO USE THIS CLASS: First, add buttons to the sizer by calling AddButton (or SetAffirmativeButton, SetNegativeButton, or SetCancelButton) and then call Finalise in order to create the actual button layout used. Other than these special operations, this sizer works like any other sizer. +To use this class, first add buttons to the sizer by calling AddButton (or SetAffirmativeButton, SetNegativeButton, +or SetCancelButton) and then call Finalise in order to create the actual button layout used. Other than these special +operations, this sizer works like any other sizer. -ALSO NOTE: If you add a button with wxID\_SAVE, on Mac OS X the button will be renamed to "Save" and the wxID\_NO button will be renamed to "Don't Save" in accordance with the Mac OS X Human Interface Guidelines. +If you add a button with wxID\_SAVE, on Mac OS X the button will be renamed to "Save" and +the wxID\_NO button will be renamed to "Don't Save" in accordance with the Mac OS X Human Interface Guidelines. \wxheading{Derived from} @@ -30,17 +37,17 @@ Constructor for a wxStdDialogButtonSizer. \func{void}{AddButton}{\param{wxButton* }{button}} -Adds a button to the wxStdDialogButtonSizer. The button must have one of the following IDs: +Adds a button to the wxStdDialogButtonSizer. The button must have one of the following identifiers: \begin{itemize} - \item wxID\_OK - \item wxID\_YES - \item wxID\_SAVE - \item wxID\_APPLY - \item wxID\_NO - \item wxID\_CANCEL - \item wxID\_HELP - \item wxID\_CONTEXT\_HELP +\item wxID\_OK +\item wxID\_YES +\item wxID\_SAVE +\item wxID\_APPLY +\item wxID\_NO +\item wxID\_CANCEL +\item wxID\_HELP +\item wxID\_CONTEXT\_HELP \end{itemize} \membersection{wxStdDialogButtonSizer::Finalise}\label{wxstddialogbuttonsizerfinalise} @@ -53,16 +60,17 @@ Rearranges the buttons and applies proper spacing between buttons to make them m \func{void}{SetAffirmativeButton}{\param{wxButton* }{button}} -Sets the affirmative button for the sizer. This allows you to use IDs other than the standard IDs outlined above. +Sets the affirmative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above. \membersection{wxStdDialogButtonSizer::SetCancelButton}\label{wxstddialogbuttonsizersetcancelbutton} \func{void}{SetCancelButton}{\param{wxButton* }{button}} -Sets the cancel button for the sizer. This allows you to use IDs other than the standard IDs outlined above. +Sets the cancel button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above. \membersection{wxStdDialogButtonSizer::SetNegativeButton}\label{wxstddialogbuttonsizersetnegativebutton} \func{void}{SetNegativeButton}{\param{wxButton* }{button}} -Sets the negative button for the sizer. This allows you to use IDs other than the standard IDs outlined above. +Sets the negative button for the sizer. This allows you to use identifiers other than the standard identifiers outlined above. + diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex index dd5a12fa14..8106b29b52 100644 --- a/docs/latex/wx/stdpaths.tex +++ b/docs/latex/wx/stdpaths.tex @@ -12,7 +12,7 @@ \section{\class{wxStandardPaths}}\label{wxstandardpaths} wxStandardPaths returns the standard locations in the file system and should be -used by the programs to find their data files in a portable way. +used by applications to find their data files in a portable way. Please note that this is not a real class because object of this type are never created but more a namespace containing the class methods which are all static, @@ -180,7 +180,7 @@ all platforms except Windows where it returns \func{static void}{SetInstallPrefix}{\param{const wxString\& }{prefix}} -\textbf{Note: } This function is only available under Unix. +\textbf{Note:} This function is only available under Unix. Lets wxStandardPaths know about the real program installation prefix on a Unix system. By default, the value returned by diff --git a/docs/latex/wx/strmbase.tex b/docs/latex/wx/strmbase.tex index 70ba8506d7..62b41daec1 100644 --- a/docs/latex/wx/strmbase.tex +++ b/docs/latex/wx/strmbase.tex @@ -47,7 +47,7 @@ Destructor. \constfunc{wxFileOffset}{GetLength}{\void} Returns the length of the stream in bytes. If the length cannot be determined -(this is always the case for socket streams for example), returns +(this is always the case for socket streams for example), returns \texttt{wxInvalidOffset}. \newsince{2.5.4} @@ -131,4 +131,3 @@ real position. See \helpref{OnSysRead}{wxstreambaseonsysread}. - diff --git a/docs/latex/wx/tbook.tex b/docs/latex/wx/tbook.tex index 6db142a2f9..4e25b09c47 100644 --- a/docs/latex/wx/tbook.tex +++ b/docs/latex/wx/tbook.tex @@ -46,3 +46,4 @@ WinCE, and \helpref{wxNotebook}{wxnotebook} for all other platforms. The mapping \end{twocollist} See {\tt samples/widgets} for an example of wxBookCtrl usage. + diff --git a/docs/latex/wx/ti18n.tex b/docs/latex/wx/ti18n.tex index d263cee5d1..a112b1e958 100644 --- a/docs/latex/wx/ti18n.tex +++ b/docs/latex/wx/ti18n.tex @@ -1,10 +1,10 @@ \section{Internationalization}\label{internationalization} Although internationalization of an application (i18n for short) involves far -more than just translating its text messages to another message -- date, time and +more than just translating its text messages to another message - date, time and currency formats need changing too, some languages are written left to right and others right to left, character encoding may differ and many other things -may need changing too -- it is a necessary first step. wxWidgets provides +may need changing too - it is a necessary first step. wxWidgets provides facilities for message translation with its \helpref{wxLocale}{wxlocale} class and is itself fully translated into several languages. Please consult wxWidgets home page for the most up-to-date @@ -39,7 +39,7 @@ extraction recognises the standard \_() as well as (using its {\tt -k} option) our wxGetTranslation and extracts all strings inside the calls to these functions. Alternatively, you may use {\tt -a} option to extract all the strings, but it will usually result in many strings being found which don't -have to be translated at all. This will create a text message catalog -- a .po +have to be translated at all. This will create a text message catalog - a .po file. \item Translating the strings extracted in the previous step to other language(s). It involves editing the .po file. diff --git a/docs/latex/wx/tprint.tex b/docs/latex/wx/tprint.tex index 11f32d2c99..e22b0c5b8c 100644 --- a/docs/latex/wx/tprint.tex +++ b/docs/latex/wx/tprint.tex @@ -82,3 +82,4 @@ these libraries). It is expected that the printing code that is currently implemented in the GNOME print libraries will be moved into GTK+ later. +