X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..b72ed64277a2b16c6c8681995e5f3f304a8fe38d:/interface/wx/bmpcbox.h diff --git a/interface/wx/bmpcbox.h b/interface/wx/bmpcbox.h index 3e7b6d87e1..509ff6b522 100644 --- a/interface/wx/bmpcbox.h +++ b/interface/wx/bmpcbox.h @@ -3,12 +3,11 @@ // Purpose: interface of wxBitmapComboBox // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxBitmapComboBox - @wxheader{bmpcbox.h} A combobox that displays bitmap in front of the list items. It currently only allows using bitmaps of one size, and resizes itself @@ -37,20 +36,20 @@ @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER! - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_COMBOBOX(id, func)} - Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on + Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on the list is selected. @event{EVT_TEXT(id, func)} - Process a wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes. + Process a @c wxEVT_COMMAND_TEXT_UPDATED event, when the combobox text changes. @event{EVT_TEXT_ENTER(id, func)} - Process a wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in + Process a @c wxEVT_COMMAND_TEXT_ENTER event, when RETURN is pressed in the combobox. @endEventTable @library{wxadv} @category{ctrl} - + @appearance{bitmapcombobox.png} @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent */ @@ -71,22 +70,32 @@ public: Window identifier. The value wxID_ANY indicates a default value. @param value Initial selection string. An empty string indicates no selection. + @param pos + Initial position. + @param size + Initial size. @param n Number of strings with which to initialise the control. @param choices An array of strings with which to initialise the control. + @param style + The window style, see wxCB_* flags. + @param validator + Validator which can be used for additional data checks. + @param name + Control name. @see Create(), wxValidator */ - wxBitmapComboBox(wxWindow* parent, wxWindowID id, - const wxString& value = "", + wxBitmapComboBox(wxWindow* parent, wxWindowID id = wxID_ANY, + const wxString& value = wxEmptyString, 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"); + const wxString& name = wxBitmapComboBoxNameStr); /** Constructor, creating and showing a combobox. @@ -97,8 +106,18 @@ public: Window identifier. The value wxID_ANY indicates a default value. @param value Initial selection string. An empty string indicates no selection. + @param pos + Initial position. + @param size + Initial size. @param choices An wxArrayString with which to initialise the control. + @param style + The window style, see wxCB_* flags. + @param validator + Validator which can be used for additional data checks. + @param name + Control name. @see Create(), wxValidator */ @@ -107,9 +126,9 @@ public: const wxPoint& pos, const wxSize& size, const wxArrayString& choices, - long style = 0, + long style, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxBitmapComboBoxNameStr); /** Destructor, destroying the combobox. @@ -140,13 +159,13 @@ public: Creates the combobox for two-step construction. */ bool Create(wxWindow* parent, wxWindowID id, - const wxString& value = "", - const wxPoint& pos = wxDefaultPosition, - const wxSize& size = wxDefaultSize, + const wxString& value, + const wxPoint& pos, + const wxSize& size, int n, const wxString choices[], long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxBitmapComboBoxNameStr); /** Creates the combobox for two-step construction. @@ -158,10 +177,11 @@ public: const wxArrayString& choices, long style = 0, const wxValidator& validator = wxDefaultValidator, - const wxString& name = "comboBox"); + const wxString& name = wxBitmapComboBoxNameStr); /** - Returns size of bitmaps used in the list. + Returns the size of the bitmaps used in the combo box. + If the combo box is empty, then ::wxDefaultSize is returned. */ virtual wxSize GetBitmapSize() const;