include/wx/msw/choice.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "choice.h"
  17 #endif
  18
  19 // ----------------------------------------------------------------------------
  20 // Choice item
  21 // ----------------------------------------------------------------------------
  22
  23 class WXDLLEXPORT wxChoice : public wxChoiceBase
  24 {
  25 public:
  26     // ctors
  27     wxChoice() { Init(); }
  28     virtual ~wxChoice();
  29
  30     wxChoice(wxWindow *parent,
  31              wxWindowID id,
  32              const wxPoint& pos = wxDefaultPosition,
  33              const wxSize& size = wxDefaultSize,
  34              int n = 0, const wxString choices[] = NULL,
  35              long style = 0,
  36              const wxValidator& validator = wxDefaultValidator,
  37              const wxString& name = wxChoiceNameStr)
  38     {
  39         Init();
  40         Create(parent, id, pos, size, n, choices, style, validator, name);
  41     }
  42
  43     wxChoice(wxWindow *parent,
  44              wxWindowID id,
  45              const wxPoint& pos,
  46              const wxSize& size,
  47              const wxArrayString& choices,
  48              long style = 0,
  49              const wxValidator& validator = wxDefaultValidator,
  50              const wxString& name = wxChoiceNameStr)
  51     {
  52         Init();
  53         Create(parent, id, pos, size, choices, style, validator, name);
  54     }
  55
  56     bool Create(wxWindow *parent,
  57                 wxWindowID id,
  58                 const wxPoint& pos = wxDefaultPosition,
  59                 const wxSize& size = wxDefaultSize,
  60                 int n = 0, const wxString choices[] = NULL,
  61                 long style = 0,
  62                 const wxValidator& validator = wxDefaultValidator,
  63                 const wxString& name = wxChoiceNameStr);
  64     bool Create(wxWindow *parent,
  65                 wxWindowID id,
  66                 const wxPoint& pos,
  67                 const wxSize& size,
  68                 const wxArrayString& choices,
  69                 long style = 0,
  70                 const wxValidator& validator = wxDefaultValidator,
  71                 const wxString& name = wxChoiceNameStr);
  72
  73     // implement base class pure virtuals
  74     virtual int DoAppend(const wxString& item);
  75     virtual int DoInsert(const wxString& item, int pos);
  76     virtual void Delete(int n);
  77     virtual void Clear();
  78
  79     virtual int GetCount() const;
  80     virtual int GetSelection() const;
  81 #if wxABI_VERSION >= 20602
  82     virtual int GetCurrentSelection() const;
  83 #endif
  84     virtual void SetSelection(int n);
  85
  86     virtual int FindString(const wxString& s) const;
  87     virtual wxString GetString(int n) const;
  88     virtual void SetString(int n, const wxString& s);
  89
  90     // MSW only
  91     virtual bool MSWCommand(WXUINT param, WXWORD id);
  92     WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
  93     virtual WXHBRUSH MSWControlColor(WXHDC hDC, WXHWND hWnd);
  94
  95 protected:
  96     // common part of all ctors
  97     void Init() { m_lastAcceptedSelection = wxID_NONE; }
  98
  99     virtual void DoMoveWindow(int x, int y, int width, int height);
 100     virtual void DoSetItemClientData( int n, void* clientData );
 101     virtual void* DoGetItemClientData( int n ) const;
 102     virtual void DoSetItemClientObject( int n, wxClientData* clientData );
 103     virtual wxClientData* DoGetItemClientObject( int n ) const;
 104
 105     // MSW implementation
 106     virtual wxSize DoGetBestSize() const;
 107     virtual void DoGetSize(int *w, int *h) const;
 108     virtual void DoSetSize(int x, int y,
 109                            int width, int height,
 110                            int sizeFlags = wxSIZE_AUTO);
 111
 112     virtual bool MSWShouldPreProcessMessage(WXMSG *pMsg);
 113
 114     virtual WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 115
 116     // update the height of the drop down list to fit the number of items we
 117     // have (without changing the visible height)
 118     void UpdateVisibleHeight();
 119
 120     // create and initialize the control
 121     bool CreateAndInit(wxWindow *parent, wxWindowID id,
 122                        const wxPoint& pos,
 123                        const wxSize& size,
 124                        int n, const wxString choices[],
 125                        long style,
 126                        const wxValidator& validator,
 127                        const wxString& name);
 128
 129     // free all memory we have (used by Clear() and dtor)
 130     void Free();
 131
 132
 133     // last "completed" selection, i.e. not the transient one while the user is
 134     // browsing the popup list: this is only used when != wxID_NONE which is
 135     // the case while the drop down is opened
 136     int m_lastAcceptedSelection;
 137
 138
 139     DECLARE_DYNAMIC_CLASS_NO_COPY(wxChoice)
 140 };
 141
 142 #endif // _WX_CHOICE_H_