/////////////////////////////////////////////////////////////////////////////
// Name: htmllbox.h
-// Purpose: documentation for wxHtmlListBox class
+// Purpose: interface of wxHtmlListBox
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxhtml}
@category{ctrl}
- @appearance{htmllistbox.png}
+ <!-- @appearance{htmllistbox.png} -->
- @seealso
- wxSimpleHtmlListBox
+ @see wxSimpleHtmlListBox
*/
class wxHtmlListBox : public wxVListBox
{
Creates the control and optionally sets the initial number of items in it
(it may also be set or changed later with
wxVListBox::SetItemCount).
-
There are no special styles defined for wxHtmlListBox, in particular the
wxListBox styles (with the exception of @c wxLB_MULTIPLE) can not be used here.
-
Returns @true on success or @false if the control couldn't be created
*/
bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,
wxFileSystem::ChangePathTo if you use
relative paths for the images or other resources embedded in your HTML.
*/
- wxFileSystem GetFileSystem();
- const wxFileSystem GetFileSystem();
+ wxFileSystem GetFileSystem() const;
+ const wxFileSystem GetFileSystem() const;
//@}
/**
This virtual function may be overridden to change the appearance of the
background of the selected cells in the same way as
GetSelectedTextColour().
-
It should be rarely, if ever, used because
wxVListBox::SetSelectionBackground allows to
change the selection background for all cells at once and doing anything more
fancy is probably going to look strangely.
-
- @sa GetSelectedTextColour()
+
+ @see GetSelectedTextColour()
*/
- wxColour GetSelectedTextBgColour(const wxColour& colBg);
+ wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
/**
This virtual function may be overridden to customize the appearance of the
- selected cells. It is used to determine how the colour @e colFg is going to
+ selected cells. It is used to determine how the colour @a 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.
-
- @sa GetSelectedTextBgColour(),
- wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
+
+ @see GetSelectedTextBgColour(),
+ wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
*/
- wxColour GetSelectedTextColour(const wxColour& colFg);
+ wxColour GetSelectedTextColour(const wxColour& colFg) const;
/**
This method must be implemented in the derived class and should return
the body (i.e. without @c html nor @c body tags) of the HTML fragment
for the given item.
-
- Note that this function should always return a text fragment for the @e n item
+ Note that this function should always return a text fragment for the @a n item
which renders with the same height both when it is selected and when it's not:
i.e. if you call, inside your OnGetItem() implementation, @c IsSelected(n) to
make the items appear differently when they are selected, then you should make
that the returned HTML fragment will render with the same height or else you'll
see some artifacts when the user selects an item.
*/
- wxString OnGetItem(size_t n);
+ wxString OnGetItem(size_t n) const;
/**
This function may be overridden to decorate HTML returned by
OnGetItem().
*/
- wxString OnGetItemMarkup(size_t n);
+ wxString OnGetItemMarkup(size_t n) const;
/**
Called when the user clicks on hypertext link. Does nothing by default.
Overloading this method is deprecated; intercept the event instead.
-
+
@param n
- Index of the item containing the link.
-
+ Index of the item containing the link.
@param link
- Description of the link.
-
- @sa See also wxHtmlLinkInfo.
+ Description of the link.
+
+ @see See also wxHtmlLinkInfo.
*/
virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);
};
+
/**
@class wxSimpleHtmlListBox
@wxheader{htmllbox.h}
or @c body tags.
@beginStyleTable
- @style{wxHLB_DEFAULT_STYLE}:
+ @style{wxHLB_DEFAULT_STYLE}
The default style: wxBORDER_SUNKEN
- @style{wxHLB_MULTIPLE}:
+ @style{wxHLB_MULTIPLE}
Multiple-selection list: the user can toggle multiple items on and
off.
@endStyleTable
@library{wxhtml}
@category{ctrl}
- @appearance{simplehtmllistbox.png}
+ <!-- @appearance{simplehtmllistbox.png} -->
- @seealso
- wxSimpleHtmlListBox::Create
+ @see wxSimpleHtmlListBox::Create
*/
class wxSimpleHtmlListBox : public wxHtmlListBox
{
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n = 0,
- const wxString choices[] = @NULL,
+ const wxString choices[] = NULL,
long style = wxHLB_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "simpleHtmlListBox");
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
int n,
- const wxString choices[] = @NULL,
+ const wxString choices[] = NULL,
long style = wxHLB_DEFAULT_STYLE,
const wxValidator& validator = wxDefaultValidator,
const wxString& name = "simpleHtmlListBox");
const wxString& name = "simpleHtmlListBox");
//@}
};
+
projects / wxWidgets.git / blobdiff