X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3051a44a73502c2b03d1618d0a8e94274ee67e16..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/checklst.h?ds=sidebyside diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index 982209412b..315abbce3a 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -2,8 +2,7 @@ // Name: checklst.h // Purpose: interface of wxCheckListBox // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -17,7 +16,7 @@ @beginEventEmissionTable{wxCommandEvent} @event{EVT_CHECKLISTBOX(id, func)} - Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in + Process a @c wxEVT_CHECKLISTBOX event, when an item in the check list box is checked or unchecked. wxCommandEvent::GetInt() will contain the index of the item that was checked or unchecked. wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked() @@ -26,7 +25,7 @@ @library{wxcore} @category{ctrl} - @appearance{checklistbox.png} + @appearance{checklistbox} @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ @@ -48,9 +47,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 window is sized - appropriately. + Window size. + If ::wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. @param choices @@ -61,6 +61,10 @@ public: Window validator. @param name Window name. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, @@ -90,6 +94,10 @@ public: Window validator. @param name Window name. + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos, @@ -100,6 +108,25 @@ public: const wxString& name = "listBox"); //@} + bool Create(wxWindow *parent, + wxWindowID id, + const wxPoint& pos = wxDefaultPosition, + const wxSize& size = wxDefaultSize, + int nStrings = 0, + const wxString choices[] = NULL, + long style = 0, + const wxValidator& validator = wxDefaultValidator, + const wxString& name = wxListBoxNameStr); + + 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 = wxListBoxNameStr); + /** Destructor, destroying the list box. */ @@ -107,7 +134,7 @@ public: /** Checks the given item. Note that calling this method does not result in - a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted. + a @c wxEVT_CHECKLISTBOX event being emitted. @param item Index of item to check. @@ -123,5 +150,19 @@ public: Index of item whose check status is to be returned. */ bool IsChecked(unsigned int item) const; + + /** + Return the indices of the checked items. + + @param checkedItems + A reference to the array that is filled with the indices of the + checked items. + @return The number of checked items. + + @see Check(), IsChecked() + + @since 2.9.5 + */ + unsigned int GetCheckedItems(wxArrayInt& checkedItems) const; };