Add RunScript and implement on all backends. Document and add a very simple unit...

[wxWidgets.git] / include / wx / univ / combobox.h

diff --git a/include/wx/univ/combobox.h b/include/wx/univ/combobox.h
index 9230e4dbe05f3103fd566578373dae49de340f07..93b3128633892e81924ba58cd0c97bff7be06c60 100644 (file)
--- a/include/wx/univ/combobox.h
+++ b/include/wx/univ/combobox.h
@@ -9,204 +9,32 @@
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 

-/*
-   A few words about all the classes defined in this file are probably in
-   order: why do we need extra wxComboControl and wxComboPopup classes?
-
-   This is because a traditional combobox is a combination of a text control
-   (with a button allowing to open the pop down list) with a listbox and
-   wxComboBox class is exactly such control, however we want to also have other
-   combinations - in fact, we want to allow anything at all to be used as pop
-   down list, not just a wxListBox.
-
-   So we define a base wxComboControl which can use any control as pop down
-   list and wxComboBox deriving from it which implements the standard wxWidgets
-   combobox API. wxComboControl needs to be told somehow which control to use
-   and this is done by SetPopupControl(). However, we need something more than
-   just a wxControl in this method as, for example, we need to call
-   SetSelection("initial text value") and wxControl doesn't have such method.
-   So we also need a wxComboPopup which is just a very simple interface which
-   must be implemented by a control to be usable as a popup.
-
-   We couldn't derive wxComboPopup from wxControl as this would make it
-   impossible to have a class deriving from both wxListBx and from it, so
-   instead it is just a mix-in.
- */

 
 #ifndef _WX_UNIV_COMBOBOX_H_
 #define _WX_UNIV_COMBOBOX_H_
 
 
 #ifndef _WX_UNIV_COMBOBOX_H_
 #define _WX_UNIV_COMBOBOX_H_
 

-class WXDLLEXPORT wxComboControl;
-class WXDLLEXPORT wxListBox;
-class WXDLLEXPORT wxPopupComboWindow;
-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxButton;
+#include "wx/combo.h"

 
 

-// ----------------------------------------------------------------------------
-// the actions supported by this control
-// ----------------------------------------------------------------------------
-
-// all actions of single line text controls are supported
-
-// popup/dismiss the choice window
-#define wxACTION_COMBOBOX_POPUP     _T("popup")
-#define wxACTION_COMBOBOX_DISMISS   _T("dismiss")
-
-// choose the next/prev/specified (by numArg) item
-#define wxACTION_COMBOBOX_SELECT_NEXT _T("next")
-#define wxACTION_COMBOBOX_SELECT_PREV _T("prev")
-#define wxACTION_COMBOBOX_SELECT      _T("select")
-
-// ----------------------------------------------------------------------------
-// wxComboPopup is the interface which must be implemented by a control to be
-// used as a popup by wxComboControl
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxComboPopup
-{
-public:
-    wxComboPopup(wxComboControl *combo) { m_combo = combo; }
-    virtual ~wxComboPopup() {}
-
-    // we must have an associated control which is subclassed by the combobox
-    virtual wxControl *GetControl() = 0;
-
-    // called before showing the control to set the initial selection - notice
-    // that the text passed to this method might not correspond to any valid
-    // item (if the user edited it directly), in which case the method should
-    // just return false but not emit any errors
-    virtual bool SetSelection(const wxString& value) = 0;
-
-    // called immediately after the control is shown
-    virtual void OnShow() = 0;
-
-    virtual wxCoord GetBestWidth() const {return 0; }
-
-protected:
-    wxComboControl *m_combo;
-};
+class WXDLLIMPEXP_FWD_CORE wxListBox;

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// wxComboControl: a combination of a (single line) text control with a button
-// opening a popup window which contains the control from which the user can
-// choose the value directly.
+// NB: some actions supported by this control are in wx/generic/combo.h

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxComboControl : public wxControl
-{
-public:
-    // construction
-    wxComboControl()
-    {
-        Init();
-    }
-
-    wxComboControl(wxWindow *parent,
-                   wxWindowID id,
-                   const wxString& value = wxEmptyString,
-                   const wxPoint& pos = wxDefaultPosition,
-                   const wxSize& size = wxDefaultSize,
-                   long style = 0,
-                   const wxValidator& validator = wxDefaultValidator,
-                   const wxString& name = wxComboBoxNameStr)
-    {
-        Init();
-
-        (void)Create(parent, id, value, pos, size, style, validator, name);
-    }
-
-    bool Create(wxWindow *parent,
-                wxWindowID id,
-                const wxString& value = wxEmptyString,
-                const wxPoint& pos = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = 0,
-                const wxValidator& validator = wxDefaultValidator,
-                const wxString& name = wxComboBoxNameStr);
-
-    virtual ~wxComboControl();
-
-    // a combo control needs a control for popup window it displays
-    void SetPopupControl(wxComboPopup *popup);
-    wxComboPopup *GetPopupControl() const { return m_popup; }
-
-    // show/hide popup window
-    void ShowPopup();
-    void HidePopup();
-
-    // return true if the popup is currently shown
-    bool IsPopupShown() const { return m_isPopupShown; }
-
-    // get the popup window containing the popup control
-    wxPopupComboWindow *GetPopupWindow() const { return m_winPopup; }
-
-    // get the text control which is part of the combobox
-    wxTextCtrl *GetText() const { return m_text; }
-
-    // implementation only from now on
-    // -------------------------------
-
-    // notifications from wxComboPopup (shouldn't be called by anybody else)
-
-    // called when the user selects something in the popup: this normally hides
-    // the popup and sets the text to the new value
-    virtual void OnSelect(const wxString& value);
-
-    // called when the user dismisses the popup
-    virtual void OnDismiss();
-
-    // forward these functions to all subcontrols
-    virtual bool Enable(bool enable = true);
-    virtual bool Show(bool show = true);
-
-#if wxUSE_TOOLTIPS
-    virtual void DoSetToolTip( wxToolTip *tip );
-#endif // wxUSE_TOOLTIPS
-
-    // we have our own input handler and our own actions
-    virtual bool PerformAction(const wxControlAction& action,
-                               long numArg = 0l,
-                               const wxString& strArg = wxEmptyString);
-
-protected:
-    // override the base class virtuals involved into geometry calculations
-    virtual wxSize DoGetBestClientSize() const;
-    virtual void DoMoveWindow(int x, int y, int width, int height);
-    virtual void DoSetSize(int x, int y,
-                           int width, int height,
-                           int sizeFlags = wxSIZE_AUTO);
-
-    // event handlers
-    void OnKey(wxKeyEvent& event);
-
-    // common part of all ctors
-    void Init();
-
-private:
-    // the text control and button we show all the time
-    wxTextCtrl *m_text;
-    wxButton *m_btn;
-
-    // the popup control
-    wxComboPopup *m_popup;
-
-    // and the popup window containing it
-    wxPopupComboWindow *m_winPopup;
-
-    // the height of the combobox popup as calculated in Create()
-    wxCoord m_heightPopup;
-
-    // is the popup window currenty shown?
-    bool m_isPopupShown;
+// choose the next/prev/specified (by numArg) item
+#define wxACTION_COMBOBOX_SELECT_NEXT wxT("next")
+#define wxACTION_COMBOBOX_SELECT_PREV wxT("prev")
+#define wxACTION_COMBOBOX_SELECT      wxT("select")

 
 

-    DECLARE_EVENT_TABLE()
-};

 
 // ----------------------------------------------------------------------------
 // wxComboBox: a combination of text control and a listbox
 // ----------------------------------------------------------------------------
 
 
 // ----------------------------------------------------------------------------
 // wxComboBox: a combination of text control and a listbox
 // ----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxComboBox : public wxComboControl, public wxComboBoxBase
+// NB: Normally we'd like wxComboBox to inherit from wxComboBoxBase, but here
+//     we can't really do that since both wxComboBoxBase and wxComboCtrl inherit
+//     from wxTextCtrl.
+class WXDLLIMPEXP_CORE wxComboBox : public wxComboCtrl, public wxItemContainer

 {
 public:
     // ctors and such
 {
 public:
     // ctors and such


@@ -266,8 +94,9 @@ public:
     // implement the combobox interface
 
     // wxTextCtrl methods
     // implement the combobox interface
 
     // wxTextCtrl methods

-    virtual wxString GetValue() const;
+    virtual wxString GetValue() const { return DoGetValue(); }

     virtual void SetValue(const wxString& value);
     virtual void SetValue(const wxString& value);

+    virtual void WriteText(const wxString& value);

     virtual void Copy();
     virtual void Cut();
     virtual void Paste();
     virtual void Copy();
     virtual void Cut();
     virtual void Paste();


@@ -278,6 +107,7 @@ public:
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
     virtual void SetSelection(long from, long to);
     virtual void Replace(long from, long to, const wxString& value);
     virtual void Remove(long from, long to);
     virtual void SetSelection(long from, long to);

+    virtual void GetSelection(long *from, long *to) const;

     virtual void SetEditable(bool editable);
     virtual bool IsEditable() const;
 
     virtual void SetEditable(bool editable);
     virtual bool IsEditable() const;
 


@@ -291,25 +121,57 @@ public:
     virtual bool CanUndo() const;
     virtual bool CanRedo() const;
 
     virtual bool CanUndo() const;
     virtual bool CanRedo() const;
 

+    // override these methods to disambiguate between two base classes versions
+    virtual void Clear()
+    {
+        wxComboCtrl::Clear();
+        wxItemContainer::Clear();
+    }
+
+    bool IsEmpty() const { return wxItemContainer::IsEmpty(); }
+

     // wxControlWithItems methods
     // wxControlWithItems methods

-    virtual void Clear();
-    virtual void Delete(int n);
-    virtual size_t GetCount() const;
-    virtual wxString GetString(int n) const;
-    virtual void SetString(int n, const wxString& s);
+    virtual void DoClear();
+    virtual void DoDeleteOneItem(unsigned int n);
+    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 void SetSelection(int n);
     virtual int GetSelection() const;
     virtual int FindString(const wxString& s, bool bCase = false) const;
     virtual void SetSelection(int n);
     virtual int GetSelection() const;

+    virtual wxString GetStringSelection() const;

 
     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 
 
     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 

+    // we have our own input handler and our own actions
+    // (but wxComboCtrl already handled Popup/Dismiss)
+    /*
+    virtual bool PerformAction(const wxControlAction& action,
+                               long numArg = 0l,
+                               const wxString& strArg = wxEmptyString);
+    */
+
+    static wxInputHandler *GetStdInputHandler(wxInputHandler *handlerDef);
+    virtual wxInputHandler *DoGetStdInputHandler(wxInputHandler *handlerDef)
+    {
+        return GetStdInputHandler(handlerDef);
+    }
+
+    // we delegate our client data handling to wxListBox which we use for the
+    // items, so override this and other methods dealing with the client data
+    virtual wxClientDataType GetClientDataType() const;
+    virtual void SetClientDataType(wxClientDataType clientDataItemsType);
+

 protected:
 protected:

-    virtual int DoAppend(const wxString& item);
-    virtual int DoInsert(const wxString& item, int pos);
-    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 wxString DoGetValue() const;
+
+    virtual int DoInsertItems(const wxArrayStringsAdapter& items,
+                              unsigned int pos,
+                              void **clientData, wxClientDataType type);
+
+    virtual void DoSetItemClientData(unsigned int n, void* clientData);
+    virtual void* DoGetItemClientData(unsigned int n) const;
+

 
     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();


@@ -318,6 +180,9 @@ protected:
     wxListBox *GetLBox() const { return m_lbox; }
 
 private:
     wxListBox *GetLBox() const { return m_lbox; }
 
 private:

+    // implement wxTextEntry pure virtual method
+    virtual wxWindow *GetEditableWindow() { return this; }
+

     // the popup listbox
     wxListBox *m_lbox;
 
     // the popup listbox
     wxListBox *m_lbox;
 


@@ -325,18 +190,4 @@ private:
     DECLARE_DYNAMIC_CLASS(wxComboBox)
 };
 
     DECLARE_DYNAMIC_CLASS(wxComboBox)
 };
 

-// ----------------------------------------------------------------------------
-// wxStdComboBoxInputHandler: allows the user to open/close the combo from kbd
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxStdComboBoxInputHandler : public wxStdInputHandler
-{
-public:
-    wxStdComboBoxInputHandler(wxInputHandler *inphand);
-
-    virtual bool HandleKey(wxInputConsumer *consumer,
-                           const wxKeyEvent& event,
-                           bool pressed);
-};
-

 #endif // _WX_UNIV_COMBOBOX_H_
 #endif // _WX_UNIV_COMBOBOX_H_