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     ~wxComboBox();
  60
  61     bool Create(wxWindow *parent, wxWindowID id,
  62                 const wxString& value = wxEmptyString,
  63                 const wxPoint& pos = wxDefaultPosition,
  64                 const wxSize& size = wxDefaultSize,
  65                 int n = 0, const wxString choices[] = (const wxString *) NULL,
  66                 long style = 0,
  67                 const wxValidator& validator = wxDefaultValidator,
  68                 const wxString& name = wxComboBoxNameStr);
  69     bool Create(wxWindow *parent, wxWindowID id,
  70                 const wxString& value,
  71                 const wxPoint& pos,
  72                 const wxSize& size,
  73                 const wxArrayString& choices,
  74                 long style = 0,
  75                 const wxValidator& validator = wxDefaultValidator,
  76                 const wxString& name = wxComboBoxNameStr);
  77
  78     // Set/GetSelection() from wxTextEntry and wxChoice
  79
  80     virtual void SetSelection(int n) { wxChoice::SetSelection(n); }
  81     virtual void SetSelection(long from, long to)
  82                                { wxTextEntry::SetSelection(from, to); }
  83
  84     virtual int GetSelection() const { return wxChoice::GetSelection(); }
  85     virtual void GetSelection(long *from, long *to) const
  86                                { return wxTextEntry::GetSelection(from, to); }
  87
  88     virtual wxString GetStringSelection() const
  89     {
  90         return wxItemContainer::GetStringSelection();
  91     }
  92
  93     virtual void SetString(unsigned int n, const wxString& string);
  94
  95     virtual void Popup();
  96     virtual void Dismiss();
  97
  98     virtual void Clear()
  99     {
 100         wxTextEntry::Clear();
 101         wxItemContainer::Clear();
 102     }
 103
 104     // See wxComboBoxBase discussion of IsEmpty().
 105     bool IsListEmpty() const { return wxItemContainer::IsEmpty(); }
 106     bool IsTextEmpty() const { return wxTextEntry::IsEmpty(); }
 107
 108     void OnChar( wxKeyEvent &event );
 109
 110     virtual void SetValue(const wxString& value);
 111
 112     // Standard event handling
 113     void OnCut(wxCommandEvent& event);
 114     void OnCopy(wxCommandEvent& event);
 115     void OnPaste(wxCommandEvent& event);
 116     void OnUndo(wxCommandEvent& event);
 117     void OnRedo(wxCommandEvent& event);
 118     void OnDelete(wxCommandEvent& event);
 119     void OnSelectAll(wxCommandEvent& event);
 120
 121     void OnUpdateCut(wxUpdateUIEvent& event);
 122     void OnUpdateCopy(wxUpdateUIEvent& event);
 123     void OnUpdatePaste(wxUpdateUIEvent& event);
 124     void OnUpdateUndo(wxUpdateUIEvent& event);
 125     void OnUpdateRedo(wxUpdateUIEvent& event);
 126     void OnUpdateDelete(wxUpdateUIEvent& event);
 127     void OnUpdateSelectAll(wxUpdateUIEvent& event);
 128
 129     virtual void GTKDisableEvents();
 130     virtual void GTKEnableEvents();
 131     GtkWidget* GetConnectWidget();
 132
 133     static wxVisualAttributes
 134     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 135
 136 protected:
 137     // From wxWindowGTK:
 138     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 139
 140     // Widgets that use the style->base colour for the BG colour should
 141     // override this and return true.
 142     virtual bool UseGTKStyleBase() const { return true; }
 143
 144     // Override in derived classes to create combo box widgets with
 145     // custom list stores.
 146     virtual void GTKCreateComboBoxWidget();
 147
 148     virtual wxSize DoGetSizeFromTextSize(int xlen, int ylen = -1) const;
 149
 150     virtual GtkEntry *GetEntry() const
 151         { return m_entry; }
 152
 153     GtkEntry*   m_entry;
 154
 155 private:
 156     // From wxTextEntry:
 157     virtual wxWindow *GetEditableWindow() { return this; }
 158     virtual GtkEditable *GetEditable() const;
 159     virtual void EnableTextChangedEvents(bool enable);
 160
 161     void Init();
 162
 163     DECLARE_DYNAMIC_CLASS_NO_COPY(wxComboBox)
 164     DECLARE_EVENT_TABLE()
 165 };
 166
 167 #endif // _WX_GTK_COMBOBOX_H_