Finished initial review of [ca*-ch*] interface headers.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53019 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-04-05 09:12:23 +00:00
parent 3ccd1b4987
commit bfac616654
7 changed files with 184 additions and 122 deletions

View File

@@ -10,10 +10,11 @@
@class wxCheckListBox
@wxheader{checklst.h}
A checklistbox is like a listbox, but allows items to be checked or unchecked.
A wxCheckListBox is like a wxListBox, but allows items to be checked or
unchecked.
When using this class under Windows wxWidgets must be compiled with
USE_OWNER_DRAWN set to 1.
wxUSE_OWNER_DRAWN set to 1.
Only the new functions for this class are documented; see also wxListBox.
@@ -28,13 +29,18 @@
@library{wxcore}
@category{ctrl}
@appearance{checklistbox.png}
<!-- @appearance{checklistbox.png} -->
@see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent
*/
class wxCheckListBox : public wxListBox
{
public:
/**
Default constructor.
*/
wxCheckListBox();
//@{
/**
Constructor, creating and showing a list box.
@@ -46,8 +52,7 @@ public:
@param pos
Window position.
@param size
Window size. If wxDefaultSize is specified then the window is
sized
Window size. If wxDefaultSize is specified then the window is sized
appropriately.
@param n
Number of strings with which to initialise the control.
@@ -60,7 +65,6 @@ public:
@param name
Window name.
*/
wxCheckListBox();
wxCheckListBox(wxWindow* parent, wxWindowID id,
const wxPoint& pos = wxDefaultPosition,
const wxSize& size = wxDefaultSize,
@@ -84,8 +88,8 @@ public:
~wxCheckListBox();
/**
Checks the given item. Note that calling this method doesn't result in
wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
Checks the given item. Note that calling this method does not result in
a wxEVT_COMMAND_CHECKLISTBOX_TOGGLE event being emitted.
@param item
Index of item to check.
@@ -93,5 +97,13 @@ public:
@true if the item is to be checked, @false otherwise.
*/
void Check(int item, bool check = true);
/**
Returns @true if the given item is checked, @false otherwise.
@param item
Index of item whose check status is to be returned.
*/
bool IsChecked(unsigned int item) const;
};