fixed syntax errors (incorrect use of _)

[wxWidgets.git] / docs / latex / wx / htmllbox.tex

diff --git a/docs/latex/wx/htmllbox.tex b/docs/latex/wx/htmllbox.tex
index 63729f58564f41a3266f4b98c505868b41f9696c..08500a998b9e32b7591b40f51994271c475b2c46 100644 (file)
--- a/docs/latex/wx/htmllbox.tex
+++ b/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}
 
@@ -31,7 +36,7 @@ example) but you will only need to override a single
 
 \membersection{wxHtmlListBox::wxHtmlListBox}\label{wxhtmllistboxwxhtmllistbox}
 
-\func{}{wxHtmlListBox}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize}, \param{size\_t }{countItems = 0}, \param{long }{style = 0}, \param{const wxString\& }{name = wxVListBoxNameStr}}
+\func{}{wxHtmlListBox}{\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}}
 
 Normal constructor which calls \helpref{Create()}{wxhtmllistboxcreate}
 internally.
@@ -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
@@ -63,15 +68,28 @@ wxListBox styles can not be used here.
 Returns {\tt true} on success or {\tt false} if the control couldn't be created
 
 
+\membersection{wxHtmlListBox::GetFileSystem}\label{wxhtmllistboxgetfilesystem}
+
+\func{wxFileSystem\&}{GetFileSystem}{\void}
+
+\constfunc{const wxFileSystem\&}{GetFileSystem}{\void}
+
+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
+\helpref{wxFileSystem::ChangePathTo}{wxfilesystemchangepathto} if you use
+relative paths for the images or other resources embedded in your HTML.
+
+
 \membersection{wxHtmlListBox::GetSelectedTextBgColour}\label{wxhtmllistboxgetselectedtextbgcolour}
 
 \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.
@@ -114,3 +132,18 @@ for the given item.
 This function may be overridden to decorate HTML returned by
 \helpref{OnGetItem()}{wxhtmllistboxongetitem}.
 
+\membersection{wxHtmlListBox::OnLinkClicked}\label{wxhtmlistboxonlinkclicked}
+
+\func{virtual void}{OnLinkClicked}{\param{size\_t }{n}, \param{const wxHtmlLinkInfo\& }{link}}
+
+Called when the user clicks on hypertext link. Does nothing by default.
+
+\wxheading{Parameters}
+
+\docparam{n}{Index of the item containing the link.}
+
+\docparam{link}{Description of the link.}
+
+\wxheading{See also}
+
+See also \helpref{wxHtmlLinkInfo}{wxhtmllinkinfo}.