include/wx/gtk1/listbox.h

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