include/wx/gtk/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/gtk/listbox.h
   3 // Purpose:     wxListBox class declaration
   4 // Author:      Robert Roebling
   5 // Id:          $Id$
   6 // Copyright:   (c) 1998 Robert Roebling
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GTK_LISTBOX_H_
  11 #define _WX_GTK_LISTBOX_H_
  12
  13 struct _GtkTreeEntry;
  14 struct _GtkTreeIter;
  15
  16 //-----------------------------------------------------------------------------
  17 // wxListBox
  18 //-----------------------------------------------------------------------------
  19
  20 class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
  21 {
  22 public:
  23     // ctors and such
  24     wxListBox()
  25     {
  26         Init();
  27     }
  28     wxListBox( wxWindow *parent, wxWindowID id,
  29             const wxPoint& pos = wxDefaultPosition,
  30             const wxSize& size = wxDefaultSize,
  31             int n = 0, const wxString choices[] = (const wxString *) NULL,
  32             long style = 0,
  33             const wxValidator& validator = wxDefaultValidator,
  34             const wxString& name = wxListBoxNameStr )
  35     {
  36         Init();
  37         Create(parent, id, pos, size, n, choices, style, validator, name);
  38     }
  39     wxListBox( wxWindow *parent, wxWindowID id,
  40             const wxPoint& pos,
  41             const wxSize& size,
  42             const wxArrayString& choices,
  43             long style = 0,
  44             const wxValidator& validator = wxDefaultValidator,
  45             const wxString& name = wxListBoxNameStr )
  46     {
  47         Init();
  48         Create(parent, id, pos, size, choices, style, validator, name);
  49     }
  50     virtual ~wxListBox();
  51
  52     bool Create(wxWindow *parent, wxWindowID id,
  53                 const wxPoint& pos = wxDefaultPosition,
  54                 const wxSize& size = wxDefaultSize,
  55                 int n = 0, const wxString choices[] = (const wxString *) NULL,
  56                 long style = 0,
  57                 const wxValidator& validator = wxDefaultValidator,
  58                 const wxString& name = wxListBoxNameStr);
  59     bool Create(wxWindow *parent, wxWindowID id,
  60                 const wxPoint& pos,
  61                 const wxSize& size,
  62                 const wxArrayString& choices,
  63                 long style = 0,
  64                 const wxValidator& validator = wxDefaultValidator,
  65                 const wxString& name = wxListBoxNameStr);
  66
  67     virtual unsigned int GetCount() const;
  68     virtual wxString GetString(unsigned int n) const;
  69     virtual void SetString(unsigned int n, const wxString& s);
  70     virtual int FindString(const wxString& s, bool bCase = false) const;
  71
  72     virtual bool IsSelected(int n) const;
  73     virtual int GetSelection() const;
  74     virtual int GetSelections(wxArrayInt& aSelections) const;
  75
  76     virtual void EnsureVisible(int n);
  77
  78     static wxVisualAttributes
  79     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  80
  81     // implementation from now on
  82
  83     GtkWidget *GetConnectWidget();
  84
  85 #if wxUSE_TOOLTIPS
  86     void ApplyToolTip( GtkTooltips *tips, const gchar *tip );
  87 #endif // wxUSE_TOOLTIPS
  88
  89     struct _GtkTreeView   *m_treeview;
  90     struct _GtkListStore  *m_liststore;
  91
  92 #if wxUSE_CHECKLISTBOX
  93     bool       m_hasCheckBoxes;
  94 #endif // wxUSE_CHECKLISTBOX
  95
  96     bool       m_blockEvent;
  97
  98     struct _GtkTreeEntry* GtkGetEntry(unsigned pos) const;
  99     void GtkDeselectAll();
 100     void GtkSetSelection(int n, const bool select, const bool blockEvent);
 101
 102 protected:
 103     virtual void DoClear();
 104     virtual void DoDeleteOneItem(unsigned int n);
 105     virtual wxSize DoGetBestSize() const;
 106     virtual void DoApplyWidgetStyle(GtkRcStyle *style);
 107     virtual GdkWindow *GTKGetWindow(wxArrayGdkWindows& windows) const;
 108
 109     virtual void DoSetSelection(int n, bool select);
 110
 111     virtual int DoInsertItems(const wxArrayStringsAdapter& items,
 112                               unsigned int pos,
 113                               void **clientData, wxClientDataType type);
 114
 115     virtual void DoSetFirstItem(int n);
 116     virtual void DoSetItemClientData(unsigned int n, void* clientData);
 117     virtual void* DoGetItemClientData(unsigned int n) const;
 118     virtual int DoListHitTest(const wxPoint& point) const;
 119
 120     // get the iterator for the given index, returns false if invalid
 121     bool GtkGetIteratorFor(unsigned pos, _GtkTreeIter *iter) const;
 122
 123     // get the index for the given iterator, return wxNOT_FOUND on failure
 124     int GtkGetIndexFor(_GtkTreeIter& iter) const;
 125
 126     // set the specified item
 127     void GtkSetItem(_GtkTreeIter& iter, const _GtkTreeEntry *entry);
 128
 129     // common part of DoSetFirstItem() and EnsureVisible()
 130     void DoScrollToCell(int n, float alignY, float alignX);
 131
 132 private:
 133     void Init(); //common construction
 134
 135     DECLARE_DYNAMIC_CLASS(wxListBox)
 136 };
 137
 138 #endif // _WX_GTK_LISTBOX_H_