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 __GTKLISTBOXH__
  11 #define __GTKLISTBOXH__
  12
  13 #include "wx/list.h"
  14
  15 class WXDLLIMPEXP_BASE wxSortedArrayString;
  16
  17 //-----------------------------------------------------------------------------
  18 // wxListBox
  19 //-----------------------------------------------------------------------------
  20
  21 class WXDLLIMPEXP_CORE wxListBox : public wxListBoxBase
  22 {
  23 public:
  24     // ctors and such
  25     wxListBox();
  26     wxListBox( wxWindow *parent, wxWindowID id,
  27             const wxPoint& pos = wxDefaultPosition,
  28             const wxSize& size = wxDefaultSize,
  29             int n = 0, const wxString choices[] = (const wxString *) NULL,
  30             long style = 0,
  31             const wxValidator& validator = wxDefaultValidator,
  32             const wxString& name = wxListBoxNameStr )
  33     {
  34 #if wxUSE_CHECKLISTBOX
  35         m_hasCheckBoxes = FALSE;
  36 #endif // wxUSE_CHECKLISTBOX
  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 #if wxUSE_CHECKLISTBOX
  48         m_hasCheckBoxes = FALSE;
  49 #endif // wxUSE_CHECKLISTBOX
  50         Create(parent, id, pos, size, choices, style, validator, name);
  51     }
  52     virtual ~wxListBox();
  53
  54     bool Create(wxWindow *parent, wxWindowID id,
  55                 const wxPoint& pos = wxDefaultPosition,
  56                 const wxSize& size = wxDefaultSize,
  57                 int n = 0, const wxString choices[] = (const wxString *) NULL,
  58                 long style = 0,
  59                 const wxValidator& validator = wxDefaultValidator,
  60                 const wxString& name = wxListBoxNameStr);
  61     bool Create(wxWindow *parent, wxWindowID id,
  62                 const wxPoint& pos,
  63                 const wxSize& size,
  64                 const wxArrayString& choices,
  65                 long style = 0,
  66                 const wxValidator& validator = wxDefaultValidator,
  67                 const wxString& name = wxListBoxNameStr);
  68
  69     // implement base class pure virtuals
  70     virtual void Clear();
  71     virtual void Delete(int n);
  72
  73     virtual int GetCount() const;
  74     virtual wxString GetString(int n) const;
  75     virtual void SetString(int n, const wxString& s);
  76     virtual int FindString(const wxString& s, bool bCase = false) const;
  77
  78     virtual bool IsSelected(int n) const;
  79     virtual int GetSelection() const;
  80     virtual int GetSelections(wxArrayInt& aSelections) const;
  81
  82     static wxVisualAttributes
  83     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
  84
  85     // implementation from now on
  86
  87     void GtkAddItem( const wxString &item, int pos=-1 );
  88     int GtkGetIndex( GtkWidget *item ) const;
  89     GtkWidget *GetConnectWidget();
  90     bool IsOwnGtkWindow( GdkWindow *window );
  91     void OnInternalIdle();
  92
  93 #if wxUSE_TOOLTIPS
  94     void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
  95 #endif // wxUSE_TOOLTIPS
  96
  97     GtkList   *m_list;
  98     wxList     m_clientList;
  99
 100 #if wxUSE_CHECKLISTBOX
 101     bool       m_hasCheckBoxes;
 102 #endif // wxUSE_CHECKLISTBOX
 103
 104     int        m_prevSelection;
 105     bool       m_blockEvent;
 106
 107     virtual void FixUpMouseEvent(GtkWidget *widget, wxCoord& x, wxCoord& y);
 108
 109 protected:
 110     virtual wxSize DoGetBestSize() const;
 111     virtual void DoSetSelection(int n, bool select);
 112     virtual int DoAppend(const wxString& item);
 113     virtual void DoInsertItems(const wxArrayString& items, int pos);
 114     virtual void DoSetItems(const wxArrayString& items, void **clientData);
 115     virtual void DoSetFirstItem(int n);
 116     virtual void DoSetItemClientData(int n, void* clientData);
 117     virtual void* DoGetItemClientData(int n) const;
 118     virtual void DoSetItemClientObject(int n, wxClientData* clientData);
 119     virtual wxClientData* DoGetItemClientObject(int n) const;
 120     void DoApplyWidgetStyle(GtkRcStyle *style);
 121
 122     // return the string label for the given item
 123     wxString GetRealLabel(struct _GList *item) const;
 124
 125     // Widgets that use the style->base colour for the BG colour should
 126     // override this and return true.
 127     virtual bool UseGTKStyleBase() const { return true; }
 128
 129 private:
 130     // this array is only used for controls with wxCB_SORT style, so only
 131     // allocate it if it's needed (hence using pointer)
 132     wxSortedArrayString *m_strings;
 133
 134     DECLARE_DYNAMIC_CLASS(wxListBox)
 135 };
 136
 137 #endif // __GTKLISTBOXH__