include/wx/gtk/combobox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        combobox.h
   3 // Purpose:
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11
  12 #ifndef __GTKCOMBOBOXH__
  13 #define __GTKCOMBOBOXH__
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16 #pragma interface "combobox.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20
  21 #if wxUSE_COMBOBOX
  22
  23 #include "wx/object.h"
  24
  25 //-----------------------------------------------------------------------------
  26 // classes
  27 //-----------------------------------------------------------------------------
  28
  29 class wxComboBox;
  30
  31 //-----------------------------------------------------------------------------
  32 // global data
  33 //-----------------------------------------------------------------------------
  34
  35 extern const wxChar* wxComboBoxNameStr;
  36 extern const wxChar* wxEmptyString;
  37
  38 //-----------------------------------------------------------------------------
  39 // wxComboBox
  40 //-----------------------------------------------------------------------------
  41
  42 class wxComboBox : public wxControl, public wxComboBoxBase
  43 {
  44 public:
  45     inline wxComboBox() {}
  46     inline wxComboBox(wxWindow *parent, wxWindowID id,
  47            const wxString& value = wxEmptyString,
  48            const wxPoint& pos = wxDefaultPosition,
  49            const wxSize& size = wxDefaultSize,
  50            int n = 0, const wxString choices[] = (const wxString *) NULL,
  51            long style = 0,
  52            const wxValidator& validator = wxDefaultValidator,
  53            const wxString& name = wxComboBoxNameStr)
  54     {
  55         Create(parent, id, value, pos, size, n, choices, style, validator, name);
  56     }
  57     inline wxComboBox(wxWindow *parent, wxWindowID id,
  58            const wxString& value,
  59            const wxPoint& pos,
  60            const wxSize& size,
  61            const wxArrayString& choices,
  62            long style = 0,
  63            const wxValidator& validator = wxDefaultValidator,
  64            const wxString& name = wxComboBoxNameStr)
  65     {
  66         Create(parent, id, value, pos, size, choices, style, validator, name);
  67     }
  68
  69     ~wxComboBox();
  70
  71     bool Create(wxWindow *parent, wxWindowID id,
  72            const wxString& value = wxEmptyString,
  73            const wxPoint& pos = wxDefaultPosition,
  74            const wxSize& size = wxDefaultSize,
  75            int n = 0, const wxString choices[] = (const wxString *) NULL,
  76            long style = 0,
  77            const wxValidator& validator = wxDefaultValidator,
  78            const wxString& name = wxComboBoxNameStr);
  79     bool Create(wxWindow *parent, wxWindowID id,
  80            const wxString& value,
  81            const wxPoint& pos,
  82            const wxSize& size,
  83            const wxArrayString& choices,
  84            long style = 0,
  85            const wxValidator& validator = wxDefaultValidator,
  86            const wxString& name = wxComboBoxNameStr);
  87
  88     void Clear();
  89     void Delete( int n );
  90
  91     virtual int FindString( const wxString &item ) const;
  92     int GetSelection() const;
  93     wxString GetString( int n ) const;
  94     wxString GetStringSelection() const;
  95     int GetCount() const;
  96     int Number() const { return GetCount(); }
  97     void SetSelection( int n );
  98     void Select( int n ) { return SetSelection( n ); }
  99     bool SetStringSelection( const wxString &string );
 100     void SetString(int n, const wxString &text);
 101
 102     wxString GetValue() const;
 103     void SetValue(const wxString& value);
 104
 105     void Copy();
 106     void Cut();
 107     void Paste();
 108     bool CanCopy() const;
 109     bool CanCut() const;
 110     bool CanPaste() const;
 111     void SetInsertionPoint( long pos );
 112     void SetInsertionPointEnd() { SetInsertionPoint( -1 ); }
 113     long GetInsertionPoint() const;
 114     long GetLastPosition() const;
 115     void Remove(long from, long to) { Replace(from, to, wxEmptyString); }
 116     void Replace( long from, long to, const wxString& value );
 117     void SetSelection( long from, long to );
 118     void GetSelection( long* from, long* to ) const;
 119     void SetEditable( bool editable );
 120     void Undo() ;
 121     void Redo() ;
 122     bool CanUndo() const;
 123     bool CanRedo() const;
 124     void SelectAll();
 125     bool IsEditable() const ;
 126     bool HasSelection() const ;
 127
 128     // implementation
 129
 130     virtual void SetFocus();
 131
 132     void OnSize( wxSizeEvent &event );
 133     void OnChar( wxKeyEvent &event );
 134
 135     // Standard event handling
 136     void OnCut(wxCommandEvent& event);
 137     void OnCopy(wxCommandEvent& event);
 138     void OnPaste(wxCommandEvent& event);
 139     void OnUndo(wxCommandEvent& event);
 140     void OnRedo(wxCommandEvent& event);
 141     void OnDelete(wxCommandEvent& event);
 142     void OnSelectAll(wxCommandEvent& event);
 143
 144     void OnUpdateCut(wxUpdateUIEvent& event);
 145     void OnUpdateCopy(wxUpdateUIEvent& event);
 146     void OnUpdatePaste(wxUpdateUIEvent& event);
 147     void OnUpdateUndo(wxUpdateUIEvent& event);
 148     void OnUpdateRedo(wxUpdateUIEvent& event);
 149     void OnUpdateDelete(wxUpdateUIEvent& event);
 150     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 151
 152     bool     m_ignoreNextUpdate:1;
 153     wxList   m_clientDataList;
 154     wxList   m_clientObjectList;
 155     int      m_prevSelection;
 156
 157     void DisableEvents();
 158     void EnableEvents();
 159     GtkWidget* GetConnectWidget();
 160     bool IsOwnGtkWindow( GdkWindow *window );
 161     void DoApplyWidgetStyle(GtkRcStyle *style);
 162
 163     wxCONTROL_ITEMCONTAINER_CLIENTDATAOBJECT_RECAST
 164
 165     static wxVisualAttributes
 166     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 167
 168 protected:
 169     virtual int DoAppend(const wxString& item);
 170     virtual int DoInsert(const wxString& item, int pos);
 171
 172     virtual void DoSetItemClientData( int n, void* clientData );
 173     virtual void* DoGetItemClientData( int n ) const;
 174     virtual void DoSetItemClientObject( int n, wxClientData* clientData );
 175     virtual wxClientData* DoGetItemClientObject( int n ) const;
 176
 177     virtual wxSize DoGetBestSize() const;
 178
 179     // Widgets that use the style->base colour for the BG colour should
 180     // override this and return true.
 181     virtual bool UseGTKStyleBase() const { return true; }
 182
 183 private:
 184     DECLARE_DYNAMIC_CLASS_NO_COPY(wxComboBox)
 185     DECLARE_EVENT_TABLE()
 186 };
 187
 188 #endif
 189
 190 #endif
 191
 192   // __GTKCOMBOBOXH__