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 // RCS-ID:      $Id$
   7 // Copyright:   (c) 1998 Robert Roebling and Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef __LISTCTRLH_G__
  12 #define __LISTCTRLH_G__
  13
  14 #include "wx/defs.h"
  15 #include "wx/object.h"
  16 #ifdef __WXMAC__
  17 #include "wx/imaglist.h"
  18 #else
  19 #include "wx/generic/imaglist.h"
  20 #endif
  21
  22 #include "wx/control.h"
  23 #include "wx/timer.h"
  24 #include "wx/dcclient.h"
  25 #include "wx/scrolwin.h"
  26 #include "wx/settings.h"
  27 #include "wx/listbase.h"
  28 #include "wx/textctrl.h"
  29
  30 #if wxUSE_DRAG_AND_DROP
  31 class WXDLLEXPORT wxDropTarget;
  32 #endif
  33
  34 //-----------------------------------------------------------------------------
  35 // classes
  36 //-----------------------------------------------------------------------------
  37
  38 class WXDLLEXPORT wxListItem;
  39 class WXDLLEXPORT wxListEvent;
  40
  41 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
  42 class WXDLLEXPORT wxListCtrl;
  43 #define wxImageListType wxImageList
  44 #else
  45 #define wxImageListType wxGenericImageList
  46 #endif
  47
  48 //-----------------------------------------------------------------------------
  49 // internal classes
  50 //-----------------------------------------------------------------------------
  51
  52 class WXDLLEXPORT wxListHeaderData;
  53 class WXDLLEXPORT wxListItemData;
  54 class WXDLLEXPORT wxListLineData;
  55
  56 class WXDLLEXPORT wxListHeaderWindow;
  57 class WXDLLEXPORT wxListMainWindow;
  58
  59 class WXDLLEXPORT wxListRenameTimer;
  60 class WXDLLEXPORT wxListTextCtrl;
  61
  62 //-----------------------------------------------------------------------------
  63 // wxListCtrl
  64 //-----------------------------------------------------------------------------
  65
  66 class WXDLLEXPORT wxGenericListCtrl: public wxControl
  67 {
  68 public:
  69     wxGenericListCtrl();
  70     wxGenericListCtrl( wxWindow *parent,
  71                 wxWindowID winid = wxID_ANY,
  72                 const wxPoint &pos = wxDefaultPosition,
  73                 const wxSize &size = wxDefaultSize,
  74                 long style = wxLC_ICON,
  75                 const wxValidator& validator = wxDefaultValidator,
  76                 const wxString &name = wxListCtrlNameStr)
  77     {
  78         Create(parent, winid, pos, size, style, validator, name);
  79     }
  80     ~wxGenericListCtrl();
  81
  82     bool Create( wxWindow *parent,
  83                  wxWindowID winid = wxID_ANY,
  84                  const wxPoint &pos = wxDefaultPosition,
  85                  const wxSize &size = wxDefaultSize,
  86                  long style = wxLC_ICON,
  87                  const wxValidator& validator = wxDefaultValidator,
  88                  const wxString &name = wxListCtrlNameStr);
  89
  90     bool GetColumn( int col, wxListItem& item ) const;
  91     bool SetColumn( int col, wxListItem& item );
  92     int GetColumnWidth( int col ) const;
  93     bool SetColumnWidth( int col, int width);
  94     int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think
  95     wxRect GetViewRect() const;
  96
  97     bool GetItem( wxListItem& info ) const;
  98     bool SetItem( wxListItem& info ) ;
  99     long SetItem( long index, int col, const wxString& label, int imageId = -1 );
 100     int  GetItemState( long item, long stateMask ) const;
 101     bool SetItemState( long item, long state, long stateMask);
 102     bool SetItemImage( long item, int image, int selImage = -1 );
 103     bool SetItemColumnImage( long item, long column, int image );
 104     wxString GetItemText( long item ) const;
 105     void SetItemText( long item, const wxString& str );
 106     wxUIntPtr GetItemData( long item ) const;
 107     bool SetItemData( long item, long data );
 108     bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const;
 109     bool GetItemPosition( long item, wxPoint& pos ) const;
 110     bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC
 111     int GetItemCount() const;
 112     int GetColumnCount() const;
 113     void SetItemSpacing( int spacing, bool isSmall = false );
 114     wxSize GetItemSpacing() const;
 115     void SetItemTextColour( long item, const wxColour& col);
 116     wxColour GetItemTextColour( long item ) const;
 117     void SetItemBackgroundColour( long item, const wxColour &col);
 118     wxColour GetItemBackgroundColour( long item ) const;
 119     void SetItemFont( long item, const wxFont &f);
 120     wxFont GetItemFont( long item ) const;
 121     int GetSelectedItemCount() const;
 122     wxColour GetTextColour() const;
 123     void SetTextColour(const wxColour& col);
 124     long GetTopItem() const;
 125
 126     void SetSingleStyle( long style, bool add = true ) ;
 127     void SetWindowStyleFlag( long style );
 128     void RecreateWindow() {}
 129     long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const;
 130     wxImageListType *GetImageList( int which ) const;
 131     void SetImageList( wxImageListType *imageList, int which );
 132     void AssignImageList( wxImageListType *imageList, int which );
 133     bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC
 134
 135     void ClearAll();
 136     bool DeleteItem( long item );
 137     bool DeleteAllItems();
 138     bool DeleteAllColumns();
 139     bool DeleteColumn( int col );
 140
 141     void SetItemCount(long count);
 142
 143     wxTextCtrl *EditLabel(long item,
 144                           wxClassInfo* textControlClass = CLASSINFO(wxTextCtrl));
 145     wxTextCtrl* GetEditControl() const;
 146     void Edit( long item ) { EditLabel(item); }
 147
 148     bool EnsureVisible( long item );
 149     long FindItem( long start, const wxString& str, bool partial = false );
 150     long FindItem( long start, wxUIntPtr data );
 151     long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC
 152     long HitTest( const wxPoint& point, int& flags, long *pSubItem = NULL );
 153     long InsertItem(wxListItem& info);
 154     long InsertItem( long index, const wxString& label );
 155     long InsertItem( long index, int imageIndex );
 156     long InsertItem( long index, const wxString& label, int imageIndex );
 157     long InsertColumn( long col, wxListItem& info );
 158     long InsertColumn( long col, const wxString& heading,
 159                        int format = wxLIST_FORMAT_LEFT, int width = -1 );
 160     bool ScrollList( int dx, int dy );
 161     bool SortItems( wxListCtrlCompare fn, long data );
 162     bool Update( long item );
 163     // Must provide overload to avoid hiding it (and warnings about it)
 164     virtual void Update() { wxControl::Update(); }
 165
 166     // are we in report mode?
 167     bool InReportView() const { return HasFlag(wxLC_REPORT); }
 168
 169     // are we in virtual report mode?
 170     bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
 171
 172     // do we have a header window?
 173     bool HasHeader() const
 174         { return InReportView() && !HasFlag(wxLC_NO_HEADER); }
 175
 176     // refresh items selectively (only useful for virtual list controls)
 177     void RefreshItem(long item);
 178     void RefreshItems(long itemFrom, long itemTo);
 179
 180 #if WXWIN_COMPATIBILITY_2_6
 181     // obsolete, don't use
 182     wxDEPRECATED( int GetItemSpacing( bool isSmall ) const );
 183 #endif // WXWIN_COMPATIBILITY_2_6
 184
 185     virtual wxVisualAttributes GetDefaultAttributes() const
 186     {
 187         return GetClassDefaultAttributes(GetWindowVariant());
 188     }
 189
 190     static wxVisualAttributes
 191     GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL);
 192
 193     // implementation only from now on
 194     // -------------------------------
 195
 196     void OnInternalIdle( );
 197     void OnSize( wxSizeEvent &event );
 198
 199     // We have to hand down a few functions
 200     virtual void Refresh(bool eraseBackground = true,
 201                          const wxRect *rect = NULL);
 202
 203     virtual void Freeze();
 204     virtual void Thaw();
 205
 206     virtual bool SetBackgroundColour( const wxColour &colour );
 207     virtual bool SetForegroundColour( const wxColour &colour );
 208     virtual wxColour GetBackgroundColour() const;
 209     virtual wxColour GetForegroundColour() const;
 210     virtual bool SetFont( const wxFont &font );
 211     virtual bool SetCursor( const wxCursor &cursor );
 212
 213 #if wxUSE_DRAG_AND_DROP
 214     virtual void SetDropTarget( wxDropTarget *dropTarget );
 215     virtual wxDropTarget *GetDropTarget() const;
 216 #endif
 217
 218     virtual bool ShouldInheritColours() const { return false; }
 219     virtual void SetFocus();
 220
 221     // implementation
 222     // --------------
 223
 224     wxImageListType         *m_imageListNormal;
 225     wxImageListType         *m_imageListSmall;
 226     wxImageListType         *m_imageListState;  // what's that ?
 227     bool                 m_ownsImageListNormal,
 228                          m_ownsImageListSmall,
 229                          m_ownsImageListState;
 230     wxListHeaderWindow  *m_headerWin;
 231     wxListMainWindow    *m_mainWin;
 232     wxCoord              m_headerHeight;
 233
 234 protected:
 235     virtual bool DoPopupMenu( wxMenu *menu, int x, int y );
 236
 237     // take into account the coordinates difference between the container
 238     // window and the list control window itself here
 239     virtual void DoClientToScreen( int *x, int *y ) const;
 240     virtual void DoScreenToClient( int *x, int *y ) const;
 241
 242     virtual wxSize DoGetBestSize() const;
 243
 244     // return the text for the given column of the given item
 245     virtual wxString OnGetItemText(long item, long column) const;
 246
 247     // return the icon for the given item. In report view, OnGetItemImage will
 248     // only be called for the first column. See OnGetItemColumnImage for
 249     // details.
 250     virtual int OnGetItemImage(long item) const;
 251
 252     // return the icon for the given item and column.
 253     virtual int OnGetItemColumnImage(long item, long column) const;
 254
 255     // return the attribute for the item (may return NULL if none)
 256     virtual wxListItemAttr *OnGetItemAttr(long item) const;
 257
 258     // it calls our OnGetXXX() functions
 259     friend class WXDLLEXPORT wxListMainWindow;
 260
 261 private:
 262     // create the header window
 263     void CreateHeaderWindow();
 264
 265     // calculate and set height of the header
 266     void CalculateAndSetHeaderHeight();
 267
 268     // reposition the header and the main window in the report view depending
 269     // on whether it should be shown or not
 270     void ResizeReportView(bool showHeader);
 271
 272     DECLARE_EVENT_TABLE()
 273     DECLARE_DYNAMIC_CLASS(wxGenericListCtrl)
 274 };
 275
 276 #if !defined(__WXMSW__) || defined(__WXUNIVERSAL__)
 277 /*
 278  * wxListCtrl has to be a real class or we have problems with
 279  * the run-time information.
 280  */
 281
 282 class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl
 283 {
 284     DECLARE_DYNAMIC_CLASS(wxListCtrl)
 285
 286 public:
 287     wxListCtrl() {}
 288
 289     wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY,
 290                const wxPoint& pos = wxDefaultPosition,
 291                const wxSize& size = wxDefaultSize,
 292                long style = wxLC_ICON,
 293                const wxValidator &validator = wxDefaultValidator,
 294                const wxString &name = wxListCtrlNameStr)
 295     : wxGenericListCtrl(parent, winid, pos, size, style, validator, name)
 296     {
 297     }
 298 };
 299 #endif // !__WXMSW__ || __WXUNIVERSAL__
 300
 301 #endif // __LISTCTRLH_G__