[ 1507795 ] Small doc patch.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39792 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

docs/latex/wx/htmllbox.tex

@@ -14,12 +14,17 @@
 wxHtmlListBox is an implementation of \helpref{wxVListBox}{wxvlistbox} which
 shows HTML content in the listbox rows. This is still an abstract base class
 and you will need to derive your own class from it (see htlbox sample for the
-example) but you will only need to override a single 
+example) but you will only need to override a single
 \helpref{OnGetItem()}{wxhtmllistboxongetitem} function.
 
 \wxheading{Derived from}
 
-\helpref{wxVListBox}{wxvlistbox}
+\helpref{wxVListBox}{wxvlistbox}\\
+\helpref{wxVScrolledWindow}{wxvscrolledwindow}\\
+\helpref{wxPanel}{wxpanel}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
@@ -54,7 +59,7 @@ Destructor cleans up whatever resources we use.
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
 
 Creates the control and optionally sets the initial number of items in it
-(it may also be set or changed later with 
+(it may also be set or changed later with
 \helpref{SetItemCount()}{wxvlistboxsetitemcount}).
 
 There are no special styles defined for wxHtmlListBox, in particular the
@@ -71,7 +76,7 @@ Returns {\tt true} on success or {\tt false} if the control couldn't be created
 
 Returns the \helpref{wxFileSystem}{wxfilesystem} used by the HTML parser of
 this object. The file system object is used to resolve the paths in HTML
-fragments displayed in the control and you should use 
+fragments displayed in the control and you should use
 \helpref{wxFileSystem::ChangePathTo}{wxfilesystemchangepathto} if you use
 relative paths for the images or other resources embedded in your HTML.
 
@@ -81,10 +86,10 @@ relative paths for the images or other resources embedded in your HTML.
 \constfunc{wxColour}{GetSelectedTextBgColour}{\param{const wxColour\& }{colBg}}
 
 This virtual function may be overridden to change the appearance of the
-background of the selected cells in the same way as 
+background of the selected cells in the same way as
 \helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour}.
 
-It should be rarely, if ever, used because 
+It should be rarely, if ever, used because
 \helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground} allows to
 change the selection background for all cells at once and doing anything more
 fancy is probably going to look strangely.

docs/latex/wx/progdlg.tex

@@ -1,3 +1,14 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        progdlg.tex
+%% Purpose:     wxProgressDialog documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:     01.06.03
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \section{\class{wxProgressDialog}}\label{wxprogressdialog}
 
 This class represents a dialog that shows a short message and a
@@ -51,11 +62,11 @@ from screen as soon as the maximum value of the progress meter has been
 reached.}
 \twocolitem{{\bf wxPD\_SMOOTH}}{Causes smooth progress of the gauge control.}
 \twocolitem{{\bf wxPD\_CAN\_ABORT}}{This flag tells the dialog that it should have a
-"Cancel" button which the user may press. If this happens, the next call to 
+"Cancel" button which the user may press. If this happens, the next call to
- \helpref{Update()}{wxprogressdialogupdate} will return false.}
+\helpref{Update()}{wxprogressdialogupdate} will return false.}
 \twocolitem{{\bf wxPD\_CAN\_SKIP}}{This flag tells the dialog that it should have a
-"Skip" button which the user may press. If this happens, the next call to 
+"Skip" button which the user may press. If this happens, the next call to
- \helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
+\helpref{Update()}{wxprogressdialogupdate} will return true in its skip parameter.}
 \twocolitem{{\bf wxPD\_ELAPSED\_TIME}}{This flag tells the dialog that it should show elapsed time (since creating the dialog).}
 \twocolitem{{\bf wxPD\_ESTIMATED\_TIME}}{This flag tells the dialog that it should show estimated time.}
 \twocolitem{{\bf wxPD\_REMAINING\_TIME}}{This flag tells the dialog that it should show remaining time.}
@@ -66,7 +77,7 @@ reached.}
 
 \membersection{wxProgressDialog::\destruct{wxProgressDialog}}\label{wxprogressdialogdtor}
 
-\func{}{\destruct{wxMessageDialog}}{\void}
+\func{}{\destruct{wxProgressDialog}}{\void}
 
 Destructor. Deletes the dialog and enables all top level windows.
 
@@ -99,6 +110,5 @@ equal to the maximum value given to the constructor and the dialog is closed if
 it is equal to the maximum.}
 \docparam{newmsg}{The new messages for the progress dialog text, if it is
 empty (which is the default) the message is not changed.}
-\docparam{skip}{If "Skip" button was pressed since last 
+\docparam{skip}{If "Skip" button was pressed since last
 \helpref{Update}{wxprogressdialogupdate} call the skip is true.}
-

docs/latex/wx/vlbox.tex

@@ -13,9 +13,9 @@
 
 wxVListBox is a listbox-like control with the following two main differences
 from a regular listbox: it can have an arbitrarily huge number of items because
-it doesn't store them itself but uses \helpref{OnDrawItem()}{wxvlistboxondrawitem} 
+it doesn't store them itself but uses \helpref{OnDrawItem()}{wxvlistboxondrawitem}
 callback to draw them (so it is a {\Large V}irtual listbox) and its items can
-have variable height as determined by 
+have variable height as determined by
 \helpref{OnMeasureItem()}{wxvlistboxonmeasureitem} (so it is also a listbox
 with the lines of {\Large V}ariable height).
 
@@ -28,10 +28,14 @@ derive your own class, such as \helpref{wxHtmlListBox}{wxhtmllistbox}, from it.
 
 However it emits the same events as \helpref{wxListBox}{wxlistbox} and the same
 event macros may be used with it.
- 
+
 \wxheading{Derived from}
 
-\helpref{wxVScrolledWindow}{wxvscrolledwindow}
+\helpref{wxVScrolledWindow}{wxvscrolledwindow}\\
+\helpref{wxPanel}{wxpanel}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
@@ -62,11 +66,11 @@ Deletes all items from the control.
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
 
-Creates the control. To finish creating it you also should call 
+Creates the control. To finish creating it you also should call
 \helpref{SetItemCount()}{wxvlistboxsetitemcount} to let it know about the
 number of items it contains.
 
-The only special style which may be used with wxVListBox is {\tt wxLB\_MULTIPLE} 
+The only special style which may be used with wxVListBox is {\tt wxLB\_MULTIPLE}
 which indicates that the listbox should support multiple selection.
 
 Returns {\tt true} on success or {\tt false} if the control couldn't be created
@@ -92,7 +96,7 @@ This method is only valid for multi selection listboxes.
 
 \constfunc{int}{GetFirstSelected}{\param{unsigned long\& }{cookie}}
 
-Returns the index of the first selected item in the listbox or 
+Returns the index of the first selected item in the listbox or
 {\tt wxNOT\_FOUND} if no items are currently selected.
 
 \arg{cookie} is an opaque parameter which should be passed to the subsequent
@@ -170,7 +174,7 @@ may only return $0$ or $1$ however.
 
 \constfunc{int}{GetSelection}{\void}
 
-Get the currently selected item or $-1$ if there is no selection.
+Get the currently selected item or {\tt wxNOT\_FOUND} if there is no selection.
 
 
 \membersection{wxVListBox::GetSelectionBackground}\label{wxvlistboxgetselectionbackground}
@@ -202,7 +206,7 @@ listbox.
 Returns {\tt true} if this item is the current one, {\tt false} otherwise.
 
 Current item is always the same as selected one for the single selection
-listbox and in this case this method is equivalent to 
+listbox and in this case this method is equivalent to
 \helpref{IsSelected}{wxvlistboxisselected} but they are different for multi
 selection listboxes where many items may be selected but only one (at most) is
 current.
@@ -282,7 +286,7 @@ equal to {\tt wxNOT\_FOUND}).
 Return {\tt true} if the items selection status has changed or {\tt false}
 otherwise.
 
-This function is only valid for the multiple selection listboxes, use 
+This function is only valid for the multiple selection listboxes, use
 \helpref{SetSelection}{wxvlistboxsetselection} for the single selection ones.
 
 
@@ -356,7 +360,7 @@ This method may be used both with single and multiple selection listboxes.
 \func{void}{SetSelectionBackground}{\param{const wxColour\& }{col}}
 
 Sets the colour to be used for the selected cells background. The background of
-the standard cells may be changed by simply calling 
+the standard cells may be changed by simply calling
 \helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour}.
 
 \wxheading{See also}
@@ -376,4 +380,3 @@ This method is only valid for multi selection listboxes.
 \wxheading{See also}
 
 \helpref{Select}{wxvlistboxselect}
-

docs/latex/wx/vscroll.tex

@@ -18,20 +18,20 @@ are shown on the screen need to be measured; or, even, "vertical" because
 this class only supports scrolling in one direction currently (this could
 and probably will change in the future however).
 
-In any case, this is a generalization of the 
+In any case, this is a generalization of the
 \helpref{wxScrolledWindow}{wxscrolledwindow} class which can be only used when
 all lines have the same height. It lacks some other wxScrolledWindow features
 however, notably there is currently no support for horizontal scrolling; it
 can't scroll another window nor only a rectangle of the window and not its
 entire client area.
- 
+
-To use this class, you need to derive from it and implement 
+To use this class, you need to derive from it and implement
 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} pure virtual
-method. You also must call \helpref{SetLineCount}{wxvscrolledwindowsetlinecount} 
+method. You also must call \helpref{SetLineCount}{wxvscrolledwindowsetlinecount}
 to let the base class know how many lines it should display but from that
 moment on the scrolling is handled entirely by wxVScrolledWindow, you only
 need to draw the visible part of contents in your {\tt OnPaint()} method as
-usual. You should use \helpref{GetFirstVisibleLine()}{wxvscrolledwindowgetfirstvisibleline} 
+usual. You should use \helpref{GetFirstVisibleLine()}{wxvscrolledwindowgetfirstvisibleline}
 and \helpref{GetLastVisibleLine()}{wxvscrolledwindowgetlastvisibleline} to
 select the lines to display. Note that the device context origin is not shifted
 so the first visible line always appears at the point $(0, 0)$ in physical as
@@ -39,7 +39,10 @@ well as logical coordinates.
 
 \wxheading{Derived from}
 
-\helpref{wxPanel}{wxpanel}
+\helpref{wxPanel}{wxpanel}\\
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
@@ -60,7 +63,7 @@ no need to specify it explicitly.
 
 \func{}{wxVScrolledWindow}{\void}
 
-Default constructor, you must call \helpref{Create()}{wxvscrolledwindowcreate} 
+Default constructor, you must call \helpref{Create()}{wxvscrolledwindowcreate}
 later.
 
 \wxheading{Parameters}
@@ -95,7 +98,7 @@ need to specify it explicitly.
 \constfunc{virtual wxCoord}{EstimateTotalHeight}{\void}
 
 This protected function is used internally by wxVScrolledWindow to estimate the
-total height of the window when \helpref{SetLineCount}{wxvscrolledwindowsetlinecount} 
+total height of the window when \helpref{SetLineCount}{wxvscrolledwindowsetlinecount}
 is called. The default implementation uses the brute force approach if the
 number of the items in the control is small enough. Otherwise, it tries to find
 the average line height using some lines in the beginning, middle and the end.
@@ -125,7 +128,7 @@ exists only for symmetry with \helpref{GetLastVisibleLine}{wxvscrolledwindowgetl
 
 Returns the index of the last currently visible line. Note that this method
 returns \texttt{(size\_t)-1} (i.e. a huge positive number) if the control is
-empty so if this is possible you should use \helpref{GetVisibleEnd}{wxvscrolledwindowgetvisibleend} 
+empty so if this is possible you should use \helpref{GetVisibleEnd}{wxvscrolledwindowgetvisibleend}
 instead.
 
 \wxheading{See also}
@@ -137,7 +140,7 @@ instead.
 
 \constfunc{size\_t}{GetLineCount}{\void}
 
-Get the number of lines this window contains (previously set by 
+Get the number of lines this window contains (previously set by
 \helpref{SetLineCount()}{wxvscrolledwindowsetlinecount})
 
 
@@ -180,7 +183,7 @@ Return the item at the specified (in physical coordinates) position or
 
 \constfunc{bool}{IsVisible}{\param{size\_t }{line}}
 
-Returns {\tt true} if the given line is (at least partially) visible or 
+Returns {\tt true} if the given line is (at least partially) visible or
 {\tt false} otherwise.
 
 
@@ -205,7 +208,7 @@ it if calculating the lines heights is a relatively expensive operation
 as it gives the user code a possibility to calculate several of them at
 once.
 
-{\tt OnGetLinesHint()} is normally called just before 
+{\tt OnGetLinesHint()} is normally called just before
 \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight} but you
 shouldn't rely on the latter being called for all lines in the interval
 specified here. It is also possible that OnGetLineHeight() will be
@@ -296,5 +299,3 @@ Return {\tt true} if we scrolled the window, {\tt false} if nothing was done.
 Set the number of lines the window contains: the derived class must
 provide the heights for all lines with indices up to the one given here
 in its \helpref{OnGetLineHeight()}{wxvscrolledwindowongetlineheight}.
-
-