X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d4864e971beb14110e16450729bf16e733d79fff..1f0acb435592470b421b80df854fbbb08cd2853f:/include/wx/generic/listctrl.h diff --git a/include/wx/generic/listctrl.h b/include/wx/generic/listctrl.h index 284823fcc3..f2db368a54 100644 --- a/include/wx/generic/listctrl.h +++ b/include/wx/generic/listctrl.h @@ -3,88 +3,67 @@ // Purpose: Generic list control // Author: Robert Roebling // Created: 01/02/97 -// Id: +// 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_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "listctrl.h" -#endif - -#include "wx/defs.h" -#include "wx/object.h" -#include "wx/generic/imaglist.h" - -#include "wx/control.h" -#include "wx/timer.h" -#include "wx/dcclient.h" #include "wx/scrolwin.h" -#include "wx/settings.h" -#include "wx/listbase.h" +#include "wx/textctrl.h" -#if wxUSE_DRAG_AND_DROP -class WXDLLEXPORT wxDropTarget; -#endif +class WXDLLIMPEXP_FWD_CORE wxImageList; -//----------------------------------------------------------------------------- -// classes -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListItem; -class WXDLLEXPORT wxListEvent; - -#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__) -class WXDLLEXPORT wxListCtrl; -#define wxImageListType wxImageList -#else -#define wxImageListType wxGenericImageList +#if wxUSE_DRAG_AND_DROP +class WXDLLIMPEXP_FWD_CORE wxDropTarget; #endif //----------------------------------------------------------------------------- // 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 //----------------------------------------------------------------------------- -class WXDLLEXPORT wxGenericListCtrl: public wxControl +class WXDLLIMPEXP_CORE wxGenericListCtrl: public wxControl, + public wxScrollHelper { public: - wxGenericListCtrl(); + + wxGenericListCtrl() : wxScrollHelper(this) + { + Init(); + } + 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 = wxT("listctrl") ) + const wxString &name = wxListCtrlNameStr) + : wxScrollHelper(this) { - Create(parent, id, pos, size, style, validator, name); + Create(parent, winid, pos, size, style, validator, name); } - ~wxGenericListCtrl(); + + virtual ~wxGenericListCtrl(); + + void Init(); 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 = wxT("listctrl") ); + const wxString &name = wxListCtrlNameStr); bool GetColumn( int col, wxListItem& item ) const; bool SetColumn( int col, wxListItem& item ); @@ -98,34 +77,39 @@ public: 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); - wxString GetItemText( long item ) const; + 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 ); - 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 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 ); + 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; - wxImageListType *GetImageList( int which ) const; - void SetImageList( wxImageListType *imageList, int which ); - void AssignImageList( wxImageListType *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(); @@ -136,14 +120,16 @@ public: void SetItemCount(long count); - void EditLabel( long item ) { Edit(item); } - void Edit( long item ); + 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, 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 ); @@ -152,33 +138,54 @@ public: 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 ); + bool SortItems( wxListCtrlCompare fn, wxIntPtr data ); + + // 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 + + + // 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( ); - void OnSize( wxSizeEvent &event ); // We have to hand down a few functions - virtual void Refresh(bool eraseBackground = TRUE, + virtual void Refresh(bool eraseBackground = true, const wxRect *rect = NULL); - virtual void Freeze(); - virtual void Thaw(); - virtual bool SetBackgroundColour( const wxColour &colour ); virtual bool SetForegroundColour( const wxColour &colour ); virtual wxColour GetBackgroundColour() const; @@ -191,78 +198,94 @@ public: virtual wxDropTarget *GetDropTarget() const; #endif - virtual bool DoPopupMenu( wxMenu *menu, int x, int y ); - virtual bool ShouldInheritColours() const { return false; } virtual void SetFocus(); // implementation // -------------- - wxImageListType *m_imageListNormal; - wxImageListType *m_imageListSmall; - wxImageListType *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 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 + // 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(); } + virtual wxBorder GetDefaultBorder() const; - // create the header window - void CreateHeaderWindow(); + virtual wxSize GetSizeAvailableForScrollTarget(const wxSize& size); - // calculate and set height of the header - void CalculateAndSetHeaderHeight(); +private: + void CreateOrDestroyHeaderWindowAsNeeded(); + void OnScroll( wxScrollWinEvent& event ); + void OnSize( wxSizeEvent &event ); - // reposition the header and the main window in the report view depending - // on whether it should be shown or not - void ResizeReportView(bool showHeader); + // 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); + DECLARE_DYNAMIC_CLASS(wxGenericListCtrl) }; -#if !defined(__WXMSW__) || defined(__WIN16__) || defined(__WXUNIVERSAL__) +#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 WXDLLEXPORT wxListCtrl: public wxGenericListCtrl +class WXDLLIMPEXP_CORE wxListCtrl: public wxGenericListCtrl { DECLARE_DYNAMIC_CLASS(wxListCtrl) 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 = wxT("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_