\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxApp::wxApp}
\func{void}{wxApp}{\void}
\wxheading{See also}
-\helpref{wxHandleFatalExcetions}{wxhandlefatalexceptions}
+\helpref{wxHandleFatalExceptions}{wxhandlefatalexceptions}
%% VZ: the wxApp event handler are private and should not be documented here!
%%
\wxheading{See also}
\helpref{wxWindow::Close}{wxwindowclose},\rtfsp
-\helpref{wxCloseEvent}{wxcloseevent}
-%% GD: OnXXX functions are not documented
-%%\helpref{wxApp::OnEndSession}{wxapponendsession}
-
+\helpref{wxCloseEvent}{wxcloseevent}\rtfsp
\membersection{wxApp::OnRun}\label{wxapponrun}
\helpref{GetExitOnFrameDelete}{wxappgetexitonframedelete} flag is \true (this
is the default).
-
\membersection{wxApp::OnUnhandledException}\label{wxapponunhandledexception}
\func{virtual void}{OnUnhandledException}{\void}
the exception you should override \helpref{OnRun()}{wxapponrun} and put a
try/catch clause around the call to the base class version there.
-
\membersection{wxApp::ProcessMessage}\label{wxappprocessmessage}
\func{bool}{ProcessMessage}{\param{WXMSG *}{msg}}
\begin{verbatim}
wxWindow *my_window = (wxWindow*) NULL;
\end{verbatim}
-}
+}%
It is recommended to adhere to this in all code using wxWindows as
this make the code (a bit) more portable.
Help classes from within your application, but this provides a
handy stand-alone viewer. See \helpref{wxHTML Notes}{wxhtml} for more details.
You can find it in {\tt samples/html/helpview}.
-
\item[{\bf Tex2RTF}]
Supplied with wxWindows is a utility called Tex2RTF for converting\rtfsp
\LaTeX\ manuals HTML, MS HTML Help, wxHTML Help, RTF, and Windows
by authors wishing to create on-line and printed manuals from the same\rtfsp
\LaTeX\ source. Please see the separate documentation for Tex2RTF.
You can find it under {\tt utils/tex2rtf}.
-
\item[{\bf Helpgen}]
Helpgen takes C++ header files and generates a Tex2RTF-compatible
documentation file for each class it finds, using comments as appropriate.
This is a good way to start a reference for a set of classes.
Helpgen can be found in {\tt utils/HelpGen}.
-
\item[{\bf Emulator}]
Xnest-based display emulator for X11-based PDA applications. On some
systems, the Xnest window does not synchronise with the
'skin' window. This program can be found in {\tt utils/emulator}.
-
\item[{\bf Configuration Tool}]
The wxWindows Configuration Tool is a work in progress
intended to make it easier to configure wxWindows
also on the cards. Since configurations are
handled one at a time, the tool is of limited used until further
development can be done. The program can be found in {\tt utils/configtool}.
-
\item[{\bf XRC resource system}]
This is the sizer-aware resource system, and uses
XML-based resource specifications that can be generated by tools
such as \urlref{wxDesigner}{http://www.roebling.de} and XRC's own wxrcedit.
You can find this in {\tt contrib/src/xrc}, {\tt contrib/include/wx/xrc}, {\tt contrib/samples/xrc}, and {\tt contrib/utils/wxrcedit}.
For more information, see the \helpref{XML-based resource system overview}{xrcoverview}.
-
\item[{\bf Object Graphics Library}]
OGL defines an API for applications that need to display objects connected by lines.
The objects can be moved around and interacted with.
You can find this in {\tt contrib/src/ogl}, {\tt contrib/include/wx/ogl}, and {\tt contrib/samples/ogl}.
-
\item[{\bf Frame Layout library}]
FL provides sophisticated pane dragging and docking facilities.
You can find this in {\tt contrib/src/fl}, {\tt contrib/include/wx/fl}, and {\tt contrib/samples/fl}.
-
\item[{\bf Gizmos library}]
Gizmos is a collection of useful widgets and other classes. Classes include wxLEDNumberCtrl,
wxEditableListBox, wxMultiCellCanvas.
You can find this in {\tt contrib/src/gizmos}, {\tt contrib/include/wx/gizmos}, and {\tt contrib/samples/gizmos}.
-
\item[{\bf Net library}]
Net is a collection of very simple mail and web related classes. Currently
there is only wxEmail, which makes it easy to send email messages via MAPI on Windows or sendmail on Unix.
You can find this in {\tt contrib/src/net} and {\tt contrib/include/wx/net}.
-
\item[{\bf Animate library}]
Animate allows you to load animated GIFs and play them on a window. The library can be extended
to use other animation formats.
You can find this in {\tt contrib/src/animate}, {\tt contrib/include/wx/animate}, and {\tt contrib/samples/animate}.
-
\item[{\bf MMedia library}]
Mmedia supports a variety of multimedia functionality. The status of this library is currently unclear.
You can find this in {\tt contrib/src/mmedia}, {\tt contrib/include/wx/mmedia}, and {\tt contrib/samples/mmedia}.
-
\item[{\bf Styled Text Control library}]
STC is a wrapper around Scintilla, a syntax-highlighting text editor.
You can find this in {\tt contrib/src/stc}, {\tt contrib/include/wx/stc}, and {\tt contrib/samples/stc}.
-
\item[{\bf Plot}]
Plot is a simple curve plotting library.
You can find this in {\tt contrib/src/plot}, {\tt contrib/include/wx/plot}, and {\tt contrib/samples/plot}.
\input xmlresh.tex
\input zipstrm.tex
\input strmzlib.tex
+
function.
Equality operators are defined for wxDateSpans. Two datespans are equal if
-and only if they both give the same target date when added to {\bf every}
+and only if they both give the same target date when added to {\bf every}\rtfsp
source date. Thus wxDateSpan::Months(1) is not equal to wxDateSpan::Days(30),
because they don't give the same date when added to 1 Feb. But
wxDateSpan::Days(14) is equal to wxDateSpan::Weeks(2)
\helpref{SetSecond}{wxdatetimesetsecond}\\
\helpref{SetMillisecond}{wxdatetimesetmillisecond}\\
\helpref{operator$=$(time\_t)}{wxdatetimeoperatoreqtimet}\\
-\helpref{operator$=$(struct tm)}{wxdatetimeoperatoreqtm}
-%\helpref{operator$=$(struct Tm)}{wxdatetimeoperatortm2}
+\helpref{operator$=$(struct tm)}{wxdatetimeoperatoreqtm}\rtfsp
\membersection{Accessors}
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()
{
dlg->Destroy();
}
\end{verbatim}
+
works, you can also achieve the same result by using a simpler code fragment
below:
+
\begin{verbatim}
void AskUser()
{
\wxheading{Window styles}
-\twocolwidtha{5cm}
+\twocolwidtha{7cm}
\begin{twocollist}
\twocolitem{\indexit{wxDIRCTRL\_DIR\_ONLY}}{Only show directories, and not files.}
\twocolitem{\indexit{wxDIRCTRL\_3D\_INTERNAL}}{Use 3D borders for internal controls.}
either {\tt Wx::ClassInfo} objects or strings which contain the name
of the perl packages which are to be used as {\tt Wx::Document} and
{\tt Wx::View} classes (they must have a constructor named {\tt
-new}):\par
+new}):
+
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf Wx::DocTemplate->new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
\wxheading{See also}
-%\helpref{wxWindow::OnDropFiles}{wxwindowondropfiles},
\helpref{Event handling overview}{eventhandlingoverview}
\latexignore{\rtfignore{\wxheading{Members}}}
Loads DLL with the given \arg{name} into memory. The \arg{flags} argument can
be a combination of the following bits:
+
\begin{twocollist}
\twocolitem{wxDL\_LAZY}{equivalent of RTLD\_LAZY under Unix, ignored elsewhere}
\twocolitem{wxDL\_NOW}{equivalent of RTLD\_NOW under Unix, ignored elsewhere}
All wxWindows events implement a copy constructor, so the easiest way of
implementing the Clone function is to implement a copy constructor for
a new event (call it MyEvent) and then define the Clone function like this:
+
\begin{verbatim}
wxEvent *Clone(void) const { return new MyEvent(*this); }
\end{verbatim}
on the file name format and the only portable way to answer to this question is
to use \helpref{IsAbsolute}{wxfilenameisabsolute} method. To ensure that the
filename is absolute you may use \helpref{MakeAbsolute}{wxfilenamemakeabsolute}.
-There is also an inverse function
+There is also an inverse function
\helpref{MakeRelativeTo}{wxfilenamemakerelativeto} which undoes what
\helpref{Normalize(wxPATH\_NORM\_DOTS)}{wxfilenamenormalize} does.
\docparam{flags}{The kind of normalization to do with the file name. It can be
any or-combination of the following constants:
+
\begin{twocollist}
\twocolitem{{\bf wxPATH\_NORM\_ENV\_VARS}}{replace env vars with their values}
\twocolitem{{\bf wxPATH\_NORM\_DOTS}}{squeeze all .. and . and prepend cwd}
\twocolitem{{\bf wxPATH\_NORM\_SHORTCUT}}{resolve if it is a shortcut (Windows only)}
\twocolitem{{\bf wxPATH\_NORM\_ALL}}{all of previous flags except \texttt{wxPATH\_NORM\_CASE}}
\end{twocollist}
-}
+}%
\docparam{cwd}{If not empty, this directory will be used instead of current
working directory in normalization.}
\begin{verbatim}
ChangePathTo("dir/subdir/xh.htm");
ChangePathTo("dir/subdir", true);
-C hangePathTo("dir/subdir/", true);
+ ChangePathTo("dir/subdir/", true);
\end{verbatim}
\wxheading{Parameters}
\wxheading{Constants}
The font flags which can be used during the font creation are:
+
\begin{verbatim}
enum
{
\end{verbatim}
The known font encodings are:
+
\begin{verbatim}
enum wxFontEncoding
{
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).
You cannot use this style together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so
-you should use
+you should use\rtfsp
{\tt wxDEFAULT\_FRAME\_STYLE \& ~ (wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the
frames having this style (the dialogs don't have a minimize or a maximize box by
default)}
either look up a function using the alphabetical listing of them or find it in
the corresponding topic.
-
-
\section{Alphabetical functions and macros list}
\helpref{CLASSINFO}{classinfo}\\
array, any additional ones are the command parameters and the array must be
terminated with a NULL pointer.}
-\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},
+\docparam{flags}{Combination of bit masks {\tt wxEXEC\_ASYNC},\rtfsp
{\tt wxEXEC\_SYNC} and {\tt wxEXEC\_NOHIDE}}
\docparam{callback}{An optional pointer to \helpref{wxProcess}{wxprocess}}
\end{verbatim}
{\tt wxSIGNONE}, {\tt wxSIGKILL} and {\tt wxSIGTERM} have the same meaning
-under both Unix and Windows but all the other signals are equivalent to
+under both Unix and Windows but all the other signals are equivalent to
{\tt wxSIGTERM} under Windows.
Returns 0 on success, -1 on failure. If {\it rc} parameter is not NULL, it will
\func{}{wxENTER\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
-This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if
+This macro is equivalent to \helpref{cs.Enter()}{wxcriticalsectionenter} if
{\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
\func{}{wxLEAVE\_CRIT\_SECT}{\param{wxCriticalSection\& }{cs}}
-This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if
+This macro is equivalent to \helpref{cs.Leave()}{wxcriticalsectionleave} if
{\tt wxUSE\_THREADS} is $1$ and does nothing if it is $0$.
translated (note that it is a bad example, really, as
\helpref{wxDateTime}{wxdatetime} already can be used to get the localized week
day names already). If you write
+
\begin{verbatim}
static const wxChar * const weekdays[] = { _("Mon"), ..., _("Sun") };
...
// use weekdays[n] as usual
\end{verbatim}
+
the code wouldn't compile because the function calls are forbidden in the array
initializer. So instead you should do
+
\begin{verbatim}
static const wxChar * const weekdays[] = { wxTRANSLATE("Mon"), ..., wxTRANSLATE("Sun") };
...
// use wxGetTranslation(weekdays[n])
\end{verbatim}
+
here.
Note that although the code {\bf would} compile if you simply omit
This no longer needs to be called by the application: it will be called
by wxWindows if necessary.
-See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},
+See also \helpref{wxDDEServer}{wxddeserver}, \helpref{wxDDEClient}{wxddeclient}, \helpref{wxDDEConnection}{wxddeconnection},\rtfsp
\helpref{wxDDECleanUp}{wxddecleanup}.
\wxheading{Include files}
This protected virtual method may be overridden so that the controller
uses slightly different frame. See {\it samples/html/helpview} sample for
an example.
+
\membersection{wxHtmlHelpController::Display}\label{wxhtmlhelpcontrollerdisplay}
\func{void}{Display}{\param{const wxString\& }{x}}
\wxheading{Parameters}
-\docparam{type}{Indicates type of the resource. Is one of
+\docparam{type}{Indicates type of the resource. Is one of:
+
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf wxHTML\_URL\_PAGE}}{Opening a HTML page.}
\twocolitem{{\bf wxHTML\_URL\_IMAGE}}{Opening an image.}
You shouldn't use InitParser, DoParsing, GetProduct or DoneParser directly.
-
-
\membersection{wxHtmlParser::PushTagHandler}\label{wxhtmlparserpushtaghandler}
\func{void}{PushTagHandler}{\param{wxHtmlTagHandler* }{handler}, \param{wxString }{tags}}
\wxheading{See also}
-\wxheading{wxIcon}{wxicon}, \helpref{wxFileType::GetIcon()}{wxfiletypegeticon}
-
+\helpref{wxIcon}{wxicon}, \helpref{wxFileType::GetIcon}{wxfiletypegeticon}
\latexignore{\rtfignore{\wxheading{Members}}}
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_INIT\_DIALOG(func)}}{Process a wxEVT\_INIT\_DIALOG event.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
\perlnote{In wxPerl you can't use the '\_' function name, so
the {\tt Wx::Locale} module can export the {\tt gettext} and
{\tt gettext\_noop} under any given name.
+
\begin{verbatim}
# this imports gettext ( equivalent to Wx::GetTranslation
# and gettext_noop ( a noop )
button = Wx::Button->new( window, -1, gettext( ``Label'' ) );
\end{verbatim}
+
If you need to translate a lot of strings, then adding gettext( ) around
each one is a long task ( that is why \_( ) was introduced ), so just choose
a shorter name for gettext:
+
\begin{verbatim}
#
use Wx::Locale 'gettext' => 't',
# ...
\end{verbatim}
-}
+}%
\wxheading{Derived from}
\helpref{wxLogTrace}{wxlogtrace}.
\wxheading{See also}
+
\helpref{RemoveTraceMask}{wxlogremovetracemask}
\helpref{GetTraceMasks}{wxloggettracemasks}
\helpref{AddTraceMask}{wxlogaddtracemask}.
\wxheading{See also}
+
\helpref{RemoveTraceMask}{wxlogremovetracemask}
\membersection{wxLog::GetTraceMasks}\label{wxloggettracemasks}
Returns the currently allowed list of string trace masks.
\wxheading{See also}
+
\helpref{AddTraceMask}{wxlogaddtracemask}.
\membersection{wxLog::OnLog}\label{wxlogonlog}
called (the standard GUI log target only shows the log dialog when it is
flushed, so Suspend() works as expected with it).
-\wxheading{See also:}
+\wxheading{See also}
\helpref{Resume}{wxlogresume},\\
\helpref{wxLogNull}{wxlogoverview}
Flushes the current log target if any, does nothing if there is none.
-See also:
+\wxheading{See also}
\helpref{Flush}{wxlogflush}
wxLogMessage("..."); // ok
\end{verbatim}
-}
+}%
would be better written as:
...
}
\end{verbatim}
-}
+}%
\wxheading{Derived from}
License along with this library; if not, write to the Free
Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
\end{verbatim}
-}
+}%
Also add information on how to contact you by electronic and paper mail.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
\end{verbatim}
-}
+}%
That's all there is to it!
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_MOUSE\_CAPTURE\_CHANGED(func)}}{Process a wxEVT\_MOUSE\_CAPTURE\_CHANGED event.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
followed by the accelerator itself. The accelerator may be any alphanumeric
character, any function key (from {\tt F1} to {\tt F12}) or one of the special
characters listed in the table below (again, case doesn't matter):
+
\begin{twocollist}\itemsep=0pt
\twocolitem{{\tt DEL} or {\tt DELETE}}{Delete key}
\twocolitem{{\tt INS} or {\tt INSERT}}{Insert key}
\helpref{wxMenu::SetHelpString}{wxmenusethelpstring}, \helpref{wxMenuItem}{wxmenuitem}
\pythonnote{In place of a single overloaded method name, wxPython
-implements the following methods:\par
+implements the following methods:
+
\indented{2cm}{\begin{twocollist}
\twocolitem{{\bf Append(id, string, helpStr="", checkable=false)}}{}
\twocolitem{{\bf AppendMenu(id, string, aMenu, helpStr="")}}{}
by \helpref{wxFrame}{wxframe}}
\twocolitem{{\bf EVT\_MENU\_HIGHLIGHT\_ALL(func)}}{A menu item has been
highlighted, i.e. the currently selected menu item has changed.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_MOVE(func)}}{Process a wxEVT\_MOVE event, which is generated
when a window is moved.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGED event.}
\twocolitem{{\bf EVT\_NOTEBOOK\_PAGE\_CHANGING(id, func)}}{The page selection is about to be changed.
Processes a wxEVT\_COMMAND\_NOTEBOOK\_PAGE\_CHANGING event. This event can be \helpref{vetoed}{wxnotifyeventveto}.}
-\end{twocollist}%
+\end{twocollist}
\helpref{wxRegEx}{wxregex}
-
\subsection{Different Flavors of REs}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
EREs with some significant extensions.
This manual page primarily describes
-AREs. BREs mostly exist for backward compatibility in some old programs;
-they will be discussed at the \helpref{end}{wxresynbre}. POSIX EREs are almost an exact subset
-of AREs. Features of AREs that are not present in EREs will be indicated.
+AREs. BREs mostly exist for backward compatibility in some old programs;
+they will be discussed at the \helpref{end}{wxresynbre}. POSIX EREs are almost an exact subset
+of AREs. Features of AREs that are not present in EREs will be indicated.
-
\subsection{Regular Expression Syntax}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
(not quite all) of the Perl5 extensions (thanks, Henry!). Much of the description
of regular expressions below is copied verbatim from his manual entry.
-An
-ARE is one or more {\it branches}, separated by `{\bf $|$}', matching anything that matches
+An ARE is one or more {\it branches}, separated by `{\bf $|$}', matching anything that matches
any of the branches.
A branch is zero or more {\it constraints} or {\it quantified
atoms}, concatenated. It matches a match for the first, followed by a match
for the second, etc; an empty branch matches the empty string.
-A quantified
-atom is an {\it atom} possibly followed by a single {\it quantifier}. Without a quantifier,
+A quantified atom is an {\it atom} possibly followed by a single {\it quantifier}. Without a quantifier,
it matches a match for the atom. The quantifiers, and what a so-quantified
atom matches, are:
character with no other significance, matches that character.}
\end{twocollist}
-A {\it constraint}
-matches an empty string when specific conditions are met. A constraint may
+A {\it constraint} matches an empty string when specific conditions are met. A constraint may
not be followed by a quantifier. The simple constraints are as follows;
some more constraints are described later, under \helpref{Escapes}{wxresynescapes}.
An RE may not end with `{\bf $\backslash$}'.
-
\subsection{Bracket Expressions}\label{wxresynbracket}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
({\bf \_}). These special bracket expressions are deprecated; users of AREs should
use constraint escapes instead (see \helpref{Escapes}{wxresynescapes} below).
-
\subsection{Escapes}\label{wxresynescapes}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
(i.e. the number is in the legal range for a back reference), and otherwise
is taken as octal.
-
\subsection{Metasyntax}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
director) has specified that the user's input be treated as a literal string
rather than as an RE.
-
\subsection{Matching}\label{wxresynmatching}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
quantified atom in it which has a preference. An RE consisting of two or
more branches connected by the {\bf $|$} operator prefers longest match.
-Subject
-to the constraints imposed by the rules for matching the whole RE, subexpressions
+Subject to the constraints imposed by the rules for matching the whole RE, subexpressions
also match the longest or shortest possible substrings, based on their
preferences, with subexpressions starting earlier in the RE taking priority
over ones starting later. Note that outer subexpressions thus take priority
this affects {\bf $^$} and {\bf \$} as with newline-sensitive matching, but not {\bf .} and bracket
expressions. This isn't very useful but is provided for symmetry.
-
\subsection{Limits And Compatibility}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
implemented an early version of today's EREs. There are four incompatibilities between {\it regexp}'s
near-EREs (`RREs' for short) and AREs. In roughly increasing order of significance:
{\itemize
-\item
-In AREs, {\bf $\backslash$} followed by an alphanumeric character is either an escape or
+\item In AREs, {\bf $\backslash$} followed by an alphanumeric character is either an escape or
an error, while in RREs, it was just another way of writing the alphanumeric.
This should not be a problem because there was no reason to write such
a sequence in RREs.
-\item%
-{\bf \{} followed by a digit in an ARE is the beginning of
+\item {\bf \{} followed by a digit in an ARE is the beginning of
a bound, while in RREs, {\bf \{} was always an ordinary character. Such sequences
should be rare, and will often result in an error because following characters
will not look like a valid bound.
-\item%
-In AREs, {\bf $\backslash$} remains a special character
+\item In AREs, {\bf $\backslash$} remains a special character
within `{\bf $[]$}', so a literal {\bf $\backslash$} within {\bf $[]$} must be
written `{\bf $\backslash\backslash$}'. {\bf $\backslash\backslash$} also gives a literal
{\bf $\backslash$} within {\bf $[]$} in RREs, but only truly paranoid programmers routinely doubled
the backslash.
-\item%
-AREs report the longest/shortest match for the RE, rather
+\item AREs report the longest/shortest match for the RE, rather
than the first found in a specified search order. This may affect some RREs
which were written in the expectation that the first match would be reported.
(The careful crafting of RREs to optimize the search order for fast matching
will need rewriting.)
}
-
\subsection{Basic Regular Expressions}\label{wxresynbre}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
for {\bf $[[:<:]]$} and {\bf $[[:>:]]$} respectively;
no other escapes are available.
-
\subsection{Regular Expression Character Names}\label{wxresynchars}
\helpref{Syntax of the builtin regular expression library}{wxresyn}
\twocolitem{tilde}{'$~$'}
\twocolitem{DEL}{'$\backslash$177'}
\end{twocollist}
+
All drawing functions take some standard parameters:
\begin{itemize}
- \item \arg{win} is the window being drawn. It is normally not used and when
- it is it should only be used as a generic \helpref{wxWindow}{wxwindow}
- (in order to get its low level handle, for example), but you should
- \emph{not} assume that it is of some given type as the same renderer
- function may be reused for drawing different kinds of control.
- \item \arg{dc} is the \helpref{wxDC}{wxdc} to draw on. Only this device
- context should be used for drawing. It is not necessary to restore
- pens and brushes for it on function exit but, on the other hand, you
- shouldn't assume that it is in any specific state on function entry:
- the rendering functions should always prepare it.
- \item \arg{rect} the bounding rectangle for the element to be drawn.
- \item \arg{flags} the optional flags (none by default) which can be a
- combination of the \texttt{wxCONTROL\_XXX} constants below.
+\item \arg{win} is the window being drawn. It is normally not used and when
+it is it should only be used as a generic \helpref{wxWindow}{wxwindow}
+(in order to get its low level handle, for example), but you should
+\emph{not} assume that it is of some given type as the same renderer
+function may be reused for drawing different kinds of control.
+\item \arg{dc} is the \helpref{wxDC}{wxdc} to draw on. Only this device
+context should be used for drawing. It is not necessary to restore
+pens and brushes for it on function exit but, on the other hand, you
+shouldn't assume that it is in any specific state on function entry:
+the rendering functions should always prepare it.
+\item \arg{rect} the bounding rectangle for the element to be drawn.
+\item \arg{flags} the optional flags (none by default) which can be a
+combination of the \texttt{wxCONTROL\_XXX} constants below.
\end{itemize}
\wxheading{Constants}
The following rendering flags are defined:
+
\begin{verbatim}
enum
{
};
\end{verbatim}
-
\wxheading{Derived from}
No base class
To declare the smart pointer class \texttt{CLASSNAME} containing pointes to a
(possibly incomplete) type \texttt{TYPE} you should use
+
\begin{verbatim}
wxDECLARE_SCOPED_PTR( TYPE, // type of the values
CLASSNAME ); // name of the class
\end{verbatim}
And later, when \texttt{TYPE} is fully defined, you must also use
+
\begin{verbatim}
wxDEFINE_SCOPED_PTR( TYPE, CLASSNAME );
\end{verbatim}
definition of this class and if you accept the standard naming convention, that
is that the scoped pointer for the class \texttt{Foo} is called
\texttt{FooPtr}, you can use a single macro which replaces two macros above:
+
\begin{verbatim}
wxDEFINE_SCOPED_PTR_TYPE( TYPE );
\end{verbatim}
+
Once again, in this cass \texttt{CLASSNAME} will be \texttt{TYPEPtr}.
\wxheading{Include files}
\end{twocollist}
The static form is shorthand for this code:
+
\begin{verbatim}
wxSound(filename).Play(flags);
\end{verbatim}
wxWindows defines a special identifier value {\tt wxID\_ANY} which is used in
the following two situations:
+
\begin{itemize}
- \item when creating a new window you may specify {\tt wxID\_ANY} to let
- wxWindows assign an unused identifier to it automatically
- \item when installing an event handler using either the event table
- macros or \helpref{wxEvtHandler::Connect}{wxevthandlerconnect}
- you may use it to indicate that you want to handle the events
- coming from any control, regardless of its identifier
+\item when creating a new window you may specify {\tt wxID\_ANY} to let
+wxWindows assign an unused identifier to it automatically
+\item when installing an event handler using either the event table
+macros or \helpref{wxEvtHandler::Connect}{wxevthandlerconnect},
+you may use it to indicate that you want to handle the events
+coming from any control, regardless of its identifier
\end{itemize}
wxWindows also defines a few standard command identifiers which may be used by
case wxDragMove: /* move the data */ break;
default: /* do nothing */ break;
}
-\end{verbatim}
+\end{verbatim}%
\end{itemize}
To be a {\it drop target}, i.e. to receive the data dropped by the user you should
;;; tex2rtf_css.ini for a version using a style sheet. You can use
;;; -macros tex2rtf.ini to specify the ini file.
runTwice = yes
-titleFontSize = 12
-authorFontSize = 10
-authorFontSize = 10
-chapterFontSize = 12
-sectionFontSize = 12
+titleFontSize = 18
+authorFontSize = 12
+authorFontSize = 12
+chapterFontSize = 18
+sectionFontSize = 16
subsectionFontSize = 12
contentsDepth = 2
headerRule = yes
If {\it oneShot}\/ is {\tt false} (the default), the \helpref{Notify}{wxtimernotify}
function will be called repeatedly until the timer is stopped. If {\tt true},
it will be called only once and the timer will stop automatically. To make your
-code more readable you may also use the following symbolic constants
-\twocolwidtha{5cm}%
+code more readable you may also use the following symbolic constants:
+
+\twocolwidtha{5cm}
\begin{twocollist}\itemsep=0pt
\twocolitem{wxTIMER\_CONTINUOUS}{Start a normal, continuously running, timer}
\twocolitem{wxTIMER\_ONE\_SHOT}{Start a one shot timer}
\end{twocollist}
-
If the timer was already running, it will be stopped by this method before
restarting it.
Finally, there is also a possibility to redirect the output sent to {\it cout}
to a \helpref{wxTextCtrl}{wxtextctrl} by using the
\helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} class.
-
\item{\bf Flexibility} The output of wxLog functions can be redirected or
suppressed entirely based on their importance, which is either impossible or
difficult to do with traditional methods. For example, only error messages, or
non-existing file will usually provoke an error message, but if for some
reasons it is unwanted, just use this construction:
-{\small
+{\small%
\begin{verbatim}
wxFile file;
wxLogMessage("..."); // ok
\end{verbatim}
-}
+}%
\end{itemize}
The log targets can also be combined: for example you may wish to redirect the
\input tenvvars.tex
\input wxPython.tex
\input re_syntax.tex
+
usual symptom is that the expanded items leave black (or otherwise incorrectly
coloured) background behind them, especially for the controls using non
default background colour. The recommended solution is to upgrade the {\tt comctl32.dll}
-to a newer version: see
+to a newer version: see
\urlref{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}{http://www.microsoft.com/msdownload/ieplatform/ie/comctrlx86.asp}.
\latexignore{\rtfignore{\wxheading{Members}}}
\twocolitem{{\bf GetPyData(item)}}{Returns the Python Object
associated with the wxTreeItemData for the given item Id.}
\end{twocollist}}
-}
+}%
\perlnote{wxPerl provides the following shortcut method:
\indented{2cm}{
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf GetPlData( item )}}{Returns the Perl data
-associated with the Wx::TreeItemData ( it is just the same as
-tree->GetItemData( item )->GetData(); ).}
+associated with the Wx::TreeItemData. It is just the same as
+tree->GetItemData(item)->GetData().}
\end{twocollist}}
-}
-
+}%
\membersection{wxTreeCtrl::GetItemFont}\label{wxtreectrlgetitemfont}
\twocolitem{{\bf SetPyData(item, obj)}}{Associate the given Python
Object with the wxTreeItemData for the given item Id.}
\end{twocollist}}
-}
+}%
\perlnote{wxPerl provides the following shortcut method:
\indented{2cm}{
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf SetPlData( item, data )}}{Sets the Perl data
-associated with the Wx::TreeItemData ( it is just the same as
-tree->GetItemData( item )->SetData( data ); ).}
+associated with the Wx::TreeItemData. It is just the same as
+tree->GetItemData(item)->SetData(data).}
\end{twocollist}}
-}
-
+}%
\membersection{wxTreeCtrl::SetItemFont}\label{wxtreectrlsetitemfont}
See also \helpref{AssignStateImageList}{wxtreectrlassignstateimagelist}.
+\membersection{wxTreeCtrl::SetWindowStyle}\label{wxtreectrlsetwindowstyle}
+
\func{void}{SetWindowStyle}{\param{long}{styles}}
Sets the mode flags associated with the display of the tree control.
\twocolitem{{\bf EVT\_TREE\_KEY\_DOWN(id, func)}}{A key has been pressed.}
\twocolitem{{\bf EVT\_TREE\_ITEM\_GETTOOLTIP(id, func)}}{The opportunity to set the item tooltip
is being given to the application (call wxTreeEvent::SetToolTip). Windows only.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
it with standard ZIP tools. Note that if you are using XRS files, you have
to initialize \helpref{wxFileSystem}{wxfilesystem} ZIP handler first! It is a simple
thing to do:
+
\begin{verbatim}
#include <wx/filesys.h>
#include <wx/fs_zip.h>
{\tt wxrc} utility to produce C++ file with embedded resources. This file will
contain a function called {\it InitXmlResource} (unless you override this with
a command line switch). Use it to load the resource:
+
\begin{verbatim}
extern void InitXMLResource(); // defined in generated file
...
table.
Example:
+
\begin{verbatim}
#include "resource.h"
\begin{twocollist}\itemsep=0pt
\twocolitem{{\bf EVT\_UPDATE\_UI(id, func)}}{Process a wxEVT\_UPDATE\_UI event for the command with the given id.}
\twocolitem{{\bf EVT\_UPDATE\_UI\_RANGE(id1, id2, func)}}{Process a wxEVT\_UPDATE\_UI event for any command with id included in the given range.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{Remarks}
\constfunc{void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}}
\perlnote{In wxPerl this method takes no parameter and returns
-a 2-element list {\tt ( width, height )}.}
+a 2-element list {\tt (width, height)}.}
\constfunc{wxSize}{GetClientSize}{\void}
\wxheading{See also}
-\helpref{GetSize}{wxwindowgetsize}
+\helpref{GetSize}{wxwindowgetsize},\rtfsp
\helpref{GetVirtualSize}{wxwindowgetvirtualsize}
the wizard (this event may also be vetoed).}
\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.}
\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{Extended styles}
the wizard (this event may also be vetoed).}
\twocolitem{{\bf EVT\_WIZARD\_HELP(id, func)}}{The wizard help button was pressed.}
\twocolitem{{\bf EVT\_WIZARD\_FINISHED(id, func)}}{The wizard finished button was pressed.}
-\end{twocollist}%
+\end{twocollist}
\wxheading{See also}
A convenience function to make the pages follow each other.
Example:
+
\begin{verbatim}
wxRadioboxPage *page3 = new wxRadioboxPage(wizard);
wxValidationPage *page4 = new wxValidationPage(wizard);
projects / wxWidgets.git / commitdiff
