\twocolitem{\helpref{wxPenList}{wxpenlist}}{The list of previously-created pens}
\twocolitem{\helpref{wxPalette}{wxpalette}}{Represents a table of indices into RGB values}
\twocolitem{\helpref{wxRegion}{wxregion}}{Represents a simple or complex region on a window or device context}
-\twocolitem{\helpref{wxRenderer}{wxrenderer}}{Abstracts high-level drawing primitives}
+\twocolitem{\helpref{wxRendererNative}{wxrenderernative}}{Abstracts high-level drawing primitives}
\end{twocollist}
{\large {\bf Events}}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfo}
+\membersection{wxDbGridColInfo::wxDbGridColInfo}\label{wxdbgridcolinfoctor}
\func{}{wxDbGridColInfo}{\param{int }{colNo}, \param{wxString }{type},
\param{wxString }{title}, \param{wxDbGridColInfo *}{next}}
\helpref{wxDbTable}{wxdbtable}. If no datatype conversion or the referenced column number does not exist the
the behavior is undefined.
-See the example at \helpref{wxDbGridColInfo::wxDbGridColInfo}{wxdbgridcolinfo}.
+See the example at \helpref{wxDbGridColInfo::wxDbGridColInfo}{wxdbgridcolinfoctor}.
\section{\class{wxDbGridTableBase}}\label{wxdbgridtablebase}
event handler should be skipped, and the next valid handler used
instead.
-\membersection{wxEvent::StopPropagation}
+\membersection{wxEvent::StopPropagation}\label{wxeventstoppropagation}
-\func{int}{StopPropagation}{\void}\label{wxeventstoppropagation}
+\func{int}{StopPropagation}{\void}
Stop the event from propagating to its parent window.
\helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the
event again.
-
bar explicitly (except by resetting the frame's menu bar to another
frame or NULL).
-Under Windows, a call to \helpref{wxFrame::OnSize}{wxframeonsize} is generated, so be sure to initialize
+Under Windows, a size event is generated, so be sure to initialize
data members properly before calling {\bf SetMenuBar}.
-Note that it is not possible to call this function twice for the same frame object.
+Note that on some platforms, it is not possible to call this function twice for the same frame object.
\wxheading{See also}
Don't confuse this macro with \helpref{\_()}{underscore}!
-\membersection{\_}\label{underscore}
-
\section{Dialog functions}\label{dialogfunctions}
Below are a number of convenience functions for getting input from the
\wxheading{See also}
-\helpref{wxIdleEvent::SetMode}{wxidlesetmode}
+\helpref{wxIdleEvent::SetMode}{wxidleeventsetmode}
\membersection{wxIdleEvent::GetMode}\label{wxidleeventgetmode}
More advanced or rarely used GUI classes:
\begin{itemize}
-\item{ \helpref{wxBufferedDC}{wxbuffereddc} }
+\item{ wxBufferedDC }
\item{ \helpref{wxCalendarCtrl}{wxcalendarctrl} }
\item{ \helpref{wxDragImage}{wxdragimage} }
\item{ \helpref{wxGrid classes}{gridoverview} }
\item{ \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} }
\item{ \helpref{wxSplashScreen}{wxsplashscreen} }
\item{ \helpref{wxTaskBarIcon}{wxtaskbaricon} }
-\item{ \helpref{wxTipDialog}{wxtipdialog} }
+\item{ wxTipDialog }
\item{ \helpref{wxWave}{wxwave} }
\item{ \helpref{wxWizard}{wxwizard} }
\item{ \helpref{wxSashLayoutWindow}{wxsashlayoutwindow} }
\helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines
\helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}.
Requires wxODBC and wxAdvanced.
+
{\tt wxITEM\_CHECK} or {\tt wxITEM\_RADIO}}
\docparam{helpString}{An optional help string associated with the item.
-By default, \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays
+By default, the handler for the wxEVT\_MENU\_HIGHLIGHT event displays
this string in the status line.}
\docparam{menuItem}{A menuitem object. It will be owned by the wxMenu object after this function
these do not include menu command events, which are
handled using \helpref{wxCommandEvent}{wxcommandevent} objects.
-The handler \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help
+The default handler for wxEVT\_MENU\_HIGHLIGHT displays help
text in the first field of the status bar.
\wxheading{Derived from}
\arg{mirror} specifies if we do mirror (if it is \true) or not (if it is
\false).
-
single-threaded programs or in combination with some thread synchronization
mechanisms.
-wxRecursionGuard is always used together with
+wxRecursionGuard is always used together with the
\helpref{wxRecursionGuardFlag}{wxrecursionguardflag} like in this example:
\begin{verbatim}
void Foo()
As you can see, wxRecursionGuard simply tests the flag value and sets it to
true if it hadn't been already set.
-\helpref{IsInside()}{wxrecursionguardisinside} allows to test the old flag
+\helpref{IsInside()}{wxrecursionguardisinside} allows testing the old flag
value. The advantage of using this class compared to directly manipulating the
flag is that the flag is always reset in the wxRecursionGuard destructor and so
you don't risk to forget to do it even if the function returns in an unexpected
\section{\class{wxRendererNative}}\label{wxrenderernative}
-First, a brief introduction into what is wxRenderer and why is it needed.
+First, a brief introduction to wxRenderer and why it is needed.
Usually wxWindows 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.
case wxWindows provides a default, generic, implementation of them written in
wxWindows itself.
-These controls however don't have the native appearance if only the standard
-line drawing and other graphics primitives are used if only because the native
+These controls don't have the native appearance if only the standard
+line drawing and other graphics primitives are used, because the native
appearance is different under different platforms while the lines are always
drawn in the same way.
This is why we have renderers: wxRenderer is a class which virtualizes the
-drawing, i.e. it abstracts the drawing operations and allows you to draw a,
-say, button, without caring about how exactly this is done. Of course, as we
+drawing, i.e. it abstracts the drawing operations and allows you to draw say, a
+button, without caring about exactly how this is done. Of course, as we
can draw the button differently in different renderers, this also allows us to
emulate the native look and feel.
-
-So the renderers work by exposing a big set of high-level drawing functions
+So the renderers work by exposing a large set of high-level drawing functions
which are used by the generic controls. There is always a default global
renderer but it may be changed or extended by the user, see
\helpref{Render sample}{samplerender}.
All drawing functions take some standard parameters:
\begin{itemize}
- \item \arg{win} is the window being drawn. it is normally not used and when
+ \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
+ \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
- neither: the rendering functions should always prepare it.
- \item \arg{rect} the bounding rectangle for the element to be drawn
+ 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
+ combination of the \texttt{wxCONTROL\_XXX} constants below.
\end{itemize}
\wxheading{Constants}
\true if the sash changes appearance when the mouse passes over it, \false
otherwise.
-
\func{wxThreadError}{Create}{\param{unsigned int }{stackSize = 0}}
Creates a new thread. The thread object is created in the suspended state, and you
-should call \helpref{GetThread()->Run()}{wxthreadhelperthreadrun} to start running
+should call \helpref{GetThread()->Run()}{wxthreadrun} to start running
it. You may optionally specify the stack size to be allocated to it (Ignored on
platforms that don't support setting it explicitly, eg. Unix).
This is a public function that returns the \helpref{wxThread}{wxthread} object
associated with the thread.
+
The wxThreadHelperThread class is used internally by the
\helpref{wxThreadHelper}{wxthreadhelper} mix-in class. This class simply
-turns around and calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry}
-in its owner class when the thread runs.
+calls \helpref{wxThreadHelper::Entry}{wxthreadhelperentry} in its owner class
+when the thread runs.
\wxheading{Derived from}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadctor}
+\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadhelperthreadctor}
\func{}{wxThreadHelperThread}{\void}
This function is called by wxWindows itself and should never be called
directly.
+
\helpref{SelectAll}{wxvlistboxselectall}, \helpref{Select}{wxvlistboxselect}
+\membersection{wxVListBox::SetItemCount}\label{wxvlistboxsetitemcount}
\func{void}{SetItemCount}{\param{size\_t }{count}}
under Windows and automatically under GTK.
Note that setting the background colour does not cause an immediate refresh, so you
-may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
+may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
calling this function.
-Use this function with care under GTK as the new appearance of the window might
-not look equally well when used with "Themes", i.e GTK's ability to change its
+Use this function with care under GTK+ as the new appearance of the window might
+not look equally well when used with "Themes", i.e GTK+'s ability to change its
look as the user wishes with run-time loadable modules.
\wxheading{See also}
\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp
\helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp
\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp
-\helpref{wxWindow::Clear}{wxwindowclear},\rtfsp
+\helpref{wxWindow::ClearBackground}{wxwindowclearbackground},\rtfsp
\helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp
\helpref{wxEraseEvent}{wxeraseevent}
[OPTIONS]
-BMROOT=c:\wx24\wxwind~1\docs/latex/wx ; Assume that bitmaps are where the source is
+BMROOT=c:\wx2dev\wxWind~1\docs/latex/wx ; Assume that bitmaps are where the source is
TITLE=wxWindows Manual
CONTENTS=Contents
COMPRESS=HIGH
projects / wxWidgets.git / commitdiff
