include/wx/gtk/combobox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/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 #ifndef _WX_GTK_COMBOBOX_H_
  12 #define _WX_GTK_COMBOBOX_H_
  13
  14 #include "wx/choice.h"
  15
  16 typedef struct _GtkEntry GtkEntry;
  17
  18 //-----------------------------------------------------------------------------
  19 // wxComboBox
  20 //-----------------------------------------------------------------------------
  21
  22 class WXDLLIMPEXP_CORE wxComboBox : public wxChoice,
  23                                     public wxTextEntry
  24 {
  25 public:
  26     wxComboBox()
  27         : wxChoice(), wxTextEntry()
  28     {
  29         Init();
  30     }
  31     wxComboBox(wxWindow *parent,
  32                wxWindowID id,
  33                const wxString& value = wxEmptyString,
  34                const wxPoint& pos = wxDefaultPosition,
  35                const wxSize& size = wxDefaultSize,
  36                int n = 0, const wxString choices[] = NULL,
  37                long style = 0,
  38                const wxValidator& validator = wxDefaultValidator,
  39                const wxString& name = wxComboBoxNameStr)
  40         : wxChoice(), wxTextEntry()
  41     {
  42         Init();
  43         Create(parent, id, value, pos, size, n, choices, style, validator, name);
  44     }
  45
  46     wxComboBox(wxWindow *parent, wxWindowID id,
  47                const wxString& value,
  48                const wxPoint& pos,
  49                const wxSize& size,
  50                const wxArrayString& choices,
  51                long style = 0,
  52                const wxValidator& validator = wxDefaultValidator,
  53                const wxString& name = wxComboBoxNameStr)
  54         : wxChoice(), wxTextEntry()
  55     {
  56         Init();
  57         Create(parent, id, value, pos, size, choices, style, validator, name);
  58     }
  59
  60     bool Create(wxWindow *parent, wxWindowID id,
  61                 const wxString& value = wxEmptyString,
  62                 const wxPoint& pos = wxDefaultPosition,
  63                 const wxSize& size = wxDefaultSize,
  64                 int n = 0, const wxString choices[] = (const wxString *) NULL,
  65                 long style = 0,
  66                 const wxValidator& validator = wxDefaultValidator,
  67                 const wxString& name = wxComboBoxNameStr);
  68     bool Create(wxWindow *parent, wxWindowID id,
  69                 const wxString& value,
  70                 const wxPoint& pos,
  71                 const wxSize& size,
  72                 const wxArrayString& choices,
  73                 long style = 0,
  74                 const wxValidator& validator = wxDefaultValidator,
  75                 const wxString& name = wxComboBoxNameStr);
  76
  77     // Set/GetSelection() from wxTextEntry and wxChoice
  78
  79     virtual void SetSelection(int n) { wxChoice::SetSelection(n); }
  80     virtual void SetSelection(long from, long to)
  81                                { wxTextEntry::SetSelection(from, to); }
  82
  83     virtual int GetSelection() const { return wxChoice::GetSelection(); }
  84     virtual void GetSelection(long *from, long *to) const
  85                                { return wxTextEntry::GetSelection(from, to); }
  86
  87     virtual wxString GetStringSelection() const
  88     {
  89         return wxItemContainer::GetStringSelection();
  90     }
  91
  92     virtual void SetString(unsigned int n, const wxString& string);
  93
  94     virtual void Popup();
  95     virtual void Dismiss();
  96
  97     virtual void Clear()
  98     {
  99         wxTextEntry::Clear();
 100         wxItemContainer::Clear();
 101     }
 102
 103     // See wxComboBoxBase discussion of IsEmpty().
 104     bool IsListEmpty() const { return wxItemContainer::IsEmpty(); }
 105     bool IsTextEmpty() const { return wxTextEntry::IsEmpty(); }
 106
 107     void OnChar( wxKeyEvent &event );
 108
 109     virtual void SetValue(const wxString& value);
 110
 111     // Standard event handling
 112     void OnCut(wxCommandEvent& event);
 113     void OnCopy(wxCommandEvent& event);
 114     void OnPaste(wxCommandEvent& event);
 115     void OnUndo(wxCommandEvent& event);
 116     void OnRedo(wxCommandEvent& event);
 117     void OnDelete(wxCommandEvent& event);
 118     void OnSelectAll(wxCommandEvent& event);
 119
 120     void OnUpdateCut(wxUpdateUIEvent& event);
 121     void OnUpdateCopy(wxUpdateUIEvent& event);
 122     void OnUpdatePaste(wxUpdateUIEvent& event);
 123     void OnUpdateUndo(wxUpdateUIEvent& event);
 124     void OnUpdateRedo(wxUpdateUIEvent& event);
 125     void OnUpdateDelete(wxUpdateUIEvent& event);
 126     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 127
 128     virtual void GTKDisableEvents();
 129     virtual void GTKEnableEvents();
 130     GtkWidget* GetConnectWidget();
 131
 132     static wxVisualAttributes
 133     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 134
 135 protected:
 136     // From wxWindowGTK:
 137     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 138
 139     // Widgets that use the style->base colour for the BG colour should
 140     // override this and return true.
 141     virtual bool UseGTKStyleBase() const { return true; }
 142
 143     // Override in derived classes to create combo box widgets with
 144     // custom list stores.
 145     virtual void GTKCreateComboBoxWidget();
 146
 147     virtual GtkEntry *GetEntry() const
 148         { return m_entry; }
 149
 150     GtkEntry*   m_entry;
 151
 152 private:
 153     // From wxTextEntry:
 154     virtual wxWindow *GetEditableWindow() { return this; }
 155     virtual GtkEditable *GetEditable() const;
 156     virtual void EnableTextChangedEvents(bool enable);
 157
 158     void Init();
 159
 160     DECLARE_DYNAMIC_CLASS_NO_COPY(wxComboBox)
 161     DECLARE_EVENT_TABLE()
 162 };
 163
 164 #endif // _WX_GTK_COMBOBOX_H_