include/wx/osx/carbon/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/mac/carbon/listbox.h
   3 // Purpose:     wxListBox class
   4 // Author:      Stefan Csomor
   5 // Modified by:
   6 // Created:     1998-01-01
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Stefan Csomor
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTBOX_H_
  13 #define _WX_LISTBOX_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // simple types
  17 // ----------------------------------------------------------------------------
  18 #include  "wx/dynarray.h"
  19 #include  "wx/arrstr.h"
  20
  21 // forward decl for GetSelections()
  22 class wxArrayInt;
  23
  24 // forward decl for wxMacListControl data type.
  25 class wxMacListControl;
  26
  27 // List box item
  28
  29 WX_DEFINE_ARRAY( char* , wxListDataArray );
  30
  31 // ----------------------------------------------------------------------------
  32 // List box control
  33 // ----------------------------------------------------------------------------
  34
  35 class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
  36 {
  37 public:
  38     // ctors and such
  39     wxListBox();
  40
  41     wxListBox(
  42         wxWindow *parent,
  43         wxWindowID winid,
  44         const wxPoint& pos = wxDefaultPosition,
  45         const wxSize& size = wxDefaultSize,
  46         int n = 0, const wxString choices[] = NULL,
  47         long style = 0,
  48         const wxValidator& validator = wxDefaultValidator,
  49         const wxString& name = wxListBoxNameStr)
  50     {
  51         Create(parent, winid, pos, size, n, choices, style, validator, name);
  52     }
  53
  54     wxListBox(
  55         wxWindow *parent,
  56         wxWindowID winid,
  57         const wxPoint& pos,
  58         const wxSize& size,
  59         const wxArrayString& choices,
  60         long style = 0,
  61         const wxValidator& validator = wxDefaultValidator,
  62         const wxString& name = wxListBoxNameStr)
  63     {
  64         Create(parent, winid, pos, size, choices, style, validator, name);
  65     }
  66
  67     bool Create(
  68         wxWindow *parent,
  69         wxWindowID winid,
  70         const wxPoint& pos = wxDefaultPosition,
  71         const wxSize& size = wxDefaultSize,
  72         int n = 0,
  73         const wxString choices[] = NULL,
  74         long style = 0,
  75         const wxValidator& validator = wxDefaultValidator,
  76         const wxString& name = wxListBoxNameStr);
  77
  78     bool Create(
  79         wxWindow *parent,
  80         wxWindowID winid,
  81         const wxPoint& pos,
  82         const wxSize& size,
  83         const wxArrayString& choices,
  84         long style = 0,
  85         const wxValidator& validator = wxDefaultValidator,
  86         const wxString& name = wxListBoxNameStr);
  87
  88     virtual ~wxListBox();
  89
  90     // implement base class pure virtuals
  91     virtual void Refresh(bool eraseBack = true, const wxRect *rect = NULL);
  92
  93     virtual unsigned int GetCount() const;
  94     virtual wxString GetString(unsigned int n) const;
  95     virtual void SetString(unsigned int n, const wxString& s);
  96     virtual int FindString(const wxString& s, bool bCase = false) const;
  97
  98     virtual bool IsSelected(int n) const;
  99     virtual int GetSelection() const;
 100     virtual int GetSelections(wxArrayInt& aSelections) const;
 101
 102     virtual void EnsureVisible(int n);
 103
 104     virtual wxVisualAttributes GetDefaultAttributes() const
 105     {
 106         return GetClassDefaultAttributes(GetWindowVariant());
 107     }
 108
 109     // wxCheckListBox support
 110     static wxVisualAttributes
 111     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 112
 113     wxMacListControl* GetPeer() const;
 114
 115     bool MacGetBlockEvents() const { return m_blockEvents; }
 116
 117 protected:
 118     virtual void DoClear();
 119     virtual void DoDeleteOneItem(unsigned int n);
 120
 121     // from wxItemContainer
 122     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
 123                               unsigned int pos,
 124                               void **clientData, wxClientDataType type);
 125
 126     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 127     virtual void* DoGetItemClientData(unsigned int n) const;
 128
 129     // from wxListBoxBase
 130     virtual void DoSetSelection(int n, bool select);
 131     virtual void DoSetFirstItem(int n);
 132     virtual int DoListHitTest(const wxPoint& point) const;
 133
 134     // free memory (common part of Clear() and dtor)
 135     // prevent collision with some BSD definitions of macro Free()
 136     void FreeData();
 137
 138     virtual wxSize DoGetBestSize() const;
 139
 140     bool m_blockEvents;
 141
 142 private:
 143     DECLARE_DYNAMIC_CLASS(wxListBox)
 144     DECLARE_EVENT_TABLE()
 145 };
 146
 147 #endif // _WX_LISTBOX_H_