Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Misc doc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@31933 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2005-02-11 20:08:51 +00:00
parent c6b65b76a1
commit dceb1c097c
17 changed files with 57 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/latex/wx/artprov.tex
View File

@@ -29,8 +29,7 @@ provider with
\end{verbatim} \end{verbatim}
There's another way of taking advantage of this class: you can use it in your code and use 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 platform native icons as provided by \helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or
\helpref{wxArtProvider::GetBitmap}{wxartprovidergetbitmap} or
\helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really \helpref{wxArtProvider::GetIcon}{wxartprovidergeticon} (NB: this is not yet really
possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too possible as of wxWidgets 2.3.3, the set of wxArtProvider bitmaps is too
small). small).

6
docs/latex/wx/calctrl.tex
View File

@@ -11,9 +11,9 @@
\section{\class{wxCalendarCtrl}}\label{wxcalendarctrl} \section{\class{wxCalendarCtrl}}\label{wxcalendarctrl}
The calendar control allows the user to pick a date interactively. For this, The calendar control allows the user to pick a date. For this,
it displays a window containing several parts: the control to pick the month it displays a window containing several parts: a control at the top to pick the month
and the year at the top (either or both of them may be disabled) and a 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 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 current selection using the keyboard and select the date (generating
{\tt EVT\_CALENDAR} event) by pressing {\tt <Return>} or double clicking it. {\tt EVT\_CALENDAR} event) by pressing {\tt <Return>} or double clicking it.

2
docs/latex/wx/cmdlpars.tex
View File

@@ -11,7 +11,7 @@
\section{\class{wxCmdLineParser}}\label{wxcmdlineparser} \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: It has the following features:

1
docs/latex/wx/config.tex
View File

@@ -803,3 +803,4 @@ implements the following methods:\par
\twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean} \twocolitem{{\bf WriteBool(key, value)}}{Writes a boolean}
\end{twocollist} \end{twocollist}
}} }}

7
docs/latex/wx/cppconst.tex
View File

@@ -1,11 +1,10 @@
\section{Preprocesser symbols defined by wxWidgets}\label{cppconst} \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 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 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} \subsection{GUI system}\label{guisystemconst}

11
docs/latex/wx/datectrl.tex
View File

@@ -10,13 +10,15 @@
\section{\class{wxDatePickerCtrl}}\label{wxdatepickerctrl} \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, \helpref{wxCalendarCtrl}{wxcalendarctrl}, which is a relatively big control,
it is implemented as a small window showing the currently selected date and wxDatePickerCtrl is implemented as a small window showing the currently selected date.
allowing to edit it directly using the keyboard and may also display a popup 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 window for more user-friendly date selection, depending on the styles used and
the platform. the platform.
It is only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$.
\wxheading{Derived from} \wxheading{Derived from}
\helpref{wxControl}{wxcontrol}\\ \helpref{wxControl}{wxcontrol}\\
@@ -28,8 +30,6 @@ the platform.
<wx/dateevt.h> <wx/dateevt.h>
(only available if \texttt{wxUSE\_DATEPICKCTRL} is set to $1$)
\wxheading{Window styles} \wxheading{Window styles}
\twocolwidtha{5cm}% \twocolwidtha{5cm}%
@@ -170,4 +170,3 @@ in the currently selected range, if any.
Calling this method does not result in a date change event. Calling this method does not result in a date change event.

6
docs/latex/wx/dateevt.tex
View File

@@ -10,8 +10,8 @@
\section{\class{wxDateEvent}}\label{wxdateevent} \section{\class{wxDateEvent}}\label{wxdateevent}
This event class carries information about a date change and is used together This event class holds information about a date change and is used together
with \helpref{wxDatePickerCtrl}{wxdatepickerctrl} and serves as a base class with \helpref{wxDatePickerCtrl}{wxdatepickerctrl}. It also serves as a base class
for \helpref{wxCalendarEvent}{wxcalendarevent}. for \helpref{wxCalendarEvent}{wxcalendarevent}.
\wxheading{Derived from} \wxheading{Derived from}
@@ -24,7 +24,6 @@ for \helpref{wxCalendarEvent}{wxcalendarevent}.
<wx/dateevt.h> <wx/dateevt.h>
\latexignore{\rtfignore{\wxheading{Members}}} \latexignore{\rtfignore{\wxheading{Members}}}
\membersection{wxDateEvent::GetDate}\label{wxdateeventgetdate} \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 Sets the date carried by the event, normally only used by the library
internally. internally.

6
docs/latex/wx/portnote.tex
View File

@@ -4,9 +4,9 @@
wxWidgets defines a common API across platforms, but uses the native graphical 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 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 look and feel that users are familiar with. Unfortunately native toolkits and
dedicated hardware not always support complete set of API functionality. This hardware do not always support the functionality that the wxWidgets API
chapter collects notes about differences among supported platforms and ports. requires. This chapter collects notes about differences among supported platforms and ports.
\input wxgtk.tex \input wxgtk.tex
\input wxmsw.tex \input wxmsw.tex

2
docs/latex/wx/renderer.tex
View File

@@ -14,7 +14,7 @@
First, a brief introduction to wxRenderer and why it is needed. First, a brief introduction to wxRenderer and why it is needed.
Usually wxWidgets uses the underlying low level GUI system to draw all the 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 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 case wxWidgets provides a default, generic, implementation of them written in
wxWidgets itself. wxWidgets itself.

3
docs/latex/wx/slider.tex
View File

@@ -3,8 +3,7 @@
A slider is a control with a handle which can be pulled A slider is a control with a handle which can be pulled
back and forth to change the value. back and forth to change the value.
In Windows versions below Windows 95, a scrollbar is used to simulate the slider. In Windows 95, On Windows, the track bar control is used.
the track bar control is used.
Slider events are handled in the same way as a scrollbar. Slider events are handled in the same way as a scrollbar.

8
docs/latex/wx/stackwalker.tex
View File

@@ -10,15 +10,15 @@
\section{\class{wxStackWalker}}\label{wxstackwalker} \section{\class{wxStackWalker}}\label{wxstackwalker}
wxStackWalker allows to enumerate, or walk, the stack frames or, in other wxStackWalker allows an application to enumerate, or walk, the stack frames (the function callstack).
words, the functions callstack. It is mostly useful in only two situations: It is mostly useful in only two situations:
inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to inside \helpref{wxApp::OnFatalException}{wxapponfatalexception} function to
programmatically get the location of the crash and, in debug builds, in programmatically get the location of the crash and, in debug builds, in
\helpref{wxApp::OnAssert}{wxapponassert} to report the caller of the failed \helpref{wxApp::OnAssert}{wxapponassert} to report the caller of the failed
assert. assert.
wxStackWalker works by repeatedly calling wxStackWalker works by repeatedly calling
\helpref{OnStackFrame}{wxstackwalkeronstackframe} method for each frame in the 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 stack, so to use it you must derive your own class from it and override this
method. method.

40
docs/latex/wx/stdbtnsz.tex
View File

@@ -1,12 +1,19 @@
\section{\class{wxStdDialogButtonSizer}}\label{wxstddialogbuttonsizer} \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} \wxheading{Derived from}
@@ -30,17 +37,17 @@ Constructor for a wxStdDialogButtonSizer.
\func{void}{AddButton}{\param{wxButton* }{button}} \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} \begin{itemize}
\item wxID\_OK \item wxID\_OK
\item wxID\_YES \item wxID\_YES
\item wxID\_SAVE \item wxID\_SAVE
\item wxID\_APPLY \item wxID\_APPLY
\item wxID\_NO \item wxID\_NO
\item wxID\_CANCEL \item wxID\_CANCEL
\item wxID\_HELP \item wxID\_HELP
\item wxID\_CONTEXT\_HELP \item wxID\_CONTEXT\_HELP
\end{itemize} \end{itemize}
\membersection{wxStdDialogButtonSizer::Finalise}\label{wxstddialogbuttonsizerfinalise} \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}} \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} \membersection{wxStdDialogButtonSizer::SetCancelButton}\label{wxstddialogbuttonsizersetcancelbutton}
\func{void}{SetCancelButton}{\param{wxButton* }{button}} \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} \membersection{wxStdDialogButtonSizer::SetNegativeButton}\label{wxstddialogbuttonsizersetnegativebutton}
\func{void}{SetNegativeButton}{\param{wxButton* }{button}} \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.

4
docs/latex/wx/stdpaths.tex
View File

@@ -12,7 +12,7 @@
\section{\class{wxStandardPaths}}\label{wxstandardpaths} \section{\class{wxStandardPaths}}\label{wxstandardpaths}
wxStandardPaths returns the standard locations in the file system and should be 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 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, 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}} \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 Lets wxStandardPaths know about the real program installation prefix on a Unix
system. By default, the value returned by system. By default, the value returned by

3
docs/latex/wx/strmbase.tex
View File

@@ -47,7 +47,7 @@ Destructor.
\constfunc{wxFileOffset}{GetLength}{\void} \constfunc{wxFileOffset}{GetLength}{\void}
Returns the length of the stream in bytes. If the length cannot be determined 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}. \texttt{wxInvalidOffset}.
\newsince{2.5.4} \newsince{2.5.4}
@@ -131,4 +131,3 @@ real position.
See \helpref{OnSysRead}{wxstreambaseonsysread}. See \helpref{OnSysRead}{wxstreambaseonsysread}.

1
docs/latex/wx/tbook.tex
View File

@@ -46,3 +46,4 @@ WinCE, and \helpref{wxNotebook}{wxnotebook} for all other platforms. The mapping
\end{twocollist} \end{twocollist}
See {\tt samples/widgets} for an example of wxBookCtrl usage. See {\tt samples/widgets} for an example of wxBookCtrl usage.

6
docs/latex/wx/ti18n.tex
View File

@@ -1,10 +1,10 @@
\section{Internationalization}\label{internationalization} \section{Internationalization}\label{internationalization}
Although internationalization of an application (i18n for short) involves far 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 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 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 facilities for message translation with its
\helpref{wxLocale}{wxlocale} class and is itself fully translated into several \helpref{wxLocale}{wxlocale} class and is itself fully translated into several
languages. Please consult wxWidgets home page for the most up-to-date 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 our wxGetTranslation and extracts all strings inside the calls to these
functions. Alternatively, you may use {\tt -a} option to extract all the 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 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. file.
\item Translating the strings extracted in the previous step to other \item Translating the strings extracted in the previous step to other
language(s). It involves editing the .po file. language(s). It involves editing the .po file.

1
docs/latex/wx/tprint.tex
View File

@@ -82,3 +82,4 @@ these libraries).
It is expected that the printing code that is currently implemented It is expected that the printing code that is currently implemented
in the GNOME print libraries will be moved into GTK+ later. in the GNOME print libraries will be moved into GTK+ later.