include/wx/msw/choice.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/choice.h
   3 // Purpose:     wxChoice class
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin to derive from wxChoiceBase
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_CHOICE_H_
  13 #define _WX_CHOICE_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // Choice item
  17 // ----------------------------------------------------------------------------
  18
  19 class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase
  20 {
  21 public:
  22     // ctors
  23     wxChoice() { Init(); }
  24     virtual ~wxChoice();
  25
  26     wxChoice(wxWindow *parent,
  27              wxWindowID id,
  28              const wxPoint& pos = wxDefaultPosition,
  29              const wxSize& size = wxDefaultSize,
  30              int n = 0, const wxString choices[] = NULL,
  31              long style = 0,
  32              const wxValidator& validator = wxDefaultValidator,
  33              const wxString& name = wxChoiceNameStr)
  34     {
  35         Init();
  36         Create(parent, id, pos, size, n, choices, style, validator, name);
  37     }
  38
  39     wxChoice(wxWindow *parent,
  40              wxWindowID id,
  41              const wxPoint& pos,
  42              const wxSize& size,
  43              const wxArrayString& choices,
  44              long style = 0,
  45              const wxValidator& validator = wxDefaultValidator,
  46              const wxString& name = wxChoiceNameStr)
  47     {
  48         Init();
  49         Create(parent, id, pos, size, choices, style, validator, name);
  50     }
  51
  52     bool Create(wxWindow *parent,
  53                 wxWindowID id,
  54                 const wxPoint& pos = wxDefaultPosition,
  55                 const wxSize& size = wxDefaultSize,
  56                 int n = 0, const wxString choices[] = NULL,
  57                 long style = 0,
  58                 const wxValidator& validator = wxDefaultValidator,
  59                 const wxString& name = wxChoiceNameStr);
  60     bool Create(wxWindow *parent,
  61                 wxWindowID id,
  62                 const wxPoint& pos,
  63                 const wxSize& size,
  64                 const wxArrayString& choices,
  65                 long style = 0,
  66                 const wxValidator& validator = wxDefaultValidator,
  67                 const wxString& name = wxChoiceNameStr);
  68
  69     virtual void SetLabel(const wxString& label);
  70
  71     virtual unsigned int GetCount() const;
  72     virtual int GetSelection() const;
  73     virtual int GetCurrentSelection() const;
  74     virtual void SetSelection(int n);
  75
  76     virtual int FindString(const wxString& s, bool bCase = false) const;
  77     virtual wxString GetString(unsigned int n) const;
  78     virtual void SetString(unsigned int n, const wxString& s);
  79
  80     // MSW only
  81     virtual bool MSWCommand(WXUINT param, WXWORD id);
  82     WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  83     virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
  84     virtual bool MSWShouldPreProcessMessage(WXMSG *pMsg);
  85     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
  86
  87     // returns true if the platform should explicitly apply a theme border
  88     virtual bool CanApplyThemeBorder() const { return false; }
  89
  90 protected:
  91     // choose the default border for this window
  92     virtual wxBorder GetDefaultBorder() const { return wxBORDER_NONE; }
  93
  94     // common part of all ctors
  95     void Init() { m_lastAcceptedSelection = wxID_NONE; }
  96
  97     virtual void DoDeleteOneItem(unsigned int n);
  98     virtual void DoClear();
  99
 100     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
 101                               unsigned int pos,
 102                               void **clientData, wxClientDataType type);
 103
 104     virtual void DoMoveWindow(int x, int y, int width, int height);
 105     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 106     virtual void* DoGetItemClientData(unsigned int n) const;
 107
 108     // MSW implementation
 109     virtual wxSize DoGetBestSize() const;
 110     virtual void DoGetSize(int *w, int *h) const;
 111     virtual void DoSetSize(int x, int y,
 112                            int width, int height,
 113                            int sizeFlags = wxSIZE_AUTO);
 114
 115     // update the height of the drop down list to fit the number of items we
 116     // have (without changing the visible height)
 117     void UpdateVisibleHeight();
 118
 119     // create and initialize the control
 120     bool CreateAndInit(wxWindow *parent, wxWindowID id,
 121                        const wxPoint& pos,
 122                        const wxSize& size,
 123                        int n, const wxString choices[],
 124                        long style,
 125                        const wxValidator& validator,
 126                        const wxString& name);
 127
 128     // free all memory we have (used by Clear() and dtor)
 129     void Free();
 130
 131
 132     // last "completed" selection, i.e. not the transient one while the user is
 133     // browsing the popup list: this is only used when != wxID_NONE which is
 134     // the case while the drop down is opened
 135     int m_lastAcceptedSelection;
 136
 137
 138     DECLARE_DYNAMIC_CLASS_NO_COPY(wxChoice)
 139 };
 140
 141 #endif // _WX_CHOICE_H_