Add documentation of emitted events to wxScrolled documentation.

[wxWidgets.git] / interface / wx / listbox.h

diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h
index 0877c5b74690eb12ecfe98f4823af0d07e6e92c6..68fe933e8877391e41333ff2bb27359dcc6f3e18 100644 (file)
--- a/interface/wx/listbox.h
+++ b/interface/wx/listbox.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxListBox
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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.
         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
     @style{wxLB_SORT}
         The listbox contents are sorted in alphabetical order.
     @endStyleTable


@@ -49,10 +51,10 @@
 
     @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_LISTBOX(id, func)}
 
     @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)}
         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
 
         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.
             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.
         @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
         @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.
             The validator for this control.
         @param name
             The name of this class.

+
+        @beginWxPerlOnly
+        Not supported by wxPerl.
+        @endWxPerlOnly

     */
 
     wxListBox(wxWindow* parent, wxWindowID id,
     */
 
     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.
         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,
     */
 
     wxListBox(wxWindow* parent, wxWindowID id,


@@ -155,6 +166,13 @@ public:
     */
     void Deselect(int n);
 
     */
     void Deselect(int n);
 

+    virtual void SetSelection(int n);
+    
+    virtual int GetSelection() const;
+    
+    virtual bool SetStringSelection(const wxString& s, bool select);
+    virtual bool SetStringSelection(const wxString& s);
+

     /**
         Fill an array of ints with the positions of the currently selected items.
 
     /**
         Fill an array of ints with the positions of the currently selected items.
 


@@ -166,6 +184,11 @@ public:
 
         @remarks Use this with a multiple selection listbox.
 
 
         @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
     */
         @see wxControlWithItems::GetSelection, wxControlWithItems::GetStringSelection,
              wxControlWithItems::SetSelection
     */


@@ -202,6 +225,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
         @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);
     */
     void InsertItems(unsigned int nItems, const wxString *items,
                      unsigned int pos);


@@ -214,6 +241,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
         @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);
     */
     void InsertItems(const wxArrayString& items,
                      unsigned int pos);


@@ -267,5 +298,17 @@ public:
             The string that should be visible.
     */
     void SetFirstItem(const wxString& string);
             The string that should be visible.
     */
     void SetFirstItem(const wxString& string);

+    
+    virtual void EnsureVisible(int n);
+    
+    virtual bool IsSorted() const;
+    
+    // implement base class pure virtuals
+    virtual void Refresh(bool eraseBack = true, const wxRect *rect = NULL);
+    
+    virtual unsigned int GetCount() const;
+    virtual wxString GetString(unsigned int n) const;
+    virtual void SetString(unsigned int n, const wxString& s);
+    virtual int FindString(const wxString& s, bool bCase = false) const;

 };
 
 };