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