X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..e1db4c1290af151b0d85c4dcad7cbb2414e0d474:/interface/wx/checklst.h diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index 041dafc369..4e17472566 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -3,7 +3,7 @@ // Purpose: interface of wxCheckListBox // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -15,20 +15,18 @@ When using this class under Windows wxWidgets must be compiled with wxUSE_OWNER_DRAWN set to 1. - Only the new functions for this class are documented; see also wxListBox. - - Please note that wxCheckListBox uses client data in its implementation, - and therefore this is not available to the application. - - @beginEventTable{wxCommandEvent} + @beginEventEmissionTable{wxCommandEvent} @event{EVT_CHECKLISTBOX(id, func)} - Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in - the check list box is checked or unchecked. + Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED 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() + instead. @endEventTable @library{wxcore} @category{ctrl} - + @appearance{checklistbox.png} @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ @@ -50,9 +48,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 @@ -63,15 +62,44 @@ public: Window validator. @param name Window name. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxCheckListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - int n, + int n = 0, const wxString choices[] = NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); + /** + Constructor, creating and showing a list box. + + @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 window is sized + appropriately. + @param choices + An array of strings with which to initialise the control. + @param style + Window style. See wxCheckListBox. + @param validator + 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, const wxSize& size, @@ -81,21 +109,40 @@ 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. */ - ~wxCheckListBox(); + virtual ~wxCheckListBox(); /** Checks the given item. Note that calling this method does not result in - a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted. + a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted. @param item Index of item to check. @param check @true if the item is to be checked, @false otherwise. */ - void Check(int item, bool check = true); + void Check(unsigned int item, bool check = true); /** Returns @true if the given item is checked, @false otherwise. @@ -104,5 +151,6 @@ public: Index of item whose check status is to be returned. */ bool IsChecked(unsigned int item) const; + };