X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3051a44a73502c2b03d1618d0a8e94274ee67e16..3fbba098a22ccaf72fbc640482b94146b374c372:/interface/wx/listbox.h?ds=sidebyside diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h index 0877c5b746..a802354f32 100644 --- a/interface/wx/listbox.h +++ b/interface/wx/listbox.h @@ -3,7 +3,7 @@ // Purpose: interface of wxListBox // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -39,6 +39,8 @@ Always show a vertical scrollbar. @style{wxLB_NEEDED_SB} Only create a vertical scrollbar if needed. + @style{wxLB_NO_SB} + Don't create vertical scrollbar (wxMSW only). @style{wxLB_SORT} The listbox contents are sorted in alphabetical order. @endStyleTable @@ -49,10 +51,10 @@ @beginEventEmissionTable{wxCommandEvent} @event{EVT_LISTBOX(id, func)} - Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the + Process a @c 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_LISTBOXDOUBLECLICKED event, when the listbox + Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is double-clicked. @endEventTable @@ -79,9 +81,10 @@ public: The ID of this control. A value of @c wxID_ANY indicates a default value. @param pos The initial position. + If ::wxDefaultPosition is specified then a default position is chosen. @param size The initial size. - If wxDefaultSize is specified then the window is sized appropriately. + If ::wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. @param choices @@ -92,6 +95,10 @@ public: The validator for this control. @param name The name of this class. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ wxListBox(wxWindow* parent, wxWindowID id, @@ -109,6 +116,10 @@ public: See the other wxListBox() constructor; the only difference is that this overload takes a wxArrayString instead of a pointer to an array of wxString. + + @beginWxPerlOnly + Use an array reference for the @a choices parameter. + @endWxPerlOnly */ wxListBox(wxWindow* parent, wxWindowID id, @@ -166,6 +177,11 @@ public: @remarks Use this with a multiple selection listbox. + @beginWxPerlOnly + In wxPerl this method takes no parameters and return the + selected items as a list. + @endWxPerlOnly + @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection, wxControlWithItems::SetSelection */ @@ -202,6 +218,10 @@ public: @param pos Position before which to insert the items: if pos is 0 the items will be inserted in the beginning of the listbox + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void InsertItems(unsigned int nItems, const wxString *items, unsigned int pos); @@ -214,6 +234,10 @@ public: @param pos Position before which to insert the items: if pos is @c 0 the items will be inserted in the beginning of the listbox + + @beginWxPerlOnly + Use an array reference for the @a items parameter. + @endWxPerlOnly */ void InsertItems(const wxArrayString& items, unsigned int pos);