include/wx/palmos/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/palmos/listbox.h
   3 // Purpose:     wxListBox class
   4 // Author:      William Osborne - minimal working wxPalmOS port
   5 // Modified by:
   6 // Created:     10/13/04
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) William Osborne
   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 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     // implement base class pure virtuals
  81     virtual void DoClear();
  82     virtual void DoDeleteOneItem(unsigned int n);
  83
  84     virtual unsigned int GetCount() const;
  85     virtual wxString GetString(unsigned int n) const;
  86     virtual void SetString(unsigned int n, const wxString& s);
  87
  88     virtual bool IsSelected(int n) const;
  89     virtual void DoSetSelection(int n, bool select);
  90     virtual int GetSelection() const;
  91     virtual int GetSelections(wxArrayInt& aSelections) const;
  92
  93     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
  94                               unsigned int pos,
  95                               void **clientData, wxClientDataType type);
  96
  97     virtual void DoSetFirstItem(int n);
  98
  99     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 100     virtual void* DoGetItemClientData(unsigned int n) const;
 101
 102     // wxCheckListBox support
 103 #if wxUSE_OWNER_DRAWN
 104     bool MSWOnMeasure(WXMEASUREITEMSTRUCT *item);
 105     bool MSWOnDraw(WXDRAWITEMSTRUCT *item);
 106
 107     // plug-in for derived classes
 108     virtual wxOwnerDrawn *CreateLboxItem(size_t n);
 109
 110     // allows to get the item and use SetXXX functions to set it's appearance
 111     wxOwnerDrawn *GetItem(size_t n) const { return m_aItems[n]; }
 112
 113     // get the index of the given item
 114     int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); }
 115 #endif // wxUSE_OWNER_DRAWN
 116
 117     // Windows-specific code to set the horizontal extent of the listbox, if
 118     // necessary. If s is non-NULL, it's used to calculate the horizontal
 119     // extent. Otherwise, all strings are used.
 120     virtual void SetHorizontalExtent(const wxString& s = wxEmptyString);
 121
 122     // Windows callbacks
 123     bool MSWCommand(WXUINT param, WXWORD id);
 124
 125     virtual wxVisualAttributes GetDefaultAttributes() const
 126     {
 127         return GetClassDefaultAttributes(GetWindowVariant());
 128     }
 129
 130     static wxVisualAttributes
 131     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL)
 132     {
 133         return GetCompositeControlsDefaultAttributes(variant);
 134     }
 135
 136 protected:
 137     WXDWORD MSWGetStyle(long style, WXDWORD *exstyle) const;
 138
 139     // free memory (common part of Clear() and dtor)
 140     void Free();
 141
 142     int m_selected;
 143
 144     virtual wxSize DoGetBestSize() const;
 145
 146 #if wxUSE_OWNER_DRAWN
 147     // control items
 148     wxListBoxItemsArray m_aItems;
 149 #endif
 150
 151 private:
 152     DECLARE_DYNAMIC_CLASS_NO_COPY(wxListBox)
 153 };
 154
 155 #endif // wxUSE_LISTBOX
 156
 157 #endif
 158     // _WX_LISTBOX_H_