X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c4f71cc3d63fb7bdfbd6cec3e39c8a8679f3e60..3201a1046ba71ba8e5ef2ed694fde34d12f743f3:/interface/listbox.h?ds=sidebyside diff --git a/interface/listbox.h b/interface/listbox.h index 385b800071..eaf1d8e1a4 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -20,75 +20,60 @@ List box elements are numbered from zero. Their number may be limited under some platforms. - A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for single - clicks, and - wxEVT_COMMAND_LISTBOX_DOUBLE_CLICKED for double clicks. + A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for + single clicks, and wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks. @beginStyleTable - @style{wxLB_SINGLE}: + @style{wxLB_SINGLE} Single-selection list. - @style{wxLB_MULTIPLE}: + @style{wxLB_MULTIPLE} Multiple-selection list: the user can toggle multiple items on and off. - @style{wxLB_EXTENDED}: + @style{wxLB_EXTENDED} Extended-selection list: the user can select multiple items using the SHIFT key and the mouse or special key combinations. - @style{wxLB_HSCROLL}: + @style{wxLB_HSCROLL} Create horizontal scrollbar if contents are too wide (Windows only). - @style{wxLB_ALWAYS_SB}: + @style{wxLB_ALWAYS_SB} Always show a vertical scrollbar. - @style{wxLB_NEEDED_SB}: + @style{wxLB_NEEDED_SB} Only create a vertical scrollbar if needed. - @style{wxLB_SORT}: + @style{wxLB_SORT} The listbox contents are sorted in alphabetical order. @endStyleTable - @beginEventTable - @event{EVT_LISTBOX(id, func)}: + @beginEventTable{wxCommandEvent} + @event{EVT_LISTBOX(id, func)} Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list is selected or the selection changes. - @event{EVT_LISTBOX_DCLICK(id, func)}: - Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the + @event{EVT_LISTBOX_DCLICK(id, func)} + Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox is double-clicked. @endEventTable @library{wxcore} @category{ctrl} - @appearance{listbox.png} + @see wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ class wxListBox : public wxControlWithItems { public: - //@{ /** - Constructor, creating and showing a list box. + Default constructor. + */ + wxListBox(); + + /** + Constructor - @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 n Number of strings with which to initialise the control. - @param choices - An array of strings with which to initialise the control. @param style Window style. See wxListBox. - @param validator - Window validator. - @param name - Window name. - - @see Create(), wxValidator */ - wxListBox(); + wxListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -97,6 +82,16 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); + + /** + Constructor + + @param choices + An array of strings with which to initialise the control. + @param style + Window style. See wxListBox. + */ + wxListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos, const wxSize& size, @@ -104,7 +99,6 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); - //@} /** Destructor, destroying the list box. @@ -150,7 +144,7 @@ public: A reference to an wxArrayInt instance that is used to store the result of the query. - @returns The number of selections. + @return The number of selections. @remarks Use this with a multiple selection listbox. @@ -163,19 +157,18 @@ public: Returns the item located at @e point, or @c wxNOT_FOUND if there is no item located at @e point. - @wxsince{2.7.0}. It is currently implemented - for wxMSW, wxMac and wxGTK2 - ports. + It is currently implemented for wxMSW, wxMac and wxGTK2 ports. @param point Point of item (in client coordinates) to obtain - @returns Item located at point, or wxNOT_FOUND if unimplemented or the + @return Item located at point, or wxNOT_FOUND if unimplemented or the item does not exist. + + @since 2.7.0 */ int HitTest(const wxPoint point) const; - //@{ /** Insert the given number of strings before the specified position. @@ -184,15 +177,23 @@ public: @param items Labels of items to be inserted @param pos - Position before which to insert the items: for example, if pos is 0 the - items - will be inserted in the beginning of the listbox + Position before which to insert the items: if pos is 0 the + items will be inserted in the beginning of the listbox */ - void InsertItems(int nItems, const wxString items, + void InsertItems(int nItems, const wxString *items, unsigned int pos); - void InsertItems(const wxArrayString& nItems, + + /** + Insert the given number of strings before the specified position. + + @param items + Labels of items to be inserted + @param pos + Position before which to insert the items: if pos is 0 the + items will be inserted in the beginning of the listbox + */ + void InsertItems(const wxArrayString& items, unsigned int pos); - //@} /** Determines whether an item is selected. @@ -200,11 +201,10 @@ public: @param n The zero-based item index. - @returns @true if the given item is selected, @false otherwise. + @return @true if the given item is selected, @false otherwise. */ bool IsSelected(int n) const; - //@{ /** Clears the list box and adds the given strings to it. @@ -214,26 +214,36 @@ public: An array of strings to set. @param clientData Options array of client data pointers + */ + void Set(int n, const wxString* choices, void **clientData = NULL); - @remarks You may free the array from the calling program after this - function has been called. + /** + Clears the list box and adds the given strings to it. You may + free the array from the calling program after this method + has been called. + + @param choices + An array of strings to set. + @param clientData + Options array of client data pointers */ - void Set(int n, const wxString* choices, void clientData = NULL); void Set(const wxArrayString& choices, - void clientData = NULL); - //@} + void **clientData = NULL); - //@{ /** Set the specified item to be the first visible item. @param n - The zero-based item index. + The zero-based item index that should be visible. + */ + void SetFirstItem(int n); + + /** + Set the specified item to be the first visible item. + @param string The string that should be visible. */ - void SetFirstItem(int n); void SetFirstItem(const wxString& string); - //@} };