include/wx/gtk/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        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
  11 #ifndef __GTKLISTBOXH__
  12 #define __GTKLISTBOXH__
  13
  14 #if defined(__GNUG__) && !defined(__APPLE__)
  15 #pragma interface "listbox.h"
  16 #endif
  17
  18 #include "wx/list.h"
  19
  20 //-----------------------------------------------------------------------------
  21 // wxListBox
  22 //-----------------------------------------------------------------------------
  23
  24 class wxListBox : public wxListBoxBase
  25 {
  26 public:
  27     // ctors and such
  28     wxListBox();
  29     wxListBox( wxWindow *parent, wxWindowID id,
  30             const wxPoint& pos = wxDefaultPosition,
  31             const wxSize& size = wxDefaultSize,
  32             int n = 0, const wxString choices[] = (const wxString *) NULL,
  33             long style = 0,
  34             const wxValidator& validator = wxDefaultValidator,
  35             const wxString& name = wxListBoxNameStr )
  36     {
  37 #if wxUSE_CHECKLISTBOX
  38         m_hasCheckBoxes = FALSE;
  39 #endif // wxUSE_CHECKLISTBOX
  40         Create(parent, id, pos, size, n, choices, style, validator, name);
  41     }
  42     virtual ~wxListBox();
  43
  44     bool Create(wxWindow *parent, wxWindowID id,
  45                 const wxPoint& pos = wxDefaultPosition,
  46                 const wxSize& size = wxDefaultSize,
  47                 int n = 0, const wxString choices[] = (const wxString *) NULL,
  48                 long style = 0,
  49                 const wxValidator& validator = wxDefaultValidator,
  50                 const wxString& name = wxListBoxNameStr);
  51
  52     // implement base class pure virtuals
  53     virtual void Clear();
  54     virtual void Delete(int n);
  55
  56     virtual int GetCount() const;
  57     virtual wxString GetString(int n) const;
  58     virtual void SetString(int n, const wxString& s);
  59     virtual int FindString(const wxString& s) const;
  60
  61     virtual bool IsSelected(int n) const;
  62     virtual void SetSelection(int n, bool select = TRUE);
  63     virtual int GetSelection() const;
  64     virtual int GetSelections(wxArrayInt& aSelections) const;
  65
  66     virtual int DoAppend(const wxString& item);
  67     virtual void DoInsertItems(const wxArrayString& items, int pos);
  68     virtual void DoSetItems(const wxArrayString& items, void **clientData);
  69
  70     virtual void DoSetFirstItem(int n);
  71
  72     virtual void DoSetItemClientData(int n, void* clientData);
  73     virtual void* DoGetItemClientData(int n) const;
  74     virtual void DoSetItemClientObject(int n, wxClientData* clientData);
  75     virtual wxClientData* DoGetItemClientObject(int n) const;
  76
  77     // implementation from now on
  78
  79     void GtkAddItem( const wxString &item, int pos=-1 );
  80     int GtkGetIndex( GtkWidget *item ) const;
  81     GtkWidget *GetConnectWidget();
  82     bool IsOwnGtkWindow( GdkWindow *window );
  83     void ApplyWidgetStyle();
  84     void OnInternalIdle();
  85
  86 #if wxUSE_TOOLTIPS
  87     void ApplyToolTip( GtkTooltips *tips, const wxChar *tip );
  88 #endif // wxUSE_TOOLTIPS
  89
  90     GtkList   *m_list;
  91     wxList     m_clientList;
  92
  93 #if wxUSE_CHECKLISTBOX
  94     bool       m_hasCheckBoxes;
  95 #endif // wxUSE_CHECKLISTBOX
  96
  97     int        m_prevSelection;
  98     bool       m_blockEvent;
  99
 100     virtual void FixUpMouseEvent(GtkWidget *widget, wxCoord& x, wxCoord& y);
 101
 102 protected:
 103     virtual wxSize DoGetBestSize() const;
 104
 105     // return the string label for the given item
 106     wxString GetRealLabel(struct _GList *item) const;
 107
 108 private:
 109     // this array is only used for controls with wxCB_SORT style, so only
 110     // allocate it if it's needed (hence using pointer)
 111     wxSortedArrayString *m_strings;
 112
 113     DECLARE_DYNAMIC_CLASS(wxListBox)
 114 };
 115
 116 #endif // __GTKLISTBOXH__