X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..628e155d8c70da0f962289cf1e1dea3699255707:/interface/listbox.h diff --git a/interface/listbox.h b/interface/listbox.h index 7c1ab8e1d4..69602ffb64 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: listbox.h -// Purpose: documentation for wxListBox class +// Purpose: interface of wxListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,7 +22,7 @@ A listbox callback gets an event wxEVT_COMMAND_LISTBOX_SELECTED for single clicks, and - wxEVT_COMMAND_LISTBOX_DOUBLE_CLICKED for double clicks. + wxEVT_COMMAND_LISTBOX_DOUBLECLICKED for double clicks. @beginStyleTable @style{wxLB_SINGLE}: @@ -44,11 +44,11 @@ @endStyleTable @beginEventTable - @event{EVT_LISTBOX(id\, func)}: + @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 @@ -56,8 +56,7 @@ @category{ctrl} @appearance{listbox.png} - @seealso - wxChoice, wxComboBox, wxListCtrl, wxCommandEvent + @see wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ class wxListBox : public wxControlWithItems { @@ -65,43 +64,36 @@ public: //@{ /** Constructor, creating and showing a list box. - + @param parent - Parent window. Must not be @NULL. - + Parent window. Must not be @NULL. @param id - Window identifier. The value wxID_ANY indicates a default value. - + Window identifier. The value wxID_ANY indicates a default value. @param pos - Window position. - + Window position. @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. - + Number of strings with which to initialise the control. @param choices - An array of strings with which to initialise the control. - + An array of strings with which to initialise the control. @param style - Window style. See wxListBox. - + Window style. See wxListBox. @param validator - Window validator. - + Window validator. @param name - Window name. - - @sa Create(), wxValidator + Window name. + + @see Create(), wxValidator */ wxListBox(); wxListBox(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, int n = 0, - const wxString choices[] = @NULL, + const wxString choices[] = NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); @@ -128,7 +120,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, int n, - const wxString choices[] = @NULL, + const wxString choices[] = NULL, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = "listBox"); @@ -143,59 +135,58 @@ public: /** Deselects an item in the list box. - + @param n - The zero-based item to deselect. - + The zero-based item to deselect. + @remarks This applies to multiple selection listboxes only. */ void Deselect(int n); /** Fill an array of ints with the positions of the currently selected items. - + @param selections - A reference to an wxArrayInt instance that is used to store the result of the - query. - + A reference to an wxArrayInt instance that is used to store the result of + the query. + @returns The number of selections. - + @remarks Use this with a multiple selection listbox. - - @sa wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection, - wxControlWithItems::SetSelection + + @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection, + wxControlWithItems::SetSelection */ - int GetSelections(wxArrayInt& selections); + int GetSelections(wxArrayInt& selections) const; /** Returns the item located at @e point, or @c wxNOT_FOUND if there is no item located at @e point. - - This function is new since wxWidgets version 2.7.0. It is currently implemented + + @wxsince{2.7.0}. It is currently implemented for wxMSW, wxMac and wxGTK2 ports. - + @param point - Point of item (in client coordinates) to obtain - + Point of item (in client coordinates) to obtain + @returns Item located at point, or wxNOT_FOUND if unimplemented or the - item does not exist. + item does not exist. */ - int HitTest(const wxPoint point); + int HitTest(const wxPoint point) const; //@{ /** Insert the given number of strings before the specified position. - + @param nItems - Number of items in the array items - + Number of items in the array items @param items - Labels of items to be inserted - + 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: for example, if pos is 0 the + items + will be inserted in the beginning of the listbox */ void InsertItems(int nItems, const wxString items, unsigned int pos); @@ -205,46 +196,44 @@ public: /** Determines whether an item is selected. - + @param n - The zero-based item index. - + The zero-based item index. + @returns @true if the given item is selected, @false otherwise. */ - bool IsSelected(int n); + bool IsSelected(int n) const; //@{ /** Clears the list box and adds the given strings to it. - + @param n - The number of strings to set. - + The number of strings to set. @param choices - An array of strings to set. - + An array of strings to set. @param clientData - Options array of client data pointers - + Options array of client data pointers + @remarks You may free the array from the calling program after this - function has been called. + function has been called. */ - void Set(int n, const wxString* choices, void clientData = @NULL); + 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. @param string - The string that should be visible. + The string that should be visible. */ void SetFirstItem(int n); void SetFirstItem(const wxString& string); //@} }; +