X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b16088bf11b6a5a6710e55fed61b61f54869ae75..24a7a1980f309763c349541daffa46f1a5fd16b2:/include/wx/generic/listctrl.h diff --git a/include/wx/generic/listctrl.h b/include/wx/generic/listctrl.h index 72c6826610..6d72b00492 100644 --- a/include/wx/generic/listctrl.h +++ b/include/wx/generic/listctrl.h @@ -1,11 +1,11 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: listctrl.h +// Name: wx/generic/listctrl.h // Purpose: Generic list control // Author: Robert Roebling // Created: 01/02/97 // Id: // Copyright: (c) 1998 Robert Roebling, Julian Smart and Markus Holzem -// Licence: wxWindows licence +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// #ifndef __LISTCTRLH_G__ @@ -17,7 +17,7 @@ #include "wx/defs.h" #include "wx/object.h" -#include "wx/generic/imaglist.h" +#include "wx/imaglist.h" #include "wx/control.h" #include "wx/timer.h" #include "wx/textctrl.h" @@ -51,456 +51,6 @@ class WXDLLEXPORT wxListMainWindow; class WXDLLEXPORT wxListRenameTimer; class WXDLLEXPORT wxListTextCtrl; -//----------------------------------------------------------------------------- -// types -//----------------------------------------------------------------------------- - -// type of compare function for wxListCtrl sort operation -typedef int (*wxListCtrlCompare)(long item1, long item2, long sortData); - -//----------------------------------------------------------------------------- -// wxListCtrl flags -//----------------------------------------------------------------------------- - -#define wxLC_ICON 0x0004 -#define wxLC_SMALL_ICON 0x0008 -#define wxLC_LIST 0x0010 -#define wxLC_REPORT 0x0020 -#define wxLC_ALIGN_TOP 0x0040 -#define wxLC_ALIGN_LEFT 0x0080 -#define wxLC_AUTOARRANGE 0x0100 // not supported in wxGLC -#define wxLC_USER_TEXT 0x0200 // not supported in wxGLC (how does it work?) -#define wxLC_EDIT_LABELS 0x0400 -#define wxLC_NO_HEADER 0x0800 -#define wxLC_NO_SORT_HEADER 0x1000 // not supported in wxGLC -#define wxLC_SINGLE_SEL 0x2000 -#define wxLC_SORT_ASCENDING 0x4000 -#define wxLC_SORT_DESCENDING 0x8000 // not supported in wxGLC - -#define wxLC_MASK_TYPE (wxLC_ICON | wxLC_SMALL_ICON | wxLC_LIST | wxLC_REPORT) -#define wxLC_MASK_ALIGN (wxLC_ALIGN_TOP | wxLC_ALIGN_LEFT) -#define wxLC_MASK_SORT (wxLC_SORT_ASCENDING | wxLC_SORT_DESCENDING) - -// Omitted because (a) too much detail (b) not enough style flags -// #define wxLC_NO_SCROLL -// #define wxLC_NO_LABEL_WRAP -// #define wxLC_OWNERDRAW_FIXED -// #define wxLC_SHOW_SEL_ALWAYS - -// Mask flags to tell app/GUI what fields of wxListItem are valid -#define wxLIST_MASK_STATE 0x0001 -#define wxLIST_MASK_TEXT 0x0002 -#define wxLIST_MASK_IMAGE 0x0004 -#define wxLIST_MASK_DATA 0x0008 -#define wxLIST_SET_ITEM 0x0010 -#define wxLIST_MASK_WIDTH 0x0020 -#define wxLIST_MASK_FORMAT 0x0040 - -// State flags for indicating the state of an item -#define wxLIST_STATE_DONTCARE 0x0000 -#define wxLIST_STATE_DROPHILITED 0x0001 // not supported in wxGLC -#define wxLIST_STATE_FOCUSED 0x0002 -#define wxLIST_STATE_SELECTED 0x0004 -#define wxLIST_STATE_CUT 0x0008 // not supported in wxGLC - -// Hit test flags, used in HitTest // wxGLC suppots 20 and 80 -#define wxLIST_HITTEST_ABOVE 0x0001 // Above the client area. -#define wxLIST_HITTEST_BELOW 0x0002 // Below the client area. -#define wxLIST_HITTEST_NOWHERE 0x0004 // In the client area but below the last item. -#define wxLIST_HITTEST_ONITEMICON 0x0020 // On the bitmap associated with an item. -#define wxLIST_HITTEST_ONITEMLABEL 0x0080 // On the label (string) associated with an item. -#define wxLIST_HITTEST_ONITEMRIGHT 0x0100 // In the area to the right of an item. -#define wxLIST_HITTEST_ONITEMSTATEICON 0x0200 // On the state icon for a tree view item that is in a user-defined state. -#define wxLIST_HITTEST_TOLEFT 0x0400 // To the right of the client area. -#define wxLIST_HITTEST_TORIGHT 0x0800 // To the left of the client area. - -#define wxLIST_HITTEST_ONITEM (wxLIST_HITTEST_ONITEMICON | wxLIST_HITTEST_ONITEMLABEL | wxLIST_HITTEST_ONITEMSTATEICON) - - - -// Flags for GetNextItem // always wxLIST_NEXT_ALL in wxGLC -enum { - wxLIST_NEXT_ABOVE, // Searches for an item above the specified item - wxLIST_NEXT_ALL, // Searches for subsequent item by index - wxLIST_NEXT_BELOW, // Searches for an item below the specified item - wxLIST_NEXT_LEFT, // Searches for an item to the left of the specified item - wxLIST_NEXT_RIGHT // Searches for an item to the right of the specified item -}; - -// Alignment flags for Arrange // always wxLIST_ALIGN_LEFT in wxGLC -enum { - wxLIST_ALIGN_DEFAULT, - wxLIST_ALIGN_LEFT, - wxLIST_ALIGN_TOP, - wxLIST_ALIGN_SNAP_TO_GRID -}; - -// Column format // always wxLIST_FORMAT_LEFT in wxGLC -enum { - wxLIST_FORMAT_LEFT, - wxLIST_FORMAT_RIGHT, - wxLIST_FORMAT_CENTRE, - wxLIST_FORMAT_CENTER = wxLIST_FORMAT_CENTRE -}; - -// Autosize values for SetColumnWidth -enum { - wxLIST_AUTOSIZE = -1, // width of longest item - wxLIST_AUTOSIZE_USEHEADER = -2 // always 80 in wxGLC -}; - -// Flag values for GetItemRect -enum { - wxLIST_RECT_BOUNDS, - wxLIST_RECT_ICON, - wxLIST_RECT_LABEL -}; - -// Flag values for FindItem // not supported by wxGLC -enum { - wxLIST_FIND_UP, - wxLIST_FIND_DOWN, - wxLIST_FIND_LEFT, - wxLIST_FIND_RIGHT -}; - -//----------------------------------------------------------------------------- -// wxListItem -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListItem: public wxObject -{ -public: - long m_mask; // Indicates what fields are valid - long m_itemId; // The zero-based item position - int m_col; // Zero-based column, if in report mode - long m_state; // The state of the item - long m_stateMask; // Which flags of m_state are valid (uses same flags) - wxString m_text; // The label/header text - int m_image; // The zero-based index into an image list - long m_data; // App-defined data - wxColour *m_colour; // only wxGLC, not supported by Windows ;-> - - // For columns only - int m_format; // left, right, centre - int m_width; // width of column - - wxListItem(); - -private: - DECLARE_DYNAMIC_CLASS(wxListItem) -}; - -//----------------------------------------------------------------------------- -// wxListItemData (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListItemData : public wxObject -{ -public: - wxString m_text; - int m_image; - long m_data; - int m_xpos,m_ypos; - int m_width,m_height; - wxColour *m_colour; - -public: - wxListItemData(); - wxListItemData( const wxListItem &info ); - void SetItem( const wxListItem &info ); - void SetText( const wxString &s ); - void SetImage( int image ); - void SetData( long data ); - void SetPosition( int x, int y ); - void SetSize( int width, int height ); - void SetColour( wxColour *col ); - bool HasImage() const; - bool HasText() const; - bool IsHit( int x, int y ) const; - void GetText( wxString &s ); - int GetX( void ) const; - int GetY( void ) const; - int GetWidth() const; - int GetHeight() const; - int GetImage() const; - void GetItem( wxListItem &info ); - wxColour *GetColour(); - -private: - DECLARE_DYNAMIC_CLASS(wxListItemData); -}; - -//----------------------------------------------------------------------------- -// wxListHeaderData (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListHeaderData : public wxObject -{ -protected: - long m_mask; - int m_image; - wxString m_text; - int m_format; - int m_width; - int m_xpos,m_ypos; - int m_height; - -public: - wxListHeaderData(); - wxListHeaderData( const wxListItem &info ); - void SetItem( const wxListItem &item ); - void SetPosition( int x, int y ); - void SetWidth( int w ); - void SetFormat( int format ); - void SetHeight( int h ); - bool HasImage() const; - bool HasText() const; - bool IsHit( int x, int y ) const; - void GetItem( wxListItem &item ); - void GetText( wxString &s ); - int GetImage() const; - int GetWidth() const; - int GetFormat() const; - -private: - DECLARE_DYNAMIC_CLASS(wxListHeaderData); -}; - -//----------------------------------------------------------------------------- -// wxListLineData (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListLineData : public wxObject -{ -public: - wxList m_items; - wxRect m_bound_all; - wxRect m_bound_label; - wxRect m_bound_icon; - wxRect m_bound_hilight; - int m_mode; - bool m_hilighted; - wxBrush *m_hilightBrush; - int m_spacing; - wxListMainWindow *m_owner; - - void DoDraw( wxDC *dc, bool hilight, bool paintBG ); - -public: - wxListLineData() {} - wxListLineData( wxListMainWindow *owner, int mode, wxBrush *hilightBrush ); - void CalculateSize( wxDC *dc, int spacing ); - void SetPosition( wxDC *dc, int x, int y, int window_width ); - void SetColumnPosition( int index, int x ); - void GetSize( int &width, int &height ); - void GetExtent( int &x, int &y, int &width, int &height ); - void GetLabelExtent( int &x, int &y, int &width, int &height ); - long IsHit( int x, int y ); - void InitItems( int num ); - void SetItem( int index, const wxListItem &info ); - void GetItem( int index, wxListItem &info ); - void GetText( int index, wxString &s ); - void SetText( int index, const wxString s ); - int GetImage( int index ); - void GetRect( wxRect &rect ); - void Hilight( bool on ); - void ReverseHilight(); - void DrawRubberBand( wxDC *dc, bool on ); - void Draw( wxDC *dc ); - bool IsInRect( int x, int y, const wxRect &rect ); - bool IsHilighted(); - void AssignRect( wxRect &dest, int x, int y, int width, int height ); - void AssignRect( wxRect &dest, const wxRect &source ); - -private: - DECLARE_DYNAMIC_CLASS(wxListLineData); -}; - -//----------------------------------------------------------------------------- -// wxListHeaderWindow (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListHeaderWindow : public wxWindow -{ -protected: - wxListMainWindow *m_owner; - wxCursor *m_currentCursor; - wxCursor *m_resizeCursor; - bool m_isDragging; - int m_column; - int m_minX; - int m_currentX; - -public: - wxListHeaderWindow(); - ~wxListHeaderWindow(); - wxListHeaderWindow( wxWindow *win, wxWindowID id, wxListMainWindow *owner, - const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, - long style = 0, const wxString &name = "columntitles" ); - void DoDrawRect( wxDC *dc, int x, int y, int w, int h ); - void OnPaint( wxPaintEvent &event ); - void DrawCurrent(); - void OnMouse( wxMouseEvent &event ); - void OnSetFocus( wxFocusEvent &event ); - -private: - DECLARE_DYNAMIC_CLASS(wxListHeaderWindow) - DECLARE_EVENT_TABLE() -}; - -//----------------------------------------------------------------------------- -// wxListRenameTimer (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListRenameTimer: public wxTimer -{ -private: - wxListMainWindow *m_owner; - -public: - wxListRenameTimer( wxListMainWindow *owner ); - void Notify(); -}; - -//----------------------------------------------------------------------------- -// wxListTextCtrl (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListTextCtrl: public wxTextCtrl -{ -private: - bool *m_accept; - wxString *m_res; - wxListMainWindow *m_owner; - wxString m_startValue; - -public: - wxListTextCtrl() {} - wxListTextCtrl( wxWindow *parent, const wxWindowID id, - bool *accept, wxString *res, wxListMainWindow *owner, - const wxString &value = "", - const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, -#if wxUSE_VALIDATORS - int style = 0, const wxValidator& validator = wxDefaultValidator, -#endif - const wxString &name = "wxListTextCtrlText" ); - void OnChar( wxKeyEvent &event ); - void OnKillFocus( wxFocusEvent &event ); - -private: - DECLARE_DYNAMIC_CLASS(wxListTextCtrl); - DECLARE_EVENT_TABLE() -}; - -//----------------------------------------------------------------------------- -// wxListMainWindow (internal) -//----------------------------------------------------------------------------- - -class WXDLLEXPORT wxListMainWindow: public wxScrolledWindow -{ -public: - long m_mode; - wxList m_lines; - wxList m_columns; - wxListLineData *m_current; - wxListLineData *m_currentEdit; - int m_visibleLines; - wxBrush *m_hilightBrush; - wxColour *m_hilightColour; - int m_xScroll,m_yScroll; - bool m_dirty; - wxImageList *m_small_image_list; - wxImageList *m_normal_image_list; - int m_small_spacing; - int m_normal_spacing; - bool m_hasFocus; - bool m_usedKeys; - bool m_lastOnSame; - wxTimer *m_renameTimer; - bool m_renameAccept; - wxString m_renameRes; - bool m_isCreated; - int m_dragCount; - wxPoint m_dragStart; - -public: - wxListMainWindow(); - wxListMainWindow( wxWindow *parent, wxWindowID id, - const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, - long style = 0, const wxString &name = "listctrl" ); - ~wxListMainWindow(); - void RefreshLine( wxListLineData *line ); - void OnPaint( wxPaintEvent &event ); - void HilightAll( bool on ); - void SendNotify( wxListLineData *line, wxEventType command ); - void FocusLine( wxListLineData *line ); - void UnfocusLine( wxListLineData *line ); - void SelectLine( wxListLineData *line ); - void DeselectLine( wxListLineData *line ); - void DeleteLine( wxListLineData *line ); - - void EditLabel( long item ); - void Edit( long item ) { EditLabel(item); } // deprecated - void OnRenameTimer(); - void OnRenameAccept(); - - void OnMouse( wxMouseEvent &event ); - void MoveToFocus(); - void OnArrowChar( wxListLineData *newCurrent, bool shiftDown ); - void OnChar( wxKeyEvent &event ); - void OnKeyDown( wxKeyEvent &event ); - void OnSetFocus( wxFocusEvent &event ); - void OnKillFocus( wxFocusEvent &event ); - void OnSize( wxSizeEvent &event ); - void OnScroll(wxScrollWinEvent& event) ; - - void DrawImage( int index, wxDC *dc, int x, int y ); - void GetImageSize( int index, int &width, int &height ); - int GetIndexOfLine( const wxListLineData *line ); - int GetTextLength( wxString &s ); // should be const - - void SetImageList( wxImageList *imageList, int which ); - void SetItemSpacing( int spacing, bool isSmall = FALSE ); - int GetItemSpacing( bool isSmall = FALSE ); - void SetColumn( int col, wxListItem &item ); - void SetColumnWidth( int col, int width ); - void GetColumn( int col, wxListItem &item ); - int GetColumnWidth( int vol ); - int GetColumnCount(); - int GetCountPerPage(); - void SetItem( wxListItem &item ); - void GetItem( wxListItem &item ); - void SetItemState( long item, long state, long stateMask ); - int GetItemState( long item, long stateMask ); - int GetItemCount(); - void GetItemRect( long index, wxRect &rect ); - bool GetItemPosition( long item, wxPoint& pos ); - int GetSelectedItemCount(); - void SetMode( long mode ); - long GetMode() const; - void CalculatePositions(); - void RealizeChanges(); - long GetNextItem( long item, int geometry, int state ); - void DeleteItem( long index ); - void DeleteAllItems(); - void DeleteColumn( int col ); - void DeleteEverything(); - void EnsureVisible( long index ); - long FindItem( long start, const wxString& str, bool partial = FALSE ); - long FindItem( long start, long data); - long HitTest( int x, int y, int &flags ); - void InsertItem( wxListItem &item ); -// void AddItem( wxListItem &item ); - void InsertColumn( long col, wxListItem &item ); -// void AddColumn( wxListItem &item ); - void SortItems( wxListCtrlCompare fn, long data ); - -private: - DECLARE_DYNAMIC_CLASS(wxListMainWindow); - DECLARE_EVENT_TABLE() -}; - //----------------------------------------------------------------------------- // wxListCtrl //----------------------------------------------------------------------------- @@ -509,23 +59,25 @@ class WXDLLEXPORT wxListCtrl: public wxControl { public: wxListCtrl(); - wxListCtrl( wxWindow *parent, wxWindowID id = -1, - const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, -#if wxUSE_VALIDATORS - long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, -#endif - const wxString &name = "listctrl" ) + wxListCtrl( wxWindow *parent, + wxWindowID id = -1, + const wxPoint &pos = wxDefaultPosition, + const wxSize &size = wxDefaultSize, + long style = wxLC_ICON, + const wxValidator& validator = wxDefaultValidator, + const wxString &name = "listctrl" ) { Create(parent, id, pos, size, style, validator, name); } ~wxListCtrl(); - - bool Create( wxWindow *parent, wxWindowID id = -1, - const wxPoint &pos = wxDefaultPosition, const wxSize &size = wxDefaultSize, -#if wxUSE_VALIDATORS - long style = wxLC_ICON, const wxValidator& validator = wxDefaultValidator, -#endif - const wxString &name = "listctrl" ); + + bool Create( wxWindow *parent, + wxWindowID id = -1, + const wxPoint &pos = wxDefaultPosition, + const wxSize &size = wxDefaultSize, + long style = wxLC_ICON, + const wxValidator& validator = wxDefaultValidator, + const wxString &name = "listctrl" ); bool GetColumn( int col, wxListItem& item ) const; bool SetColumn( int col, wxListItem& item ); @@ -551,8 +103,8 @@ public: void SetItemSpacing( int spacing, bool isSmall = FALSE ); int GetItemSpacing( bool isSmall ) const; int GetSelectedItemCount() const; -// wxColour GetTextColour() const; // wxGLC has colours for every Item (see wxListItem) -// void SetTextColour(const wxColour& col); + wxColour GetTextColour() const; + void SetTextColour(const wxColour& col); long GetTopItem() const; void SetSingleStyle( long style, bool add = TRUE ) ; @@ -561,6 +113,7 @@ public: 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(); @@ -569,6 +122,8 @@ public: bool DeleteAllColumns(); bool DeleteColumn( int col ); + void SetItemCount(long count); + void EditLabel( long item ) { Edit(item); } void Edit( long item ); @@ -587,7 +142,17 @@ public: bool ScrollList( int dx, int dy ); bool SortItems( wxListCtrlCompare fn, long data ); bool Update( long item ); - + + // returns true if it is a virtual list control + bool IsVirtual() const { return (GetWindowStyle() & wxLC_VIRTUAL) != 0; } + + // refresh items selectively (only useful for virtual list controls) + void RefreshItem(long item); + void RefreshItems(long itemFrom, long itemTo); + + // implementation only from now on + // ------------------------------- + void OnIdle( wxIdleEvent &event ); void OnSize( wxSizeEvent &event ); @@ -598,27 +163,15 @@ public: bool SetFont( const wxFont &font ); #if wxUSE_DRAG_AND_DROP - void SetDropTarget( wxDropTarget *dropTarget ) - { m_mainWin->SetDropTarget( dropTarget ); } - wxDropTarget *GetDropTarget() const - { return m_mainWin->GetDropTarget(); } + void SetDropTarget( wxDropTarget *dropTarget ); + wxDropTarget *GetDropTarget() const; #endif - bool SetCursor( const wxCursor &cursor ) - { return m_mainWin ? m_mainWin->wxWindow::SetCursor(cursor) : FALSE; } - wxColour GetBackgroundColour() const - { return m_mainWin ? m_mainWin->GetBackgroundColour() : wxColour(); } - wxColour GetForegroundColour() const - { return m_mainWin ? m_mainWin->GetForegroundColour() : wxColour(); } - bool DoPopupMenu( wxMenu *menu, int x, int y ) - { return m_mainWin->PopupMenu( menu, x, y ); } - void SetFocus() - { - /* The test in window.cpp fails as we are a composite - window, so it checks against "this", but not m_mainWin. */ - if (FindFocus() != this) - m_mainWin->SetFocus(); - } + bool SetCursor( const wxCursor &cursor ); + wxColour GetBackgroundColour() const; + wxColour GetForegroundColour() const; + bool DoPopupMenu( wxMenu *menu, int x, int y ); + void SetFocus(); // implementation // -------------- @@ -626,10 +179,36 @@ public: 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: + // 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 + virtual int OnGetItemImage(long item) 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; + private: + // Virtual function hiding supression + virtual void Update() { wxWindowBase::Update(); } + + // create the header window + void CreateHeaderWindow(); + + // 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(wxListCtrl); };