include/wx/msw/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msw/listbox.h
   3 // Purpose:     wxListBox class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTBOX_H_
  13 #define _WX_LISTBOX_H_
  14
  15 #if wxUSE_LISTBOX
  16
  17 // ----------------------------------------------------------------------------
  18 // simple types
  19 // ----------------------------------------------------------------------------
  20
  21 #if wxUSE_OWNER_DRAWN
  22   class WXDLLIMPEXP_FWD_CORE wxOwnerDrawn;
  23
  24   // define the array of list box items
  25   #include  "wx/dynarray.h"
  26
  27   WX_DEFINE_EXPORTED_ARRAY_PTR(wxOwnerDrawn *, wxListBoxItemsArray);
  28 #endif // wxUSE_OWNER_DRAWN
  29
  30 // forward decl for GetSelections()
  31 class WXDLLIMPEXP_FWD_BASE wxArrayInt;
  32
  33 // ----------------------------------------------------------------------------
  34 // List box control
  35 // ----------------------------------------------------------------------------
  36
  37 class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
  38 {
  39 public:
  40     // ctors and such
  41     wxListBox();
  42     wxListBox(wxWindow *parent, wxWindowID id,
  43             const wxPoint& pos = wxDefaultPosition,
  44             const wxSize& size = wxDefaultSize,
  45             int n = 0, const wxString choices[] = NULL,
  46             long style = 0,
  47             const wxValidator& validator = wxDefaultValidator,
  48             const wxString& name = wxListBoxNameStr)
  49     {
  50         Create(parent, id, pos, size, n, choices, style, validator, name);
  51     }
  52     wxListBox(wxWindow *parent, wxWindowID id,
  53             const wxPoint& pos,
  54             const wxSize& size,
  55             const wxArrayString& choices,
  56             long style = 0,
  57             const wxValidator& validator = wxDefaultValidator,
  58             const wxString& name = wxListBoxNameStr)
  59     {
  60         Create(parent, id, pos, size, choices, style, validator, name);
  61     }
  62
  63     bool Create(wxWindow *parent, wxWindowID id,
  64                 const wxPoint& pos = wxDefaultPosition,
  65                 const wxSize& size = wxDefaultSize,
  66                 int n = 0, const wxString choices[] = NULL,
  67                 long style = 0,
  68                 const wxValidator& validator = wxDefaultValidator,
  69                 const wxString& name = wxListBoxNameStr);
  70     bool Create(wxWindow *parent, wxWindowID id,
  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 = wxListBoxNameStr);
  77
  78     virtual ~wxListBox();
  79
  80     virtual unsigned int GetCount() const;
  81     virtual wxString GetString(unsigned int n) const;
  82     virtual void SetString(unsigned int n, const wxString& s);
  83     virtual int FindString(const wxString& s, bool bCase = false) const;
  84
  85     virtual bool IsSelected(int n) const;
  86     virtual int GetSelection() const;
  87     virtual int GetSelections(wxArrayInt& aSelections) const;
  88
  89     // wxCheckListBox support
  90 #if wxUSE_OWNER_DRAWN
  91     bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item);
  92     bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
  93
  94     // plug-in for derived classes
  95     virtual wxOwnerDrawn *CreateLboxItem(size_t n);
  96
  97     // allows to get the item and use SetXXX functions to set it's appearance
  98     wxOwnerDrawn *GetItem(size_t n) const { return m_aItems[n]; }
  99
 100     // get the index of the given item
 101     int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); }
 102 #endif // wxUSE_OWNER_DRAWN
 103
 104     // Windows-specific code to update the horizontal extent of the listbox, if
 105     // necessary. If s is non-empty, the horizontal extent is increased to the
 106     // length of this string if it's currently too short, otherwise the maximum
 107     // extent of all strings is used. In any case calls InvalidateBestSize()
 108     virtual void SetHorizontalExtent(const wxString& s = wxEmptyString);
 109
 110     // Windows callbacks
 111     bool MSWCommand(WXUINT param, WXWORD id);
 112     WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 113
 114     // under XP when using "transition effect for menus and tooltips" if we
 115     // return true for WM_PRINTCLIENT here then it causes noticable slowdown
 116     virtual bool MSWShouldPropagatePrintChild()
 117     {
 118         return false;
 119     }
 120
 121     virtual wxVisualAttributes GetDefaultAttributes() const
 122     {
 123         return GetClassDefaultAttributes(GetWindowVariant());
 124     }
 125
 126     static wxVisualAttributes
 127     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
 128     {
 129         return GetCompositeControlsDefaultAttributes(variant);
 130     }
 131
 132     // returns true if the platform should explicitly apply a theme border
 133     virtual bool CanApplyThemeBorder() const { return false; }
 134
 135 protected:
 136     virtual void DoClear();
 137     virtual void DoDeleteOneItem(unsigned int n);
 138
 139     virtual void DoSetSelection(int n, bool select);
 140
 141     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
 142                               unsigned int pos,
 143                               void **clientData, wxClientDataType type);
 144
 145     virtual void DoSetFirstItem(int n);
 146     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 147     virtual void* DoGetItemClientData(unsigned int n) const;
 148     virtual int DoListHitTest(const wxPoint& point) const;
 149
 150     // free memory (common part of Clear() and dtor)
 151     void Free();
 152
 153     unsigned int m_noItems;
 154     int m_selected;
 155
 156     virtual wxSize DoGetBestSize() const;
 157
 158 #if wxUSE_OWNER_DRAWN
 159     // control items
 160     wxListBoxItemsArray m_aItems;
 161 #endif
 162
 163 private:
 164     DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox)
 165 };
 166
 167 #endif // wxUSE_LISTBOX
 168
 169 #endif
 170     // _WX_LISTBOX_H_