/////////////////////////////////////////////////////////////////////////////
// Name: odcombo.h
-// Purpose: documentation for wxOwnerDrawnComboBox class
+// Purpose: interface of wxOwnerDrawnComboBox
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@category{ctrl}
@appearance{ownerdrawncombobox.png}
- @seealso
- wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent
+ @see wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent
*/
class wxOwnerDrawnComboBox : public wxComboCtrl
{
//@{
/**
Constructor, creating and showing a owner-drawn combobox.
-
+
@param parent
Parent window. Must not be @NULL.
@param id
Window validator.
@param name
Window name.
-
+
@see Create(), wxValidator
*/
wxOwnerDrawnComboBox();
/**
Returns index to the widest item in the list.
*/
- int GetWidestItem();
+ int GetWidestItem() const;
/**
Returns width of the widest item in the list.
*/
- int GetWidestItemWidth();
+ int GetWidestItemWidth() 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.
-
+
@remarks flags has the same meaning as with OnDrawItem.
*/
void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
- int flags);
+ int flags) const;
/**
The derived class may implement this function to actually draw the item
with the given index on the provided DC. If function is not implemented,
the item text is simply drawn, as if the control was a normal combobox.
-
+
@param dc
The device context to use for drawing
@param rect
Combines any of the following flag values:
*/
void OnDrawItem(wxDC& dc, const wxRect& rect, int item,
- int flags);
+ int flags) const;
/**
The derived class may implement this method to return the height of the
The default implementation returns text height, as if this control was
a normal combobox.
*/
- wxCoord OnMeasureItem(size_t item);
+ wxCoord OnMeasureItem(size_t item) const;
/**
The derived class may implement this method to return the width of the
is used.
The default implementation returns -1.
*/
- wxCoord OnMeasureItemWidth(size_t item);
+ wxCoord OnMeasureItemWidth(size_t item) const;
};
+