]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/univ/listbox.h
Support using GetTextExtent() with empty string to get descent in wxOSX.
[wxWidgets.git] / include / wx / univ / listbox.h
index ddeb5111a4649528160c90ed9da352c1d28d8667..5431b7bd18ff8efdb01522bf1e56b499ac892430 100644 (file)
 #ifndef _WX_UNIV_LISTBOX_H_
 #define _WX_UNIV_LISTBOX_H_
 
-#ifdef __GNUG__
-    #pragma implementation "univlistbox.h"
-#endif
-
 #include "wx/scrolwin.h"    // for wxScrollHelper
+#include "wx/dynarray.h"
+#include "wx/arrstr.h"
 
 // ----------------------------------------------------------------------------
 // the actions supported by this control
 // ----------------------------------------------------------------------------
 
 // change the current item
-#define wxACTION_LISTBOX_SETFOCUS   _T("setfocus")  // select the item
-#define wxACTION_LISTBOX_MOVEDOWN   _T("down")      // select item below
-#define wxACTION_LISTBOX_MOVEUP     _T("up")        // select item above
-#define wxACTION_LISTBOX_PAGEDOWN   _T("pagedown")  // go page down
-#define wxACTION_LISTBOX_PAGEUP     _T("pageup")    // go page up
-#define wxACTION_LISTBOX_START      _T("start")     // go to first item
-#define wxACTION_LISTBOX_END        _T("end")       // go to last item
-#define wxACTION_LISTBOX_FIND       _T("find")      // find item by 1st letter
+#define wxACTION_LISTBOX_SETFOCUS   wxT("setfocus")  // select the item
+#define wxACTION_LISTBOX_MOVEDOWN   wxT("down")      // select item below
+#define wxACTION_LISTBOX_MOVEUP     wxT("up")        // select item above
+#define wxACTION_LISTBOX_PAGEDOWN   wxT("pagedown")  // go page down
+#define wxACTION_LISTBOX_PAGEUP     wxT("pageup")    // go page up
+#define wxACTION_LISTBOX_START      wxT("start")     // go to first item
+#define wxACTION_LISTBOX_END        wxT("end")       // go to last item
+#define wxACTION_LISTBOX_FIND       wxT("find")      // find item by 1st letter
 
 // do something with the current item
-#define wxACTION_LISTBOX_ACTIVATE   _T("activate")  // activate (choose)
-#define wxACTION_LISTBOX_TOGGLE     _T("toggle")    // togglee selected state
-#define wxACTION_LISTBOX_SELECT     _T("select")    // sel this, unsel others
-#define wxACTION_LISTBOX_SELECTADD  _T("selectadd") // add to selection
-#define wxACTION_LISTBOX_UNSELECT   _T("unselect")  // unselect
-#define wxACTION_LISTBOX_ANCHOR     _T("selanchor") // anchor selection
+#define wxACTION_LISTBOX_ACTIVATE   wxT("activate")  // activate (choose)
+#define wxACTION_LISTBOX_TOGGLE     wxT("toggle")    // togglee selected state
+#define wxACTION_LISTBOX_SELECT     wxT("select")    // sel this, unsel others
+#define wxACTION_LISTBOX_SELECTADD  wxT("selectadd") // add to selection
+#define wxACTION_LISTBOX_UNSELECT   wxT("unselect")  // unselect
+#define wxACTION_LISTBOX_ANCHOR     wxT("selanchor") // anchor selection
 
 // do something with the selection globally (not for single selection ones)
-#define wxACTION_LISTBOX_SELECTALL   _T("selectall")   // select all items
-#define wxACTION_LISTBOX_UNSELECTALL _T("unselectall") // unselect all items
-#define wxACTION_LISTBOX_SELTOGGLE   _T("togglesel")   // invert the selection
-#define wxACTION_LISTBOX_EXTENDSEL   _T("extend")      // extend to item
+#define wxACTION_LISTBOX_SELECTALL   wxT("selectall")   // select all items
+#define wxACTION_LISTBOX_UNSELECTALL wxT("unselectall") // unselect all items
+#define wxACTION_LISTBOX_SELTOGGLE   wxT("togglesel")   // invert the selection
+#define wxACTION_LISTBOX_EXTENDSEL   wxT("extend")      // extend to item
 
 // ----------------------------------------------------------------------------
 // wxListBox: a list of selectable items
 // ----------------------------------------------------------------------------
 
-class wxListBox : public wxListBoxBase, public wxScrollHelper
+class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase, public wxScrollHelper
 {
 public:
     // ctors and such
-    wxListBox() { Init(); }
+    wxListBox() : wxScrollHelper(this) { Init(); }
     wxListBox(wxWindow *parent,
               wxWindowID id,
               const wxPoint& pos = wxDefaultPosition,
@@ -63,11 +61,20 @@ public:
               long style = 0,
               const wxValidator& validator = wxDefaultValidator,
               const wxString& name = wxListBoxNameStr )
+        : wxScrollHelper(this)
     {
         Init();
 
         Create(parent, id, pos, size, n, choices, style, validator, name);
     }
+    wxListBox(wxWindow *parent,
+              wxWindowID id,
+              const wxPoint& pos,
+              const wxSize& size,
+              const wxArrayString& choices,
+              long style = 0,
+              const wxValidator& validator = wxDefaultValidator,
+              const wxString& name = wxListBoxNameStr );
 
     virtual ~wxListBox();
 
@@ -79,34 +86,44 @@ public:
                 long style = 0,
                 const wxValidator& validator = wxDefaultValidator,
                 const wxString& name = wxListBoxNameStr);
+    bool Create(wxWindow *parent,
+                wxWindowID id,
+                const wxPoint& pos,
+                const wxSize& size,
+                const wxArrayString& choices,
+                long style = 0,
+                const wxValidator& validator = wxDefaultValidator,
+                const wxString& name = wxListBoxNameStr);
 
     // implement the listbox interface defined by wxListBoxBase
-    virtual void Clear();
-    virtual void Delete(int n);
+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);
 
-    virtual int GetCount() const { return (int)m_strings.GetCount(); }
-    virtual wxString GetString(int n) const { return m_strings[n]; }
-    virtual void SetString(int n, const wxString& s);
-    virtual int FindString(const wxString& s) const
-        { return m_strings.Index(s); }
+    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;
 
     virtual bool IsSelected(int n) const
         { return m_selections.Index(n) != wxNOT_FOUND; }
-    virtual void SetSelection(int n, bool select = TRUE);
     virtual int GetSelection() const;
     virtual int GetSelections(wxArrayInt& aSelections) const;
 
 protected:
-    virtual int DoAppend(const wxString& item);
-    virtual void DoInsertItems(const wxArrayString& items, int pos);
-    virtual void DoSetItems(const wxArrayString& items, void **clientData);
+    virtual void DoSetSelection(int n, bool select);
+
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData,
+                              wxClientDataType type);
+
+    // universal wxComboBox implementation internally uses wxListBox
+    friend class WXDLLIMPEXP_FWD_CORE wxComboBox;
 
     virtual void DoSetFirstItem(int n);
 
-    virtual void DoSetItemClientData(int n, void* clientData);
-    virtual void* DoGetItemClientData(int n) const;
-    virtual void DoSetItemClientObject(int n, wxClientData* clientData);
-    virtual wxClientData* DoGetItemClientObject(int n) const;
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
 
 public:
     // override some more base class methods
@@ -129,10 +146,10 @@ public:
     void Activate(int item = -1);
 
     // select or unselect the specified or current (if -1) item
-    void Select(bool sel = TRUE, int item = -1);
+    void DoSelect(int item = -1, bool sel = true);
 
     // more readable wrapper
-    void Unselect(int item) { Select(FALSE, item); }
+    void DoUnselect(int item) { DoSelect(item, false); }
 
     // select an item and send a notification about it
     void SelectAndNotify(int item);
@@ -141,10 +158,10 @@ public:
     virtual void EnsureVisible(int n);
 
     // find the first item [strictly] after the current one which starts with
-    // the given string and make it the current one, return TRUE if the current
+    // the given string and make it the current one, return true if the current
     // item changed
-    bool FindItem(const wxString& prefix, bool strictlyAfter = FALSE);
-    bool FindNextItem(const wxString& prefix) { return FindItem(prefix, TRUE); }
+    bool FindItem(const wxString& prefix, bool strictlyAfter = false);
+    bool FindNextItem(const wxString& prefix) { return FindItem(prefix, true); }
 
     // extend the selection to span the range from the anchor (see below) to
     // the specified or current item
@@ -165,8 +182,14 @@ public:
                                long numArg = 0l,
                                const wxString& strArg = wxEmptyString);
 
-    // let wxColourScheme choose the right colours for us
-    virtual bool IsContainerWindow() const { return TRUE; }
+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+
+    // idle processing
+    virtual void OnInternalIdle();
 
 protected:
     // geometry
@@ -178,16 +201,17 @@ protected:
     virtual void DoDraw(wxControlRenderer *renderer);
     virtual wxBorder GetDefaultBorder() const;
 
+    // special hook for wxCheckListBox which allows it to update its internal
+    // data when a new item is inserted into the listbox
+    virtual void OnItemInserted(unsigned int WXUNUSED(pos)) { }
+
+
     // common part of all ctors
     void Init();
 
     // event handlers
-    void OnIdle(wxIdleEvent& event);
     void OnSize(wxSizeEvent& event);
 
-    // common part of Clear() and DoSetItems(): clears everything
-    virtual void DoClear();
-
     // refresh the given item(s) or everything
     void RefreshItems(int from, int count);
     void RefreshItem(int n);
@@ -222,7 +246,11 @@ protected:
 
     // the array containing all items (it is sorted if the listbox has
     // wxLB_SORT style)
-    wxArrayString m_strings;
+    union
+    {
+        wxArrayString *unsorted;
+        wxSortedArrayString *sorted;
+    } m_strings;
 
     // this array contains the indices of the selected items (for the single
     // selection listboxes only the first element of it is used and contains
@@ -274,60 +302,4 @@ private:
     DECLARE_DYNAMIC_CLASS(wxListBox)
 };
 
-// ----------------------------------------------------------------------------
-// wxStdListboxInputHandler: handles mouse and kbd in a single or multi
-// selection listbox
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdListboxInputHandler : public wxStdInputHandler
-{
-public:
-    // if pressing the mouse button in a multiselection listbox should toggle
-    // the item under mouse immediately, then specify TRUE as the second
-    // parameter (this is the standard behaviour, under GTK the item is toggled
-    // only when the mouse is released in the multi selection listbox)
-    wxStdListboxInputHandler(wxInputHandler *inphand,
-                             bool toggleOnPressAlways = TRUE);
-
-    // base class methods
-    virtual bool HandleKey(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-    virtual bool HandleMouse(wxInputConsumer *consumer,
-                             const wxMouseEvent& event);
-    virtual bool HandleMouseMove(wxInputConsumer *consumer,
-                                 const wxMouseEvent& event);
-
-protected:
-    // return the item under mouse, 0 if the mouse is above the listbox or
-    // GetCount() if it is below it
-    int HitTest(const wxListBox *listbox, const wxMouseEvent& event);
-
-    // parts of HitTest(): first finds the pseudo (because not in range) index
-    // of the item and the second one adjusts it if necessary - that is if the
-    // third one returns FALSE
-    int HitTestUnsafe(const wxListBox *listbox, const wxMouseEvent& event);
-    int FixItemIndex(const wxListBox *listbox, int item);
-    bool IsValidIndex(const wxListBox *listbox, int item);
-
-    // init m_btnCapture and m_actionMouse
-    wxControlAction SetupCapture(wxListBox *lbox,
-                                 const wxMouseEvent& event,
-                                 int item);
-
-    wxRenderer *m_renderer;
-
-    // the button which initiated the mouse capture (currently 0 or 1)
-    int m_btnCapture;
-
-    // the action to perform when the mouse moves while we capture it
-    wxControlAction m_actionMouse;
-
-    // the ctor parameter toggleOnPressAlways (see comments near it)
-    bool m_toggleOnPressAlways;
-
-    // do we track the mouse outside the window when it is captured?
-    bool m_trackMouseOutside;
-};
-
 #endif // _WX_UNIV_LISTBOX_H_