include/wx/motif/listbox.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listbox.h
   3 // Purpose:     wxListBox class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_LISTBOX_H_
  13 #define _WX_LISTBOX_H_
  14
  15 #ifdef __GNUG__
  16 #pragma interface "listbox.h"
  17 #endif
  18
  19 #include "wx/ctrlsub.h"
  20 #include "wx/clntdata.h"
  21
  22 WXDLLEXPORT_DATA(extern const char*) wxListBoxNameStr;
  23
  24 // forward decl for GetSelections()
  25 class WXDLLEXPORT wxArrayInt;
  26
  27 WXDLLEXPORT_DATA(extern const char*) wxEmptyString;
  28
  29 // List box item
  30 class WXDLLEXPORT wxListBox: public wxListBoxBase
  31 {
  32     DECLARE_DYNAMIC_CLASS(wxListBox)
  33
  34 public:
  35     wxListBox();
  36     wxListBox(wxWindow *parent, wxWindowID id,
  37         const wxPoint& pos = wxDefaultPosition,
  38         const wxSize& size = wxDefaultSize,
  39         int n = 0, const wxString choices[] = NULL,
  40         long style = 0,
  41         const wxValidator& validator = wxDefaultValidator,
  42         const wxString& name = wxListBoxNameStr)
  43     {
  44         Create(parent, id, pos, size, n, choices, style, validator, name);
  45     }
  46
  47     bool Create(wxWindow *parent, wxWindowID id,
  48         const wxPoint& pos = wxDefaultPosition,
  49         const wxSize& size = wxDefaultSize,
  50         int n = 0, const wxString choices[] = NULL,
  51         long style = 0,
  52         const wxValidator& validator = wxDefaultValidator,
  53         const wxString& name = wxListBoxNameStr);
  54
  55     ~wxListBox();
  56
  57     // implementation of wxControlWithItems
  58     virtual int GetCount() const;
  59     virtual int DoAppend(const wxString& item);
  60     virtual void DoSetItemClientData(int n, void* clientData);
  61     virtual void* DoGetItemClientData(int n) const;
  62     virtual void DoSetItemClientObject(int n, wxClientData* clientData);
  63     virtual wxClientData* DoGetItemClientObject(int n) const;
  64     virtual int GetSelection() const;
  65     virtual void Delete(int n);
  66     virtual int FindString(const wxString& s) const;
  67     virtual void Clear();
  68     virtual void SetString(int n, const wxString& s);
  69     virtual wxString GetString(int n) const;
  70
  71     // implementation of wxListBoxbase
  72     virtual void SetSelection(int n, bool select = TRUE);
  73     virtual void DoInsertItems(const wxArrayString& items, int pos);
  74     virtual void DoSetItems(const wxArrayString& items, void **clientData);
  75     virtual void DoSetFirstItem(int n);
  76     virtual int GetSelections(wxArrayInt& aSelections) const;
  77     virtual bool IsSelected(int n) const;
  78
  79     // For single or multiple choice list item
  80     void Command(wxCommandEvent& event);
  81
  82     // Implementation
  83     virtual void ChangeBackgroundColour();
  84     virtual void ChangeForegroundColour();
  85     WXWidget GetTopWidget() const;
  86
  87 #if wxUSE_CHECKLISTBOX
  88     virtual void DoToggleItem(int item, int x) {};
  89 #endif
  90 protected:
  91     virtual wxSize DoGetBestSize() const;
  92
  93     int       m_noItems;
  94
  95     // List mapping positions->client data
  96     wxClientDataDictionary m_clientDataDict;
  97 private:
  98     void SetSelectionPolicy();
  99 };
 100
 101 #endif
 102 // _WX_LISTBOX_H_