X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/551266a969c28562e73c96941f2c7d83fa3eb282..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/vlbox.h?ds=sidebyside diff --git a/interface/wx/vlbox.h b/interface/wx/vlbox.h index 2a9ddd9926..5f965c9706 100644 --- a/interface/wx/vlbox.h +++ b/interface/wx/vlbox.h @@ -2,8 +2,7 @@ // Name: vlbox.h // Purpose: interface of wxVListBox // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -30,7 +29,6 @@ @library{wxcore} @category{ctrl} - @appearance{vlistbox.png} @see wxSimpleHtmlListBox, wxHtmlListBox */ @@ -191,38 +189,7 @@ public: bool IsSelected(size_t item) const; /** - This method is used to draw the items background and, maybe, a border - around it. - - The base class version implements a reasonable default behaviour which - consists in drawing the selected item with the standard background - colour and drawing a border around the item if it is either selected or - current. - - @todo Change this function signature to non-const. - */ - virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const; - - /** - This method may be used to draw separators between the lines. The - rectangle passed to it may be modified, typically to deflate it a bit - before passing to OnDrawItem(). - - The base class version of this method doesn't do anything. - - @param dc - The device context to use for drawing. - @param rect - The bounding rectangle for the item. - @param n - The index of the item. - - @todo Change this function signature to non-const. - */ - virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const; - - /** - Selects or deselects the specified item which must be valid (i.e. not + Selects or deselects the specified item which must be valid (i.e.\ not equal to @c wxNOT_FOUND). @return @true if the items selection status has changed or @false @@ -302,7 +269,7 @@ public: void SetSelectionBackground(const wxColour& col); /** - Toggles the state of the specified @a item, i.e. selects it if it was + Toggles the state of the specified @a item, i.e.\ selects it if it was unselected and deselects it if it was selected. This method is only valid for multi selection listboxes. @@ -327,12 +294,43 @@ protected: @todo Change this function signature to non-const. */ - virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const; + virtual void OnDrawItem(wxDC& dc, const wxRect& rect, size_t n) const = 0; + + /** + This method is used to draw the item's background and, maybe, a border + around it. + + The base class version implements a reasonable default behaviour which + consists in drawing the selected item with the standard background + colour and drawing a border around the item if it is either selected or + current. + + @todo Change this function signature to non-const. + */ + virtual void OnDrawBackground(wxDC& dc, const wxRect& rect, size_t n) const; + + /** + This method may be used to draw separators between the lines. The + rectangle passed to it may be modified, typically to deflate it a bit + before passing to OnDrawItem(). + + The base class version of this method doesn't do anything. + + @param dc + The device context to use for drawing. + @param rect + The bounding rectangle for the item. + @param n + The index of the item. + + @todo Change this function signature to non-const. + */ + virtual void OnDrawSeparator(wxDC& dc, wxRect& rect, size_t n) const; /** The derived class must implement this method to return the height of the specified item (in pixels). */ - virtual wxCoord OnMeasureItem(size_t n) const; + virtual wxCoord OnMeasureItem(size_t n) const = 0; };