include/wx/combobox.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/combobox.h
   3 // Purpose:     wxComboBox declaration
   4 // Author:      Vadim Zeitlin
   5 // Modified by:
   6 // Created:     24.12.00
   7 // Copyright:   (c) 1996-2000 wxWidgets team
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_COMBOBOX_H_BASE_
  12 #define _WX_COMBOBOX_H_BASE_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_COMBOBOX
  17
  18 // For compatibility with 2.8 include this header to allow using wxTE_XXX
  19 // styles with wxComboBox without explicitly including it in the user code.
  20 #include "wx/textctrl.h"
  21
  22 extern WXDLLIMPEXP_DATA_CORE(const char) wxComboBoxNameStr[];
  23
  24 // ----------------------------------------------------------------------------
  25 // wxComboBoxBase: this interface defines the methods wxComboBox must implement
  26 // ----------------------------------------------------------------------------
  27
  28 #include "wx/ctrlsub.h"
  29 #include "wx/textentry.h"
  30
  31 class WXDLLIMPEXP_CORE wxComboBoxBase : public wxItemContainer,
  32                                         public wxTextEntry
  33 {
  34 public:
  35     // override these methods to disambiguate between two base classes versions
  36     virtual void Clear()
  37     {
  38         wxTextEntry::Clear();
  39         wxItemContainer::Clear();
  40     }
  41
  42     // IsEmpty() is ambiguous because we inherit it from both wxItemContainer
  43     // and wxTextEntry, and even if defined it here to help the compiler with
  44     // choosing one of them, it would still be confusing for the human users of
  45     // this class. So instead define the clearly named methods below and leave
  46     // IsEmpty() ambiguous to trigger a compilation error if it's used.
  47     bool IsListEmpty() const { return wxItemContainer::IsEmpty(); }
  48     bool IsTextEmpty() const { return wxTextEntry::IsEmpty(); }
  49
  50     // also bring in GetSelection() versions of both base classes in scope
  51     //
  52     // NB: GetSelection(from, to) could be already implemented in wxTextEntry
  53     //     but still make it pure virtual because for some platforms it's not
  54     //     implemented there and also because the derived class has to override
  55     //     it anyhow to avoid ambiguity with the other GetSelection()
  56     virtual int GetSelection() const = 0;
  57     virtual void GetSelection(long *from, long *to) const = 0;
  58
  59     virtual void Popup() { wxFAIL_MSG( wxT("Not implemented") ); }
  60     virtual void Dismiss() { wxFAIL_MSG( wxT("Not implemented") ); }
  61
  62     // may return value different from GetSelection() when the combobox
  63     // dropdown is shown and the user selected, but not yet accepted, a value
  64     // different from the old one in it
  65     virtual int GetCurrentSelection() const { return GetSelection(); }
  66 };
  67
  68 // ----------------------------------------------------------------------------
  69 // include the platform-dependent header defining the real class
  70 // ----------------------------------------------------------------------------
  71
  72 #if defined(__WXUNIVERSAL__)
  73     #include "wx/univ/combobox.h"
  74 #elif defined(__WXMSW__)
  75     #include "wx/msw/combobox.h"
  76 #elif defined(__WXMOTIF__)
  77     #include "wx/motif/combobox.h"
  78 #elif defined(__WXGTK20__)
  79     #include "wx/gtk/combobox.h"
  80 #elif defined(__WXGTK__)
  81     #include "wx/gtk1/combobox.h"
  82 #elif defined(__WXMAC__)
  83     #include "wx/osx/combobox.h"
  84 #elif defined(__WXCOCOA__)
  85     #include "wx/cocoa/combobox.h"
  86 #elif defined(__WXPM__)
  87     #include "wx/os2/combobox.h"
  88 #endif
  89
  90 #endif // wxUSE_COMBOBOX
  91
  92 #endif // _WX_COMBOBOX_H_BASE_