X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e0c6027b5a0af9050eca56774967437a66241026..ddca12cfd9c965963eb63751252000d03a12d9da:/docs/latex/wx/htmllbox.tex diff --git a/docs/latex/wx/htmllbox.tex b/docs/latex/wx/htmllbox.tex index 9e6875eb17..257611d039 100644 --- a/docs/latex/wx/htmllbox.tex +++ b/docs/latex/wx/htmllbox.tex @@ -31,7 +31,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. @@ -51,7 +51,7 @@ Destructor cleans up whatever resources we use. \membersection{wxHtmlListBox::Create}\label{wxhtmllistboxcreate} -\func{bool}{Create}{\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{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 @@ -63,6 +63,53 @@ 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 +\helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour}. + +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. + +\wxheading{See also} + +\helpref{GetSelectedTextColour}{wxhtmllistboxgetselectedtextcolour} + + +\membersection{wxHtmlListBox::GetSelectedTextColour}\label{wxhtmllistboxgetselectedtextcolour} + +\constfunc{wxColour}{GetSelectedTextColour}{\param{const wxColour\& }{colFg}} + +This virtual function may be overridden to customize the appearance of the +selected cells. It is used to determine how the colour {\it colFg} is going to +look inside selection. By default all original colours are completely ignored +and the standard, system-dependent, selection colour is used but the program +may wish to override this to achieve some custom appearance. + +\wxheading{See also} + +\helpref{GetSelectedTextBgColour}{wxhtmllistboxgetselectedtextbgcolour},\\ +\helpref{SetSelectionBackground}{wxvlistboxsetselectionbackground},\\ +\helpref{wxSystemSettings::GetColour}{wxsystemsettingsgetcolour} + \membersection{wxHtmlListBox::OnGetItem}\label{wxhtmllistboxongetitem} @@ -80,3 +127,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}.