X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/aa6ec1d78726fd2f2d9e32dabb6f5a289978af25..7c913512a4c9f36e11e07ea707002fab1608d324:/interface/odcombo.h diff --git a/interface/odcombo.h b/interface/odcombo.h index 233b87e6cf..5ee81f1683 100644 --- a/interface/odcombo.h +++ b/interface/odcombo.h @@ -9,17 +9,17 @@ /** @class wxOwnerDrawnComboBox @wxheader{odcombo.h} - + wxOwnerDrawnComboBox is a combobox with owner-drawn list items. In essence, it is a wxComboCtrl with wxVListBox popup and wxControlWithItems interface. - + Implementing item drawing and measuring is similar to wxVListBox. Application needs to subclass wxOwnerDrawnComboBox and implement wxOwnerDrawnComboBox::OnDrawItem, wxOwnerDrawnComboBox::OnMeasureItem and wxOwnerDrawnComboBox::OnMeasureItemWidth. - + @beginStyleTable @style{wxODCB_DCLICK_CYCLES}: Double-clicking cycles item if wxCB_READONLY is also used. @@ -29,18 +29,18 @@ style is not used, writable wxOwnerDrawnComboBox is never custom painted unless SetCustomPaintWidth is called. @endStyleTable - + @beginEventTable @event{EVT_COMBOBOX(id\, func)}: Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. Note that calling GetValue returns the new value of selection. @endEventTable - + @library{wxadv} @category{ctrl} @appearance{ownerdrawncombobox.png} - + @seealso wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent */ @@ -51,57 +51,57 @@ public: /** Constructor, creating and showing a owner-drawn combobox. - @param parent + @param parent Parent window. Must not be @NULL. - @param id + @param id Window identifier. The value wxID_ANY indicates a default value. - @param value + @param value Initial selection string. An empty string indicates no selection. - @param pos + @param pos Window position. - @param size + @param size Window size. If wxDefaultSize is specified then the window is sized appropriately. - @param n + @param n Number of strings with which to initialise the control. - @param choices + @param choices An array of strings with which to initialise the control. - @param style + @param style Window style. See wxOwnerDrawnComboBox. - @param validator + @param validator Window validator. - @param name + @param name Window name. @sa Create(), wxValidator */ wxOwnerDrawnComboBox(); - wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, - const wxString& value = "", - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, - int n = 0, - const wxString choices[] = @NULL, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); - wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, - const wxString& value, - const wxPoint& pos, - const wxSize& size, - const wxArrayString& choices, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, + const wxString& value = "", + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int n = 0, + const wxString choices[] = @NULL, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = "comboBox"); + wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id, + const wxString& value, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = "comboBox"); //@} /** @@ -124,14 +124,14 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "comboBox"); - bool Create(wxWindow* parent, wxWindowID id, - const wxString& value, - const wxPoint& pos, - const wxSize& size, - const wxArrayString& choices, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + bool Create(wxWindow* parent, wxWindowID id, + const wxString& value, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = "comboBox"); //@} /** @@ -161,17 +161,17 @@ public: 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 + @param dc The device context to use for drawing - @param rect + @param rect The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function) - @param item + @param item The index of the item to be drawn - @param flags + @param flags Combines any of the following flag values: */ void OnDrawItem(wxDC& dc, const wxRect& rect, int item,