include/wx/mac/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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
  13 #ifndef _WX_LISTBOX_H_
  14 #define _WX_LISTBOX_H_
  15
  16 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  17     #pragma interface "listbox.h"
  18 #endif
  19
  20 // ----------------------------------------------------------------------------
  21 // simple types
  22 // ----------------------------------------------------------------------------
  23 #include  "wx/dynarray.h"
  24
  25
  26 #if wxUSE_OWNER_DRAWN
  27   class WXDLLEXPORT wxOwnerDrawn;
  28
  29   // define the array of list box items
  30   #include  "wx/dynarray.h"
  31
  32   WX_DEFINE_EXPORTED_ARRAY(wxOwnerDrawn *, wxListBoxItemsArray);
  33 #endif // wxUSE_OWNER_DRAWN
  34
  35 // forward decl for GetSelections()
  36 class wxArrayInt;
  37
  38 // List box item
  39
  40 WX_DEFINE_ARRAY( char * , wxListDataArray ) ;
  41
  42 // ----------------------------------------------------------------------------
  43 // List box control
  44 // ----------------------------------------------------------------------------
  45
  46 class WXDLLEXPORT wxListBox : public wxListBoxBase
  47 {
  48 public:
  49     // ctors and such
  50     wxListBox();
  51     wxListBox(wxWindow *parent, wxWindowID id,
  52             const wxPoint& pos = wxDefaultPosition,
  53             const wxSize& size = wxDefaultSize,
  54             int n = 0, const wxString choices[] = NULL,
  55             long style = 0,
  56             const wxValidator& validator = wxDefaultValidator,
  57             const wxString& name = wxListBoxNameStr)
  58     {
  59         Create(parent, id, pos, size, n, choices, style, validator, name);
  60     }
  61
  62     bool Create(wxWindow *parent, wxWindowID id,
  63                 const wxPoint& pos = wxDefaultPosition,
  64                 const wxSize& size = wxDefaultSize,
  65                 int n = 0, const wxString choices[] = NULL,
  66                 long style = 0,
  67                 const wxValidator& validator = wxDefaultValidator,
  68                 const wxString& name = wxListBoxNameStr);
  69
  70     virtual ~wxListBox();
  71     virtual void Refresh(bool eraseBack = TRUE, const wxRect *rect = NULL);
  72
  73     // implement base class pure virtuals
  74     virtual void Clear();
  75     virtual void Delete(int n);
  76
  77     virtual int GetCount() const;
  78     virtual wxString GetString(int n) const;
  79     virtual void SetString(int n, const wxString& s);
  80     virtual int FindString(const wxString& s) const;
  81
  82     virtual bool IsSelected(int n) const;
  83     virtual void SetSelection(int n, bool select = TRUE);
  84     virtual int GetSelection() const;
  85     virtual int GetSelections(wxArrayInt& aSelections) const;
  86
  87     virtual int DoAppend(const wxString& item);
  88     virtual void DoInsertItems(const wxArrayString& items, int pos);
  89     virtual void DoSetItems(const wxArrayString& items, void **clientData);
  90
  91     virtual void DoSetFirstItem(int n);
  92
  93     virtual void DoSetItemClientData(int n, void* clientData);
  94     virtual void* DoGetItemClientData(int n) const;
  95     virtual void DoSetItemClientObject(int n, wxClientData* clientData);
  96     virtual wxClientData* DoGetItemClientObject(int n) const;
  97     virtual void       DoSetSize(int x, int y,int width, int height,int sizeFlags = wxSIZE_AUTO ) ;
  98
  99     // wxCheckListBox support
 100 #if wxUSE_OWNER_DRAWN
 101     // plug-in for derived classes
 102     virtual wxOwnerDrawn *CreateItem(size_t n);
 103
 104     // allows to get the item and use SetXXX functions to set it's appearance
 105     wxOwnerDrawn *GetItem(size_t n) const { return m_aItems[n]; }
 106
 107     // get the index of the given item
 108     int GetItemIndex(wxOwnerDrawn *item) const { return m_aItems.Index(item); }
 109 #endif // wxUSE_OWNER_DRAWN
 110
 111     // Windows callbacks
 112
 113     virtual void    SetupColours();
 114     virtual void    MacHandleControlClick( WXWidget control , wxInt16 controlpart , bool mouseStillDown ) ;
 115        virtual bool MacCanFocus() const { return true ; }
 116     void OnChar(wxKeyEvent& event);
 117
 118     void*           m_macList ;
 119     wxArrayString   m_stringArray ;
 120     wxListDataArray m_dataArray ;
 121     wxArrayInt      m_selectionPreImage ;
 122     void            MacSetRedraw( bool doDraw ) ;
 123 protected:
 124     void            MacDestroy() ;
 125     void            MacDelete( int n ) ;
 126     void            MacInsert( int n , const wxString& item) ;
 127     void            MacAppend( const wxString& item) ;
 128     void            MacSet( int n , const wxString& item ) ;
 129     void            MacClear() ;
 130     void            MacSetSelection( int n , bool select ) ;
 131     int             MacGetSelection() const ;
 132     int             MacGetSelections(wxArrayInt& aSelections) const ;
 133     bool            MacIsSelected( int n ) const ;
 134     void            MacScrollTo( int n ) ;
 135     void            OnSize( const wxSizeEvent &size ) ;
 136     void            MacDoClick() ;
 137     void            MacDoDoubleClick() ;
 138
 139     // do we have multiple selections?
 140     bool HasMultipleSelection() const;
 141
 142     // free memory (common part of Clear() and dtor)
 143     // prevent collision with some BSD definitions of macro Free()
 144     void FreeData();
 145
 146     int m_noItems;
 147     int m_selected;
 148     wxString  m_typeIn ;
 149     long      m_lastTypeIn ;
 150
 151     virtual wxSize DoGetBestSize() const;
 152
 153 #if wxUSE_OWNER_DRAWN
 154     // control items
 155     wxListBoxItemsArray m_aItems;
 156 #endif
 157
 158 private:
 159     DECLARE_DYNAMIC_CLASS(wxListBox)
 160     DECLARE_EVENT_TABLE()
 161 };
 162
 163 #endif
 164     // _WX_LISTBOX_H_