include/wx/generic/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/generic/listctrl.h
   3 // Purpose:     Generic list control
   4 // Author:      Robert Roebling
   5 // Created:     01/02/97
   6 // Copyright:   (c) 1998 Robert Roebling and Julian Smart
   7 // Licence:     wxWindows licence
   8 /////////////////////////////////////////////////////////////////////////////
   9
  10 #ifndef _WX_GENERIC_LISTCTRL_H_
  11 #define _WX_GENERIC_LISTCTRL_H_
  12
  13 #include "wx/containr.h"
  14 #include "wx/scrolwin.h"
  15 #include "wx/textctrl.h"
  16
  17 #if wxUSE_DRAG_AND_DROP
  18 class WXDLLIMPEXP_FWD_CORE wxDropTarget;
  19 #endif
  20
  21 //-----------------------------------------------------------------------------
  22 // internal classes
  23 //-----------------------------------------------------------------------------
  24
  25 class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow;
  26 class WXDLLIMPEXP_FWD_CORE wxListMainWindow;
  27
  28 //-----------------------------------------------------------------------------
  29 // wxListCtrl
  30 //-----------------------------------------------------------------------------
  31
  32 class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxNavigationEnabled<wxListCtrlBase>,
  33                                           public wxScrollHelper
  34 {
  35 public:
  36
  37     wxGenericListCtrl() : wxScrollHelper(this)
  38     {
  39         Init();
  40     }
  41
  42     wxGenericListCtrl( wxWindow *parent,
  43                 wxWindowID winid = wxID_ANY,
  44                 const wxPoint &pos = wxDefaultPosition,
  45                 const wxSize &size = wxDefaultSize,
  46                 long style = wxLC_ICON,
  47                 const wxValidator& validator = wxDefaultValidator,
  48                 const wxString &name = wxListCtrlNameStr)
  49             : wxScrollHelper(this)
  50     {
  51         Create(parent, winid, pos, size, style, validator, name);
  52     }
  53
  54     virtual ~wxGenericListCtrl();
  55
  56     void Init();
  57
  58     bool Create( wxWindow *parent,
  59                  wxWindowID winid = wxID_ANY,
  60                  const wxPoint &pos = wxDefaultPosition,
  61                  const wxSize &size = wxDefaultSize,
  62                  long style = wxLC_ICON,
  63                  const wxValidator& validator = wxDefaultValidator,
  64                  const wxString &name = wxListCtrlNameStr);
  65
  66     bool GetColumn( int col, wxListItem& item ) const;
  67     bool SetColumn( int col, const wxListItem& item );
  68     int GetColumnWidth( int col ) const;
  69     bool SetColumnWidth( int col, int width);
  70     int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
  71     wxRect GetViewRect() const;
  72
  73     bool GetItem( wxListItem& info ) const;
  74     bool SetItem( wxListItem& info ) ;
  75     long SetItem( long index, int col, const wxString& label, int imageId = -1 );
  76     int  GetItemState( long item, long stateMask ) const;
  77     bool SetItemState( long item, long state, long stateMask);
  78     bool SetItemImage( long item, int image, int selImage = -1 );
  79     bool SetItemColumnImage( long item, long column, int image );
  80     wxString GetItemText( long item, int col = 0 ) const;
  81     void SetItemText( long item, const wxString& str );
  82     wxUIntPtr GetItemData( long item ) const;
  83     bool SetItemPtrData(long item, wxUIntPtr data);
  84     bool SetItemData(long item, long data) { return SetItemPtrData(item, data); }
  85     bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
  86     bool GetSubItemRect( long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
  87     bool GetItemPosition( long item, wxPoint& pos ) const;
  88     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
  89     int GetItemCount() const;
  90     int GetColumnCount() const;
  91     void SetItemSpacing( int spacing, bool isSmall = false );
  92     wxSize GetItemSpacing() const;
  93     void SetItemTextColour( long item, const wxColour& col);
  94     wxColour GetItemTextColour( long item ) const;
  95     void SetItemBackgroundColour( long item, const wxColour &col);
  96     wxColour GetItemBackgroundColour( long item ) const;
  97     void SetItemFont( long item, const wxFont &f);
  98     wxFont GetItemFont( long item ) const;
  99     int GetSelectedItemCount() const;
 100     wxColour GetTextColour() const;
 101     void SetTextColour(const wxColour& col);
 102     long GetTopItem() const;
 103
 104     void SetSingleStyle( long style, bool add = true ) ;
 105     void SetWindowStyleFlag( long style );
 106     void RecreateWindow() {}
 107     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
 108     wxImageList *GetImageList( int which ) const;
 109     void SetImageList( wxImageList *imageList, int which );
 110     void AssignImageList( wxImageList *imageList, int which );
 111     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 112
 113     void ClearAll();
 114     bool DeleteItem( long item );
 115     bool DeleteAllItems();
 116     bool DeleteAllColumns();
 117     bool DeleteColumn( int col );
 118
 119     void SetItemCount(long count);
 120
 121     wxTextCtrl *EditLabel(long item,
 122                           wxClassInfo* textControlClass = wxCLASSINFO(wxTextCtrl));
 123     wxTextCtrl* GetEditControl() const;
 124     void Edit( long item ) { EditLabel(item); }
 125
 126     bool EnsureVisible( long item );
 127     long FindItem( long start, const wxString& str, bool partial = false );
 128     long FindItem( long start, wxUIntPtr data );
 129     long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC
 130     long HitTest( const wxPoint& point, int& flags, long *pSubItem = NULL ) const;
 131     long InsertItem(wxListItem& info);
 132     long InsertItem( long index, const wxString& label );
 133     long InsertItem( long index, int imageIndex );
 134     long InsertItem( long index, const wxString& label, int imageIndex );
 135     bool ScrollList( int dx, int dy );
 136     bool SortItems( wxListCtrlCompare fn, wxIntPtr data );
 137
 138     // do we have a header window?
 139     bool HasHeader() const
 140         { return InReportView() && !HasFlag(wxLC_NO_HEADER); }
 141
 142     // refresh items selectively (only useful for virtual list controls)
 143     void RefreshItem(long item);
 144     void RefreshItems(long itemFrom, long itemTo);
 145
 146     virtual void EnableBellOnNoMatch(bool on = true);
 147
 148 #if WXWIN_COMPATIBILITY_2_6
 149     // obsolete, don't use
 150     wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
 151 #endif // WXWIN_COMPATIBILITY_2_6
 152
 153
 154     // overridden base class virtuals
 155     // ------------------------------
 156
 157     virtual wxVisualAttributes GetDefaultAttributes() const
 158     {
 159         return GetClassDefaultAttributes(GetWindowVariant());
 160     }
 161
 162     static wxVisualAttributes
 163     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 164
 165     virtual void Update();
 166
 167
 168     // implementation only from now on
 169     // -------------------------------
 170
 171     // generic version extension, don't use in portable code
 172     bool Update( long item );
 173
 174     void OnInternalIdle( );
 175
 176     // We have to hand down a few functions
 177     virtual void Refresh(bool eraseBackground = true,
 178                          const wxRect *rect = NULL);
 179
 180     virtual bool SetBackgroundColour( const wxColour &colour );
 181     virtual bool SetForegroundColour( const wxColour &colour );
 182     virtual wxColour GetBackgroundColour() const;
 183     virtual wxColour GetForegroundColour() const;
 184     virtual bool SetFont( const wxFont &font );
 185     virtual bool SetCursor( const wxCursor &cursor );
 186
 187 #if wxUSE_DRAG_AND_DROP
 188     virtual void SetDropTarget( wxDropTarget *dropTarget );
 189     virtual wxDropTarget *GetDropTarget() const;
 190 #endif
 191
 192     virtual bool ShouldInheritColours() const { return false; }
 193
 194     // implementation
 195     // --------------
 196
 197     wxImageList         *m_imageListNormal;
 198     wxImageList         *m_imageListSmall;
 199     wxImageList         *m_imageListState;  // what's that ?
 200     bool                 m_ownsImageListNormal,
 201                          m_ownsImageListSmall,
 202                          m_ownsImageListState;
 203     wxListHeaderWindow  *m_headerWin;
 204     wxListMainWindow    *m_mainWin;
 205
 206 protected:
 207     // Implement base class pure virtual methods.
 208     long DoInsertColumn(long col, const wxListItem& info);
 209
 210
 211     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 212
 213     virtual wxSize DoGetBestClientSize() const;
 214
 215     // return the text for the given column of the given item
 216     virtual wxString OnGetItemText(long item, long column) const;
 217
 218     // return the icon for the given item. In report view, OnGetItemImage will
 219     // only be called for the first column. See OnGetItemColumnImage for
 220     // details.
 221     virtual int OnGetItemImage(long item) const;
 222
 223     // return the icon for the given item and column.
 224     virtual int OnGetItemColumnImage(long item, long column) const;
 225
 226     // it calls our OnGetXXX() functions
 227     friend class WXDLLIMPEXP_FWD_CORE wxListMainWindow;
 228
 229     virtual wxBorder GetDefaultBorder() const;
 230
 231     virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size);
 232
 233 private:
 234     void CreateOrDestroyHeaderWindowAsNeeded();
 235     void OnScroll( wxScrollWinEvent& event );
 236     void OnSize( wxSizeEvent &event );
 237
 238     // we need to return a special WM_GETDLGCODE value to process just the
 239     // arrows but let the other navigation characters through
 240 #if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__)
 241     virtual WXLRESULT
 242     MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam);
 243 #endif // __WXMSW__
 244
 245     WX_FORWARD_TO_SCROLL_HELPER()
 246
 247     DECLARE_EVENT_TABLE()
 248     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl)
 249 };
 250
 251 #if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && (!(defined(__WXMAC__) && wxOSX_USE_CARBON) || defined(__WXUNIVERSAL__ ))
 252 /*
 253  * wxListCtrl has to be a real class or we have problems with
 254  * the run-time information.
 255  */
 256
 257 class WXDLLIMPEXP_CORE wxListCtrl: public wxGenericListCtrl
 258 {
 259     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 260
 261 public:
 262     wxListCtrl() {}
 263
 264     wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,
 265                const wxPoint& pos = wxDefaultPosition,
 266                const wxSize& size = wxDefaultSize,
 267                long style = wxLC_ICON,
 268                const wxValidator &validator = wxDefaultValidator,
 269                const wxString &name = wxListCtrlNameStr)
 270     : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
 271     {
 272     }
 273
 274 };
 275 #endif // !__WXMSW__ || __WXUNIVERSAL__
 276
 277 #endif // _WX_GENERIC_LISTCTRL_H_