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 WXDLLEXPORT 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 unsigned int GetCount() const;
  70     virtual int GetSelection() const;
  71     virtual int GetCurrentSelection() const;
  72     virtual void SetSelection(int n);
  73
  74     virtual int FindString(const wxString& s, bool bCase = false) const;
  75     virtual wxString GetString(unsigned int n) const;
  76     virtual void SetString(unsigned int n, const wxString& s);
  77
  78     // MSW only
  79     virtual bool MSWCommand(WXUINT param, WXWORD id);
  80     WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  81     virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
  82     virtual bool MSWShouldPreProcessMessage(WXMSG *pMsg);
  83     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
  84
  85     // returns true if the platform should explicitly apply a theme border
  86     virtual bool CanApplyThemeBorder() const { return false; }
  87
  88 protected:
  89     // common part of all ctors
  90     void Init() { m_lastAcceptedSelection = wxID_NONE; }
  91
  92     virtual void DoDeleteOneItem(unsigned int n);
  93     virtual void DoClear();
  94
  95     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
  96                               unsigned int pos,
  97                               void **clientData, wxClientDataType type);
  98
  99     virtual void DoMoveWindow(int x, int y, int width, int height);
 100     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 101     virtual void* DoGetItemClientData(unsigned int n) const;
 102
 103     // MSW implementation
 104     virtual wxSize DoGetBestSize() const;
 105     virtual void DoGetSize(int *w, int *h) const;
 106     virtual void DoSetSize(int x, int y,
 107                            int width, int height,
 108                            int sizeFlags = wxSIZE_AUTO);
 109
 110     // update the height of the drop down list to fit the number of items we
 111     // have (without changing the visible height)
 112     void UpdateVisibleHeight();
 113
 114     // create and initialize the control
 115     bool CreateAndInit(wxWindow *parent, wxWindowID id,
 116                        const wxPoint& pos,
 117                        const wxSize& size,
 118                        int n, const wxString choices[],
 119                        long style,
 120                        const wxValidator& validator,
 121                        const wxString& name);
 122
 123     // free all memory we have (used by Clear() and dtor)
 124     void Free();
 125
 126
 127     // last "completed" selection, i.e. not the transient one while the user is
 128     // browsing the popup list: this is only used when != wxID_NONE which is
 129     // the case while the drop down is opened
 130     int m_lastAcceptedSelection;
 131
 132
 133     DECLARE_DYNAMIC_CLASS_NO_COPY(wxChoice)
 134 };
 135
 136 #endif // _WX_CHOICE_H_