From 684761db46d96d4a919d8e94edd1e9065978e675 Mon Sep 17 00:00:00 2001 From: Julian Smart Date: Fri, 15 Aug 2003 16:17:40 +0000 Subject: [PATCH] Misc. corrections git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@22915 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/category.tex | 2 +- docs/latex/wx/db.tex | 4 ++-- docs/latex/wx/event.tex | 5 ++--- docs/latex/wx/frame.tex | 4 ++-- docs/latex/wx/function.tex | 2 -- docs/latex/wx/idleevt.tex | 2 +- docs/latex/wx/libs.tex | 5 +++-- docs/latex/wx/menu.tex | 2 +- docs/latex/wx/menuevt.tex | 2 +- docs/latex/wx/mirrordc.tex | 1 - docs/latex/wx/recguard.tex | 4 ++-- docs/latex/wx/renderer.tex | 25 ++++++++++++------------- docs/latex/wx/splitpar.tex | 1 - docs/latex/wx/threadh.tex | 3 ++- docs/latex/wx/threadht.tex | 7 ++++--- docs/latex/wx/vlbox.tex | 1 + docs/latex/wx/window.tex | 8 ++++---- docs/latex/wx/wx.hpj | 2 +- 18 files changed, 39 insertions(+), 41 deletions(-) diff --git a/docs/latex/wx/category.tex b/docs/latex/wx/category.tex index c156003ab2..b39d7f5741 100644 --- a/docs/latex/wx/category.tex +++ b/docs/latex/wx/category.tex @@ -196,7 +196,7 @@ These classes are related to drawing on device contexts and windows. \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}} diff --git a/docs/latex/wx/db.tex b/docs/latex/wx/db.tex index 5adf4694d8..c30477bb89 100644 --- a/docs/latex/wx/db.tex +++ b/docs/latex/wx/db.tex @@ -3946,7 +3946,7 @@ an introduction to using the wxDbGrid classes. \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}} @@ -3998,7 +3998,7 @@ info structure as this is the structure which informs the grid of how you want t \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} diff --git a/docs/latex/wx/event.tex b/docs/latex/wx/event.tex index c48dd65ac5..355c16de70 100644 --- a/docs/latex/wx/event.tex +++ b/docs/latex/wx/event.tex @@ -185,9 +185,9 @@ Called by an event handler to tell the event system that the 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. @@ -195,4 +195,3 @@ Returns the old propagation level value which may be later passed to \helpref{ResumePropagation}{wxeventresumepropagation} to allow propagating the event again. - diff --git a/docs/latex/wx/frame.tex b/docs/latex/wx/frame.tex index 6eeae2fb8b..c42b8db335 100644 --- a/docs/latex/wx/frame.tex +++ b/docs/latex/wx/frame.tex @@ -512,10 +512,10 @@ menu bar and its menus will be destroyed also, so do not delete the menu 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} diff --git a/docs/latex/wx/function.tex b/docs/latex/wx/function.tex index ffd7eb45df..f38ae6abf5 100644 --- a/docs/latex/wx/function.tex +++ b/docs/latex/wx/function.tex @@ -1512,8 +1512,6 @@ same macro which is {\tt \_TEXT()}). 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 diff --git a/docs/latex/wx/idleevt.tex b/docs/latex/wx/idleevt.tex index 329c0b8ef8..db3a82a754 100644 --- a/docs/latex/wx/idleevt.tex +++ b/docs/latex/wx/idleevt.tex @@ -62,7 +62,7 @@ to only send idle events to windows with the wxWS\_EX\_PROCESS\_IDLE extra windo \wxheading{See also} -\helpref{wxIdleEvent::SetMode}{wxidlesetmode} +\helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} \membersection{wxIdleEvent::GetMode}\label{wxidleeventgetmode} diff --git a/docs/latex/wx/libs.tex b/docs/latex/wx/libs.tex index dc13522de5..44c76d0e52 100644 --- a/docs/latex/wx/libs.tex +++ b/docs/latex/wx/libs.tex @@ -59,7 +59,7 @@ applications don't. 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} } @@ -67,7 +67,7 @@ More advanced or rarely used GUI classes: \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} } @@ -100,3 +100,4 @@ contained in this library, as well as \helpref{wxDbGridTableBase}{wxdbgridtablebase} class which combines \helpref{wxGrid}{wxgrid} and \helpref{wxDbTable}{wxdbtable}. Requires wxODBC and wxAdvanced. + diff --git a/docs/latex/wx/menu.tex b/docs/latex/wx/menu.tex index ee6f817488..7f09955c3c 100644 --- a/docs/latex/wx/menu.tex +++ b/docs/latex/wx/menu.tex @@ -134,7 +134,7 @@ such as bitmaps and fonts. {\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 diff --git a/docs/latex/wx/menuevt.tex b/docs/latex/wx/menuevt.tex index 9f9c147393..6b20a2e9c3 100644 --- a/docs/latex/wx/menuevt.tex +++ b/docs/latex/wx/menuevt.tex @@ -4,7 +4,7 @@ This class is used for a variety of menu-related events. Note that 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} diff --git a/docs/latex/wx/mirrordc.tex b/docs/latex/wx/mirrordc.tex index a3ec050edb..d818e7f1da 100644 --- a/docs/latex/wx/mirrordc.tex +++ b/docs/latex/wx/mirrordc.tex @@ -40,4 +40,3 @@ drawn on wxMirrorDC will appear (and maybe mirrored) on \arg{dc}. \arg{mirror} specifies if we do mirror (if it is \true) or not (if it is \false). - diff --git a/docs/latex/wx/recguard.tex b/docs/latex/wx/recguard.tex index f7bdfa0cdf..a02c56b653 100644 --- a/docs/latex/wx/recguard.tex +++ b/docs/latex/wx/recguard.tex @@ -16,7 +16,7 @@ problems in a function. It is not thread-safe and so should be used only in the 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() @@ -35,7 +35,7 @@ wxRecursionGuard is always used together with 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 diff --git a/docs/latex/wx/renderer.tex b/docs/latex/wx/renderer.tex index 9c668b4848..b17c215b32 100644 --- a/docs/latex/wx/renderer.tex +++ b/docs/latex/wx/renderer.tex @@ -11,7 +11,7 @@ \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. @@ -19,38 +19,37 @@ However not all controls exist under all (or even any) platforms and in this 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} diff --git a/docs/latex/wx/splitpar.tex b/docs/latex/wx/splitpar.tex index f82a9f0a27..a401e54604 100644 --- a/docs/latex/wx/splitpar.tex +++ b/docs/latex/wx/splitpar.tex @@ -45,4 +45,3 @@ The width of the border drawn by the splitter inside it, may be $0$. \true if the sash changes appearance when the mouse passes over it, \false otherwise. - diff --git a/docs/latex/wx/threadh.tex b/docs/latex/wx/threadh.tex index 729f51015c..cc34b56e60 100644 --- a/docs/latex/wx/threadh.tex +++ b/docs/latex/wx/threadh.tex @@ -63,7 +63,7 @@ The destructor frees the resources associated with the thread. \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). @@ -98,3 +98,4 @@ directly. This is a public function that returns the \helpref{wxThread}{wxthread} object associated with the thread. + diff --git a/docs/latex/wx/threadht.tex b/docs/latex/wx/threadht.tex index 87987662d8..b3f3da655a 100644 --- a/docs/latex/wx/threadht.tex +++ b/docs/latex/wx/threadht.tex @@ -2,8 +2,8 @@ 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} @@ -19,7 +19,7 @@ in its owner class when the thread runs. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadctor} +\membersection{wxThreadHelperThread::wxThreadHelperThread}\label{wxthreadhelperthreadctor} \func{}{wxThreadHelperThread}{\void} @@ -72,3 +72,4 @@ The returned value is the thread exit code which is the value returned by This function is called by wxWindows itself and should never be called directly. + diff --git a/docs/latex/wx/vlbox.tex b/docs/latex/wx/vlbox.tex index 6e3b7c8a2a..f6a58463d1 100644 --- a/docs/latex/wx/vlbox.tex +++ b/docs/latex/wx/vlbox.tex @@ -317,6 +317,7 @@ This method is only valid for multi selection listboxes. \helpref{SelectAll}{wxvlistboxselectall}, \helpref{Select}{wxvlistboxselect} +\membersection{wxVListBox::SetItemCount}\label{wxvlistboxsetitemcount} \func{void}{SetItemCount}{\param{size\_t }{count}} diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 1cb3132425..39ca272928 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -2112,11 +2112,11 @@ The background colour is usually painted by the default\rtfsp 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} @@ -2124,7 +2124,7 @@ look as the user wishes with run-time loadable modules. \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} diff --git a/docs/latex/wx/wx.hpj b/docs/latex/wx/wx.hpj index 037b040bba..07caa08bae 100644 --- a/docs/latex/wx/wx.hpj +++ b/docs/latex/wx/wx.hpj @@ -1,5 +1,5 @@ [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 -- 2.45.2