X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b31989e20882186006e2b2c4b8062ba8394b539d..d2ce59e9bb71dbe7a01d96ec3df158e626aaa145:/include/wx/generic/listctrl.h?ds=sidebyside diff --git a/include/wx/generic/listctrl.h b/include/wx/generic/listctrl.h index 0576e00126..1dedb608c6 100644 --- a/include/wx/generic/listctrl.h +++ b/include/wx/generic/listctrl.h @@ -3,52 +3,33 @@ // Purpose: Generic list control // Author: Robert Roebling // Created: 01/02/97 -// Id: -// Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem +// RCS-ID: $Id$ +// Copyright: (c) 1998 Robert Roebling and Julian Smart // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -#ifndef __LISTCTRLH_G__ -#define __LISTCTRLH_G__ +#ifndef _WX_GENERIC_LISTCTRL_H_ +#define _WX_GENERIC_LISTCTRL_H_ -#ifdef __GNUG__ -#pragma interface "listctrl.h" -#endif +#include "wx/textctrl.h" -#include "wx/defs.h" -#include "wx/object.h" -#include "wx/imaglist.h" -#include "wx/control.h" -#include "wx/timer.h" -#include "wx/dcclient.h" -#include "wx/scrolwin.h" -#include "wx/settings.h" +class WXDLLIMPEXP_FWD_CORE wxImageList; #if wxUSE_DRAG_AND_DROP -class WXDLLEXPORT wxDropTarget; +class WXDLLIMPEXP_FWD_CORE wxDropTarget; #endif -//----------------------------------------------------------------------------- -// classes -//----------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- +// constants +// ---------------------------------------------------------------------------- -class WXDLLEXPORT wxListItem; -class WXDLLEXPORT wxListEvent; -class WXDLLEXPORT wxListCtrl; //----------------------------------------------------------------------------- // internal classes //----------------------------------------------------------------------------- -class WXDLLEXPORT wxListHeaderData; -class WXDLLEXPORT wxListItemData; -class WXDLLEXPORT wxListLineData; - -class WXDLLEXPORT wxListHeaderWindow; -class WXDLLEXPORT wxListMainWindow; - -class WXDLLEXPORT wxListRenameTimer; -class WXDLLEXPORT wxListTextCtrl; +class WXDLLIMPEXP_FWD_CORE wxListHeaderWindow; +class WXDLLIMPEXP_FWD_CORE wxListMainWindow; //----------------------------------------------------------------------------- // wxListCtrl @@ -57,66 +38,72 @@ class WXDLLEXPORT wxListTextCtrl; class WXDLLEXPORT wxGenericListCtrl: public wxControl { public: + wxGenericListCtrl(); wxGenericListCtrl( wxWindow *parent, - wxWindowID id = -1, + wxWindowID winid = wxID_ANY, const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, - const wxString &name = "listctrl" ) + const wxString &name = wxListCtrlNameStr) { - Create(parent, id, pos, size, style, validator, name); + Create(parent, winid, pos, size, style, validator, name); } - ~wxGenericListCtrl(); + virtual ~wxGenericListCtrl(); bool Create( wxWindow *parent, - wxWindowID id = -1, + wxWindowID winid = wxID_ANY, const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, - const wxString &name = "listctrl" ); + const wxString &name = wxListCtrlNameStr); bool GetColumn( int col, wxListItem& item ) const; bool SetColumn( int col, 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); + bool SetItemImage( long item, int image, int selImage = -1 ); + bool SetItemColumnImage( long item, long column, int image ); wxString GetItemText( long item ) const; void SetItemText( long item, const wxString& str ); - long GetItemData( long item ) const; - bool SetItemData( long item, long data ); + 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 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 ); - int GetItemSpacing( bool isSmall ) 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 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; - wxGenericImageList *GetImageList( int which ) const; - void SetImageList( wxGenericImageList *imageList, int which ); - void AssignImageList( wxGenericImageList *imageList, int which ); + 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(); @@ -127,42 +114,65 @@ public: void SetItemCount(long count); - void EditLabel( long item ) { Edit(item); } - void Edit( long item ); + wxTextCtrl *EditLabel(long item, + wxClassInfo* textControlClass = CLASSINFO(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, long data ); + 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 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 ); long InsertColumn( long col, wxListItem& info ); - long InsertColumn( long col, const wxString& heading, int format = wxLIST_FORMAT_LEFT, - int width = -1 ); + long InsertColumn( long col, const wxString& heading, + int format = wxLIST_FORMAT_LEFT, int width = -1 ); bool ScrollList( int dx, int dy ); bool SortItems( wxListCtrlCompare fn, long data ); bool Update( long item ); + // Must provide overload to avoid hiding it (and warnings about it) + virtual void Update() { wxControl::Update(); } + + // are we in report mode? + bool InReportView() const { return HasFlag(wxLC_REPORT); } - // returns true if it is a virtual list control - bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; } + // are we in virtual report mode? + bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); } + + // 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 + + virtual wxVisualAttributes GetDefaultAttributes() const + { + return GetClassDefaultAttributes(GetWindowVariant()); + } + + static wxVisualAttributes + GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL); + // implementation only from now on // ------------------------------- - void OnIdle( wxIdleEvent &event ); + void OnInternalIdle( ); void OnSize( wxSizeEvent &event ); // We have to hand down a few functions - - virtual void Freeze(); - virtual void Thaw(); + virtual void Refresh(bool eraseBackground = true, + const wxRect *rect = NULL); virtual bool SetBackgroundColour( const wxColour &colour ); virtual bool SetForegroundColour( const wxColour &colour ); @@ -171,56 +181,76 @@ public: virtual bool SetFont( const wxFont &font ); virtual bool SetCursor( const wxCursor &cursor ); + virtual int GetScrollPos(int orient) const; + virtual void SetScrollPos(int orient, int pos, bool refresh = true); + #if wxUSE_DRAG_AND_DROP virtual void SetDropTarget( wxDropTarget *dropTarget ); virtual wxDropTarget *GetDropTarget() const; #endif - virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); - + virtual bool ShouldInheritColours() const { return false; } virtual void SetFocus(); // implementation // -------------- - wxGenericImageList *m_imageListNormal; - wxGenericImageList *m_imageListSmall; - wxGenericImageList *m_imageListState; // what's that ? + 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; + wxCoord m_headerHeight; protected: + 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 DoGetBestSize() const; + + virtual void DoFreeze(); + virtual void DoThaw(); + // 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 + // 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 WXDLLEXPORT wxListMainWindow; + friend class WXDLLIMPEXP_FWD_CORE wxListMainWindow; private: - // Virtual function hiding supression - virtual void Update() { wxWindow::Update(); } - // create the header window void CreateHeaderWindow(); + // calculate and set height of the header + void CalculateAndSetHeaderHeight(); + // reposition the header and the main window in the report view depending // on whether it should be shown or not void ResizeReportView(bool showHeader); DECLARE_EVENT_TABLE() - DECLARE_DYNAMIC_CLASS(wxGenericListCtrl); + DECLARE_DYNAMIC_CLASS(wxGenericListCtrl) }; -#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__) +#if (!defined(__WXMSW__) || defined(__WXUNIVERSAL__)) && (!defined(__WXMAC__) || defined(__WXUNIVERSAL__)) /* * wxListCtrl has to be a real class or we have problems with * the run-time information. @@ -233,16 +263,17 @@ class WXDLLEXPORT wxListCtrl: public wxGenericListCtrl public: wxListCtrl() {} - wxListCtrl(wxWindow *parent, wxWindowID id = -1, + 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 = "listctrl" ) - : wxGenericListCtrl(parent, id, pos, size, style, validator, name) + const wxString &name = wxListCtrlNameStr) + : wxGenericListCtrl(parent, winid, pos, size, style, validator, name) { } + }; -#endif // !__WXMSW__ || __WIN16__ || __WXUNIVERSAL__ +#endif // !__WXMSW__ || __WXUNIVERSAL__ -#endif // __LISTCTRLH_G__ +#endif // _WX_GENERIC_LISTCTRL_H_