X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..2839804c3530db6756d2eb4a081a442ad8b2f773:/interface/wx/choice.h?ds=sidebyside diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 4a6211a5d9..0d00b7db2d 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -18,7 +18,7 @@ Sorts the entries alphabetically. @endStyleTable - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_CHOICE(id, func)} Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the list is selected. @@ -26,7 +26,7 @@ @library{wxcore} @category{ctrl} - + @appearance{choice.png} @see wxListBox, wxComboBox, wxCommandEvent */ @@ -50,9 +50,10 @@ public: Window identifier. The value wxID_ANY indicates a default value. @param pos Window position. + If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. If wxDefaultSize is specified then the choice is sized - appropriately. + Window size. + If ::wxDefaultSize is specified then the choice is sized appropriately. @param n Number of strings with which to initialise the choice control. @param choices @@ -73,53 +74,85 @@ public: @endWxPythonOnly */ - wxChoice(wxWindow* parent, wxWindowID id, - const wxPoint& pos, - const wxSize& size, int n, - const wxString choices[], - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "choice"); - wxChoice(wxWindow* parent, wxWindowID id, - const wxPoint& pos, - const wxSize& size, - const wxArrayString& choices, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "choice"); + wxChoice( wxWindow *parent, wxWindowID id, + 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 = wxChoiceNameStr ); + + /** + Constructor, creating and showing a choice. + + @param parent + Parent window. Must not be @NULL. + @param id + Window identifier. The value wxID_ANY indicates a default value. + @param pos + Window position. + @param size + Window size. If wxDefaultSize is specified then the choice is sized + appropriately. + @param choices + An array of strings with which to initialise the choice control. + @param style + Window style. See wxChoice. + @param validator + Window validator. + @param name + Window name. + + @see Create(), wxValidator + + @beginWxPythonOnly + + The wxChoice constructor in wxPython reduces the @a n and @a choices + arguments to a single argument, which is a list of strings. + + @endWxPythonOnly + */ + wxChoice( wxWindow *parent, wxWindowID id, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxChoiceNameStr ); //@} /** Destructor, destroying the choice item. */ - ~wxChoice(); + virtual ~wxChoice(); //@{ /** Creates the choice for two-step construction. See wxChoice(). */ - bool Create(wxWindow* parent, wxWindowID id, const wxPoint& pos, - const wxSize& size, int n, - const wxString choices[], - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "choice"); - bool Create(wxWindow* parent, wxWindowID id, - const wxPoint& pos, - const wxSize& size, - const wxArrayString& choices, - long style = 0, - const wxValidator& validator = wxDefaultValidator, - const wxString& name = "choice"); + bool Create( wxWindow *parent, wxWindowID id, + 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 = wxChoiceNameStr ); + bool Create( wxWindow *parent, wxWindowID id, + const wxPoint& pos, + const wxSize& size, + const wxArrayString& choices, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxChoiceNameStr ); //@} /** Gets the number of columns in this choice item. - @remarks This is implemented for GTK and Motif only and always + @remarks This is implemented for GTK and Motif only and always returns 1 for the other platforms. */ - int GetColumns() const; + virtual int GetColumns() const; /** Unlike wxControlWithItems::GetSelection() which only returns the @@ -133,7 +166,7 @@ public: In older versions, wxControlWithItems::GetSelection() itself behaved like this. */ - int GetCurrentSelection() const; + virtual int GetCurrentSelection() const; /** Sets the number of columns in this choice item. @@ -141,9 +174,9 @@ public: @param n Number of columns. - @remarks This is implemented for GTK and Motif only and doesn’t do + @remarks This is implemented for GTK and Motif only and doesn’t do anything under other platforms. */ - void SetColumns(int n = 1); + virtual void SetColumns(int n = 1); };