include/wx/osx/combobox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/osx/combobox.h
   3 // Purpose:     wxComboBox class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_COMBOBOX_H_
  13 #define _WX_COMBOBOX_H_
  14
  15 #include "wx/containr.h"
  16 #include "wx/choice.h"
  17 #include "wx/textctrl.h"
  18
  19 WXDLLIMPEXP_DATA_CORE(extern const char) wxComboBoxNameStr[];
  20
  21 WX_DEFINE_ARRAY( char * , wxComboBoxDataArray ) ;
  22
  23 // forward declaration of private implementation classes
  24
  25 class wxComboBoxText;
  26 class wxComboBoxChoice;
  27 class wxComboWidgetImpl;
  28
  29 // Combobox item
  30 class WXDLLIMPEXP_CORE wxComboBox : public wxControl, public wxComboBoxBase
  31 {
  32     DECLARE_DYNAMIC_CLASS(wxComboBox)
  33
  34  public:
  35     virtual ~wxComboBox();
  36
  37 #if wxOSX_USE_CARBON
  38     // forward these functions to all subcontrols
  39     virtual bool Enable(bool enable = true);
  40     virtual bool Show(bool show = true);
  41 #endif
  42
  43     // callback functions
  44     virtual void DelegateTextChanged( const wxString& value );
  45     virtual void DelegateChoice( const wxString& value );
  46
  47     wxComboBox() { Init(); }
  48
  49     wxComboBox(wxWindow *parent, wxWindowID id,
  50            const wxString& value = wxEmptyString,
  51            const wxPoint& pos = wxDefaultPosition,
  52            const wxSize& size = wxDefaultSize,
  53            int n = 0, const wxString choices[] = NULL,
  54            long style = 0,
  55            const wxValidator& validator = wxDefaultValidator,
  56            const wxString& name = wxComboBoxNameStr)
  57     {
  58         Init();
  59         Create(parent, id, value, pos, size, n, choices, style, validator, name);
  60     }
  61
  62     wxComboBox(wxWindow *parent, wxWindowID id,
  63            const wxString& value,
  64            const wxPoint& pos,
  65            const wxSize& size,
  66            const wxArrayString& choices,
  67            long style = 0,
  68            const wxValidator& validator = wxDefaultValidator,
  69            const wxString& name = wxComboBoxNameStr)
  70     {
  71         Init();
  72         Create(parent, id, value, pos, size, choices, style, validator, name);
  73     }
  74
  75     bool Create(wxWindow *parent, wxWindowID id,
  76            const wxString& value = wxEmptyString,
  77            const wxPoint& pos = wxDefaultPosition,
  78            const wxSize& size = wxDefaultSize,
  79            int n = 0, const wxString choices[] = NULL,
  80            long style = 0,
  81            const wxValidator& validator = wxDefaultValidator,
  82            const wxString& name = wxComboBoxNameStr);
  83
  84     bool Create(wxWindow *parent, wxWindowID id,
  85            const wxString& value,
  86            const wxPoint& pos,
  87            const wxSize& size,
  88            const wxArrayString& choices,
  89            long style = 0,
  90            const wxValidator& validator = wxDefaultValidator,
  91            const wxString& name = wxComboBoxNameStr);
  92
  93     virtual int GetSelection() const;
  94     virtual void GetSelection(long *from, long *to) const;
  95     virtual void SetSelection(int n);
  96     virtual void SetSelection(long from, long to);
  97     virtual int FindString(const wxString& s, bool bCase = false) const;
  98     virtual wxString GetString(unsigned int n) const;
  99     virtual wxString GetStringSelection() const;
 100     virtual void SetString(unsigned int n, const wxString& s);
 101
 102     virtual unsigned int GetCount() const;
 103
 104 // these methods are provided by wxTextEntry for the native impl.
 105 #if wxOSX_USE_CARBON
 106     // Text field functions
 107     virtual void SetValue(const wxString& value);
 108     virtual wxString GetValue() const;
 109     virtual void WriteText(const wxString& text);
 110
 111     // Clipboard operations
 112     virtual void Copy();
 113     virtual void Cut();
 114     virtual void Paste();
 115     virtual void SetInsertionPoint(long pos);
 116     virtual void SetInsertionPointEnd();
 117     virtual long GetInsertionPoint() const;
 118     virtual wxTextPos GetLastPosition() const;
 119     virtual void Replace(long from, long to, const wxString& value);
 120     virtual void Remove(long from, long to);
 121     virtual void SetEditable(bool editable);
 122     virtual bool IsEditable() const;
 123
 124     virtual void Undo();
 125     virtual void Redo();
 126     virtual void SelectAll();
 127
 128     virtual bool CanCopy() const;
 129     virtual bool CanCut() const;
 130     virtual bool CanPaste() const;
 131     virtual bool CanUndo() const;
 132     virtual bool CanRedo() const;
 133
 134     virtual wxClientDataType GetClientDataType() const;
 135 #endif
 136
 137
 138
 139     // osx specific event handling common for all osx-ports
 140
 141     virtual bool        OSXHandleClicked( double timestampsec );
 142
 143 #if wxOSX_USE_CARBON
 144     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 145
 146     WX_DECLARE_CONTROL_CONTAINER();
 147 #endif
 148
 149     // only used by the native Cocoa combobox, but we must define it everywhere
 150     // to maintain the wxTextEntry abstraction.
 151     virtual wxTextWidgetImpl * GetTextPeer() const;
 152
 153 #if wxOSX_USE_COCOA
 154     wxComboWidgetImpl* GetComboPeer() const;
 155 #endif
 156 protected:
 157     // common part of all ctors
 158     void Init();
 159
 160     // List functions
 161     virtual void DoDeleteOneItem(unsigned int n);
 162     virtual void DoClear();
 163
 164     // wxTextEntry functions
 165 #if wxOSX_USE_CARBON
 166     virtual wxString DoGetValue() const;
 167 #endif
 168     virtual wxWindow *GetEditableWindow() { return this; }
 169
 170 #if wxOSX_USE_CARBON
 171     // override the base class virtuals involved in geometry calculations
 172     virtual wxSize DoGetBestSize() const;
 173     virtual void DoMoveWindow(int x, int y, int width, int height);
 174 #endif
 175
 176     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
 177                               unsigned int pos,
 178                               void **clientData, wxClientDataType type);
 179
 180     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 181     virtual void * DoGetItemClientData(unsigned int n) const;
 182
 183 #if wxOSX_USE_CARBON
 184     virtual void SetClientDataType(wxClientDataType clientDataItemsType);
 185 #endif
 186
 187     virtual void EnableTextChangedEvents(bool enable);
 188
 189     // the subcontrols
 190     wxComboBoxText*     m_text;
 191     wxComboBoxChoice*   m_choice;
 192
 193     wxComboBoxDataArray m_datas;
 194
 195 #if wxOSX_USE_CARBON
 196     DECLARE_EVENT_TABLE()
 197 #endif
 198 };
 199
 200 #endif // _WX_COMBOBOX_H_