///////////////////////////////////////////////////////////////////////////// // Name: wx/generic/listctrl.h // Purpose: Generic list control // Author: Robert Roebling // Created: 01/02/97 // RCS-ID: $Id$ // Copyright: (c) 1998 Robert Roebling and Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef _WX_GENERIC_LISTCTRL_H_ #define _WX_GENERIC_LISTCTRL_H_ #include "wx/scrolwin.h" #include "wx/textctrl.h" #if wxUSE_DRAG_AND_DROP class WXDLLIMPEXP_FWD_CORE wxDropTarget; #endif //----------------------------------------------------------------------------- // internal classes //----------------------------------------------------------------------------- class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow; class WXDLLIMPEXP_FWD_CORE wxListMainWindow; //----------------------------------------------------------------------------- // wxListCtrl //----------------------------------------------------------------------------- class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxListCtrlBase, public wxScrollHelper { public: wxGenericListCtrl() : wxScrollHelper(this) { Init(); } wxGenericListCtrl( wxWindow *parent, wxWindowID winid = wxID_ANY, const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString &name = wxListCtrlNameStr) : wxScrollHelper(this) { Create(parent, winid, pos, size, style, validator, name); } virtual ~wxGenericListCtrl(); void Init(); bool Create( wxWindow *parent, wxWindowID winid = wxID_ANY, const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, const wxString &name = wxListCtrlNameStr); bool GetColumn( int col, wxListItem& item ) const; bool SetColumn( int col, const wxListItem& item ); int GetColumnWidth( int col ) const; bool SetColumnWidth( int col, int width); int GetCountPerPage() const; // not the same in wxGLC as in Windows, I think wxRect GetViewRect() const; bool GetItem( wxListItem& info ) const; bool SetItem( wxListItem& info ) ; long SetItem( long index, int col, const wxString& label, int imageId = -1 ); int GetItemState( long item, long stateMask ) const; bool SetItemState( long item, long state, long stateMask); bool SetItemImage( long item, int image, int selImage = -1 ); bool SetItemColumnImage( long item, long column, int image ); wxString GetItemText( long item, int col = 0 ) const; void SetItemText( long item, const wxString& str ); wxUIntPtr GetItemData( long item ) const; bool SetItemPtrData(long item, wxUIntPtr data); bool SetItemData(long item, long data) { return SetItemPtrData(item, data); } bool GetItemRect( long item, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; bool GetSubItemRect( long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS ) const; bool GetItemPosition( long item, wxPoint& pos ) const; bool SetItemPosition( long item, const wxPoint& pos ); // not supported in wxGLC int GetItemCount() const; int GetColumnCount() const; void SetItemSpacing( int spacing, bool isSmall = false ); wxSize GetItemSpacing() const; void SetItemTextColour( long item, const wxColour& col); wxColour GetItemTextColour( long item ) const; void SetItemBackgroundColour( long item, const wxColour &col); wxColour GetItemBackgroundColour( long item ) const; void SetItemFont( long item, const wxFont &f); wxFont GetItemFont( long item ) const; int GetSelectedItemCount() const; wxColour GetTextColour() const; void SetTextColour(const wxColour& col); long GetTopItem() const; void SetSingleStyle( long style, bool add = true ) ; void SetWindowStyleFlag( long style ); void RecreateWindow() {} long GetNextItem( long item, int geometry = wxLIST_NEXT_ALL, int state = wxLIST_STATE_DONTCARE ) const; wxImageList *GetImageList( int which ) const; void SetImageList( wxImageList *imageList, int which ); void AssignImageList( wxImageList *imageList, int which ); bool Arrange( int flag = wxLIST_ALIGN_DEFAULT ); // always wxLIST_ALIGN_LEFT in wxGLC void ClearAll(); bool DeleteItem( long item ); bool DeleteAllItems(); bool DeleteAllColumns(); bool DeleteColumn( int col ); void SetItemCount(long count); wxTextCtrl *EditLabel(long item, wxClassInfo* textControlClass = wxCLASSINFO(wxTextCtrl)); wxTextCtrl* GetEditControl() const; void Edit( long item ) { EditLabel(item); } bool EnsureVisible( long item ); long FindItem( long start, const wxString& str, bool partial = false ); long FindItem( long start, wxUIntPtr data ); long FindItem( long start, const wxPoint& pt, int direction ); // not supported in wxGLC long HitTest( const wxPoint& point, int& flags, long *pSubItem = NULL ) const; long InsertItem(wxListItem& info); long InsertItem( long index, const wxString& label ); long InsertItem( long index, int imageIndex ); long InsertItem( long index, const wxString& label, int imageIndex ); bool ScrollList( int dx, int dy ); bool SortItems( wxListCtrlCompare fn, wxIntPtr data ); // do we have a header window? bool HasHeader() const { return InReportView() && !HasFlag(wxLC_NO_HEADER); } // refresh items selectively (only useful for virtual list controls) void RefreshItem(long item); void RefreshItems(long itemFrom, long itemTo); #if WXWIN_COMPATIBILITY_2_6 // obsolete, don't use wxDEPRECATED( int GetItemSpacing( bool isSmall ) const ); #endif // WXWIN_COMPATIBILITY_2_6 // overridden base class virtuals // ------------------------------ virtual wxVisualAttributes GetDefaultAttributes() const { return GetClassDefaultAttributes(GetWindowVariant()); } static wxVisualAttributes GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); virtual void Update(); // implementation only from now on // ------------------------------- // generic version extension, don't use in portable code bool Update( long item ); void OnInternalIdle( ); // We have to hand down a few functions virtual void Refresh(bool eraseBackground = true, const wxRect *rect = NULL); virtual bool SetBackgroundColour( const wxColour &colour ); virtual bool SetForegroundColour( const wxColour &colour ); virtual wxColour GetBackgroundColour() const; virtual wxColour GetForegroundColour() const; virtual bool SetFont( const wxFont &font ); virtual bool SetCursor( const wxCursor &cursor ); #if wxUSE_DRAG_AND_DROP virtual void SetDropTarget( wxDropTarget *dropTarget ); virtual wxDropTarget *GetDropTarget() const; #endif virtual bool ShouldInheritColours() const { return false; } virtual void SetFocus(); // implementation // -------------- wxImageList *m_imageListNormal; wxImageList *m_imageListSmall; wxImageList *m_imageListState; // what's that ? bool m_ownsImageListNormal, m_ownsImageListSmall, m_ownsImageListState; wxListHeaderWindow *m_headerWin; wxListMainWindow *m_mainWin; protected: // Implement base class pure virtual methods. long DoInsertColumn(long col, const wxListItem& info); virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); // take into account the coordinates difference between the container // window and the list control window itself here virtual void DoClientToScreen( int *x, int *y ) const; virtual void DoScreenToClient( int *x, int *y ) const; virtual wxSize DoGetBestClientSize() const; // return the text for the given column of the given item virtual wxString OnGetItemText(long item, long column) const; // return the icon for the given item. In report view, OnGetItemImage will // only be called for the first column. See OnGetItemColumnImage for // details. virtual int OnGetItemImage(long item) const; // return the icon for the given item and column. virtual int OnGetItemColumnImage(long item, long column) const; // return the attribute for the item (may return NULL if none) virtual wxListItemAttr *OnGetItemAttr(long item) const; // it calls our OnGetXXX() functions friend class WXDLLIMPEXP_FWD_CORE wxListMainWindow; virtual wxBorder GetDefaultBorder() const; virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); private: void CreateOrDestroyHeaderWindowAsNeeded(); void OnScroll( wxScrollWinEvent& event ); void OnSize( wxSizeEvent &event ); // we need to return a special WM_GETDLGCODE value to process just the // arrows but let the other navigation characters through #if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__) virtual WXLRESULT MSWWindowProc(WXUINT nMsg, WXWPARAM wParam, WXLPARAM lParam); #endif // __WXMSW__ WX_FORWARD_TO_SCROLL_HELPER() DECLARE_EVENT_TABLE() DECLARE_DYNAMIC_CLASS(wxGenericListCtrl) }; #if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && (!(defined(__WXMAC__) && wxOSX_USE_CARBON) || defined(__WXUNIVERSAL__ )) /* * wxListCtrl has to be a real class or we have problems with * the run-time information. */ class WXDLLIMPEXP_CORE wxListCtrl: public wxGenericListCtrl { DECLARE_DYNAMIC_CLASS(wxListCtrl) public: wxListCtrl() {} wxListCtrl(wxWindow *parent, wxWindowID winid = wxID_ANY, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxLC_ICON, const wxValidator &validator = wxDefaultValidator, const wxString &name = wxListCtrlNameStr) : wxGenericListCtrl(parent, winid, pos, size, style, validator, name) { } }; #endif // !__WXMSW__ || __WXUNIVERSAL__ #endif // _WX_GENERIC_LISTCTRL_H_