1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/generic/listctrl.h
3 // Purpose: private definitions of wxListCtrl helpers
4 // Author: Robert Roebling
5 // Vadim Zeitlin (virtual list control support)
7 // Copyright: (c) 1998 Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
11 #ifndef _WX_GENERIC_LISTCTRL_PRIVATE_H_
12 #define _WX_GENERIC_LISTCTRL_PRIVATE_H_
18 #include "wx/listctrl.h"
19 #include "wx/selstore.h"
21 #include "wx/settings.h"
23 // ============================================================================
25 // ============================================================================
27 //-----------------------------------------------------------------------------
28 // wxColWidthInfo (internal)
29 //-----------------------------------------------------------------------------
34 bool bNeedsUpdate
; // only set to true when an item whose
35 // width == nMaxWidth is removed
37 wxColWidthInfo(int w
= 0, bool needsUpdate
= false)
40 bNeedsUpdate
= needsUpdate
;
44 WX_DEFINE_ARRAY_PTR(wxColWidthInfo
*, ColWidthArray
);
46 //-----------------------------------------------------------------------------
47 // wxListItemData (internal)
48 //-----------------------------------------------------------------------------
53 wxListItemData(wxListMainWindow
*owner
);
56 void SetItem( const wxListItem
&info
);
57 void SetImage( int image
) { m_image
= image
; }
58 void SetData( wxUIntPtr data
) { m_data
= data
; }
59 void SetPosition( int x
, int y
);
60 void SetSize( int width
, int height
);
62 bool HasText() const { return !m_text
.empty(); }
63 const wxString
& GetText() const { return m_text
; }
64 void SetText(const wxString
& text
) { m_text
= text
; }
66 // we can't use empty string for measuring the string width/height, so
67 // always return something
68 wxString
GetTextForMeasuring() const
70 wxString s
= GetText();
77 bool IsHit( int x
, int y
) const;
82 int GetHeight() const;
84 int GetImage() const { return m_image
; }
85 bool HasImage() const { return GetImage() != -1; }
87 void GetItem( wxListItem
&info
) const;
89 void SetAttr(wxListItemAttr
*attr
) { m_attr
= attr
; }
90 wxListItemAttr
*GetAttr() const { return m_attr
; }
93 // the item image or -1
96 // user data associated with the item
99 // the item coordinates are not used in report mode; instead this pointer is
100 // NULL and the owner window is used to retrieve the item position and size
103 // the list ctrl we are in
104 wxListMainWindow
*m_owner
;
106 // custom attributes or NULL
107 wxListItemAttr
*m_attr
;
110 // common part of all ctors
116 //-----------------------------------------------------------------------------
117 // wxListHeaderData (internal)
118 //-----------------------------------------------------------------------------
120 class wxListHeaderData
: public wxObject
124 wxListHeaderData( const wxListItem
&info
);
125 void SetItem( const wxListItem
&item
);
126 void SetPosition( int x
, int y
);
127 void SetWidth( int w
);
128 void SetState( int state
);
129 void SetFormat( int format
);
130 void SetHeight( int h
);
131 bool HasImage() const;
133 bool HasText() const { return !m_text
.empty(); }
134 const wxString
& GetText() const { return m_text
; }
135 void SetText(const wxString
& text
) { m_text
= text
; }
137 void GetItem( wxListItem
&item
);
139 bool IsHit( int x
, int y
) const;
140 int GetImage() const;
141 int GetWidth() const;
142 int GetFormat() const;
143 int GetState() const;
160 //-----------------------------------------------------------------------------
161 // wxListLineData (internal)
162 //-----------------------------------------------------------------------------
164 WX_DECLARE_LIST(wxListItemData
, wxListItemDataList
);
169 // the list of subitems: only may have more than one item in report mode
170 wxListItemDataList m_items
;
172 // this is not used in report view
184 // the part to be highlighted
185 wxRect m_rectHighlight
;
187 // extend all our rects to be centered inside the one of given width
188 void ExtendWidth(wxCoord w
)
190 wxASSERT_MSG( m_rectAll
.width
<= w
,
191 wxT("width can only be increased") );
194 m_rectLabel
.x
= m_rectAll
.x
+ (w
- m_rectLabel
.width
) / 2;
195 m_rectIcon
.x
= m_rectAll
.x
+ (w
- m_rectIcon
.width
) / 2;
196 m_rectHighlight
.x
= m_rectAll
.x
+ (w
- m_rectHighlight
.width
) / 2;
201 // is this item selected? [NB: not used in virtual mode]
204 // back pointer to the list ctrl
205 wxListMainWindow
*m_owner
;
208 wxListLineData(wxListMainWindow
*owner
);
212 WX_CLEAR_LIST(wxListItemDataList
, m_items
);
216 // called by the owner when it toggles report view
217 void SetReportView(bool inReportView
)
219 // we only need m_gi when we're not in report view so update as needed
227 m_gi
= new GeometryInfo
;
231 // are we in report mode?
232 inline bool InReportView() const;
234 // are we in virtual report mode?
235 inline bool IsVirtual() const;
237 // these 2 methods shouldn't be called for report view controls, in that
238 // case we determine our position/size ourselves
240 // calculate the size of the line
241 void CalculateSize( wxDC
*dc
, int spacing
);
243 // remember the position this line appears at
244 void SetPosition( int x
, int y
, int spacing
);
248 void SetImage( int image
) { SetImage(0, image
); }
249 int GetImage() const { return GetImage(0); }
250 void SetImage( int index
, int image
);
251 int GetImage( int index
) const;
253 bool HasImage() const { return GetImage() != -1; }
254 bool HasText() const { return !GetText(0).empty(); }
256 void SetItem( int index
, const wxListItem
&info
);
257 void GetItem( int index
, wxListItem
&info
);
259 wxString
GetText(int index
) const;
260 void SetText( int index
, const wxString
& s
);
262 wxListItemAttr
*GetAttr() const;
263 void SetAttr(wxListItemAttr
*attr
);
265 // return true if the highlighting really changed
266 bool Highlight( bool on
);
268 void ReverseHighlight();
270 bool IsHighlighted() const
272 wxASSERT_MSG( !IsVirtual(), wxT("unexpected call to IsHighlighted") );
274 return m_highlighted
;
277 // draw the line on the given DC in icon/list mode
278 void Draw( wxDC
*dc
, bool current
);
280 // the same in report mode: it needs more parameters as we don't store
281 // everything in the item in report mode
282 void DrawInReportMode( wxDC
*dc
,
284 const wxRect
& rectHL
,
289 // set the line to contain num items (only can be > 1 in report mode)
290 void InitItems( int num
);
292 // get the mode (i.e. style) of the list control
293 inline int GetMode() const;
295 // Apply this item attributes to the given DC: set the text font and colour
296 // and also erase the background appropriately.
297 void ApplyAttributes(wxDC
*dc
,
298 const wxRect
& rectHL
,
302 // draw the text on the DC with the correct justification; also add an
303 // ellipsis if the text is too large to fit in the current width
304 void DrawTextFormatted(wxDC
*dc
,
305 const wxString
&text
,
308 int yMid
, // this is middle, not top, of the text
312 WX_DECLARE_OBJARRAY(wxListLineData
, wxListLineDataArray
);
314 //-----------------------------------------------------------------------------
315 // wxListHeaderWindow (internal)
316 //-----------------------------------------------------------------------------
318 class wxListHeaderWindow
: public wxWindow
321 wxListMainWindow
*m_owner
;
322 const wxCursor
*m_currentCursor
;
323 wxCursor
*m_resizeCursor
;
326 // column being resized or -1
329 // divider line position in logical (unscrolled) coords
332 // minimal position beyond which the divider line
333 // can't be dragged in logical coords
337 wxListHeaderWindow();
339 wxListHeaderWindow( wxWindow
*win
,
341 wxListMainWindow
*owner
,
342 const wxPoint
&pos
= wxDefaultPosition
,
343 const wxSize
&size
= wxDefaultSize
,
345 const wxString
&name
= wxT("wxlistctrlcolumntitles") );
347 virtual ~wxListHeaderWindow();
350 void AdjustDC( wxDC
& dc
);
352 void OnPaint( wxPaintEvent
&event
);
353 void OnMouse( wxMouseEvent
&event
);
354 void OnSetFocus( wxFocusEvent
&event
);
359 // Update main window's column later
360 bool m_sendSetColumnWidth
;
364 virtual void OnInternalIdle();
367 // common part of all ctors
370 // generate and process the list event of the given type, return true if
371 // it wasn't vetoed, i.e. if we should proceed
372 bool SendListEvent(wxEventType type
, const wxPoint
& pos
);
374 DECLARE_EVENT_TABLE()
377 //-----------------------------------------------------------------------------
378 // wxListRenameTimer (internal)
379 //-----------------------------------------------------------------------------
381 class wxListRenameTimer
: public wxTimer
384 wxListMainWindow
*m_owner
;
387 wxListRenameTimer( wxListMainWindow
*owner
);
391 //-----------------------------------------------------------------------------
392 // wxListTextCtrlWrapper: wraps a wxTextCtrl to make it work for inline editing
393 //-----------------------------------------------------------------------------
395 class wxListTextCtrlWrapper
: public wxEvtHandler
398 // NB: text must be a valid object but not Create()d yet
399 wxListTextCtrlWrapper(wxListMainWindow
*owner
,
403 wxTextCtrl
*GetText() const { return m_text
; }
405 // Check if the given key event should stop editing and return true if it
406 // does or false otherwise.
407 bool CheckForEndEditKey(const wxKeyEvent
& event
);
409 // Different reasons for calling EndEdit():
411 // It was called because:
414 End_Accept
, // user has accepted the changes.
415 End_Discard
, // user has cancelled editing.
416 End_Destroy
// the entire control is being destroyed.
419 void EndEdit(EndReason reason
);
422 void OnChar( wxKeyEvent
&event
);
423 void OnKeyUp( wxKeyEvent
&event
);
424 void OnKillFocus( wxFocusEvent
&event
);
426 bool AcceptChanges();
427 void Finish( bool setfocus
);
430 wxListMainWindow
*m_owner
;
432 wxString m_startValue
;
434 bool m_aboutToFinish
;
436 DECLARE_EVENT_TABLE()
439 //-----------------------------------------------------------------------------
440 // wxListMainWindow (internal)
441 //-----------------------------------------------------------------------------
443 WX_DECLARE_LIST(wxListHeaderData
, wxListHeaderDataList
);
445 class wxListMainWindow
: public wxWindow
449 wxListMainWindow( wxWindow
*parent
,
451 const wxPoint
& pos
= wxDefaultPosition
,
452 const wxSize
& size
= wxDefaultSize
,
454 const wxString
&name
= wxT("listctrlmainwindow") );
456 virtual ~wxListMainWindow();
458 // called by the main control when its mode changes
459 void SetReportView(bool inReportView
);
461 // helper to simplify testing for wxLC_XXX flags
462 bool HasFlag(int flag
) const { return m_parent
->HasFlag(flag
); }
464 // return true if this is a virtual list control
465 bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL
); }
467 // return true if the control is in report mode
468 bool InReportView() const { return HasFlag(wxLC_REPORT
); }
470 // return true if we are in single selection mode, false if multi sel
471 bool IsSingleSel() const { return HasFlag(wxLC_SINGLE_SEL
); }
473 // do we have a header window?
474 bool HasHeader() const
475 { return InReportView() && !HasFlag(wxLC_NO_HEADER
); }
477 void HighlightAll( bool on
);
479 // all these functions only do something if the line is currently visible
481 // change the line "selected" state, return true if it really changed
482 bool HighlightLine( size_t line
, bool highlight
= true);
484 // as HighlightLine() but do it for the range of lines: this is incredibly
485 // more efficient for virtual list controls!
487 // NB: unlike HighlightLine() this one does refresh the lines on screen
488 void HighlightLines( size_t lineFrom
, size_t lineTo
, bool on
= true );
490 // toggle the line state and refresh it
491 void ReverseHighlight( size_t line
)
492 { HighlightLine(line
, !IsHighlighted(line
)); RefreshLine(line
); }
494 // return true if the line is highlighted
495 bool IsHighlighted(size_t line
) const;
497 // refresh one or several lines at once
498 void RefreshLine( size_t line
);
499 void RefreshLines( size_t lineFrom
, size_t lineTo
);
501 // refresh all selected items
502 void RefreshSelected();
504 // refresh all lines below the given one: the difference with
505 // RefreshLines() is that the index here might not be a valid one (happens
506 // when the last line is deleted)
507 void RefreshAfter( size_t lineFrom
);
509 // the methods which are forwarded to wxListLineData itself in list/icon
510 // modes but are here because the lines don't store their positions in the
513 // get the bound rect for the entire line
514 wxRect
GetLineRect(size_t line
) const;
516 // get the bound rect of the label
517 wxRect
GetLineLabelRect(size_t line
) const;
519 // get the bound rect of the items icon (only may be called if we do have
521 wxRect
GetLineIconRect(size_t line
) const;
523 // get the rect to be highlighted when the item has focus
524 wxRect
GetLineHighlightRect(size_t line
) const;
526 // get the size of the total line rect
527 wxSize
GetLineSize(size_t line
) const
528 { return GetLineRect(line
).GetSize(); }
530 // return the hit code for the corresponding position (in this line)
531 long HitTestLine(size_t line
, int x
, int y
) const;
533 // bring the selected item into view, scrolling to it if necessary
534 void MoveToItem(size_t item
);
536 bool ScrollList( int WXUNUSED(dx
), int dy
);
538 // bring the current item into view
539 void MoveToFocus() { MoveToItem(m_current
); }
541 // start editing the label of the given item
542 wxTextCtrl
*EditLabel(long item
,
543 wxClassInfo
* textControlClass
= wxCLASSINFO(wxTextCtrl
));
544 wxTextCtrl
*GetEditControl() const
546 return m_textctrlWrapper
? m_textctrlWrapper
->GetText() : NULL
;
549 void ResetTextControl(wxTextCtrl
*text
)
552 m_textctrlWrapper
= NULL
;
555 void OnRenameTimer();
556 bool OnRenameAccept(size_t itemEdit
, const wxString
& value
);
557 void OnRenameCancelled(size_t itemEdit
);
559 void OnMouse( wxMouseEvent
&event
);
561 // called to switch the selection from the current item to newCurrent,
562 void OnArrowChar( size_t newCurrent
, const wxKeyEvent
& event
);
564 void OnCharHook( wxKeyEvent
&event
);
565 void OnChar( wxKeyEvent
&event
);
566 void OnKeyDown( wxKeyEvent
&event
);
567 void OnKeyUp( wxKeyEvent
&event
);
568 void OnSetFocus( wxFocusEvent
&event
);
569 void OnKillFocus( wxFocusEvent
&event
);
570 void OnScroll( wxScrollWinEvent
& event
);
572 void OnPaint( wxPaintEvent
&event
);
574 void OnChildFocus(wxChildFocusEvent
& event
);
576 void DrawImage( int index
, wxDC
*dc
, int x
, int y
);
577 void GetImageSize( int index
, int &width
, int &height
) const;
578 int GetTextLength( const wxString
&s
) const;
580 void SetImageList( wxImageList
*imageList
, int which
);
581 void SetItemSpacing( int spacing
, bool isSmall
= false );
582 int GetItemSpacing( bool isSmall
= false );
584 void SetColumn( int col
, const wxListItem
&item
);
585 void SetColumnWidth( int col
, int width
);
586 void GetColumn( int col
, wxListItem
&item
) const;
587 int GetColumnWidth( int col
) const;
588 int GetColumnCount() const { return m_columns
.GetCount(); }
590 // returns the sum of the heights of all columns
591 int GetHeaderWidth() const;
593 int GetCountPerPage() const;
595 void SetItem( wxListItem
&item
);
596 void GetItem( wxListItem
&item
) const;
597 void SetItemState( long item
, long state
, long stateMask
);
598 void SetItemStateAll( long state
, long stateMask
);
599 int GetItemState( long item
, long stateMask
) const;
600 bool GetItemRect( long item
, wxRect
&rect
) const
602 return GetSubItemRect(item
, wxLIST_GETSUBITEMRECT_WHOLEITEM
, rect
);
604 bool GetSubItemRect( long item
, long subItem
, wxRect
& rect
) const;
605 wxRect
GetViewRect() const;
606 bool GetItemPosition( long item
, wxPoint
& pos
) const;
607 int GetSelectedItemCount() const;
609 wxString
GetItemText(long item
, int col
= 0) const
612 info
.m_mask
= wxLIST_MASK_TEXT
;
613 info
.m_itemId
= item
;
619 void SetItemText(long item
, const wxString
& value
)
622 info
.m_mask
= wxLIST_MASK_TEXT
;
623 info
.m_itemId
= item
;
628 wxImageList
* GetSmallImageList() const
629 { return m_small_image_list
; }
631 // set the scrollbars and update the positions of the items
632 void RecalculatePositions(bool noRefresh
= false);
634 // refresh the window and the header
637 long GetNextItem( long item
, int geometry
, int state
) const;
638 void DeleteItem( long index
);
639 void DeleteAllItems();
640 void DeleteColumn( int col
);
641 void DeleteEverything();
642 void EnsureVisible( long index
);
643 long FindItem( long start
, const wxString
& str
, bool partial
= false );
644 long FindItem( long start
, wxUIntPtr data
);
645 long FindItem( const wxPoint
& pt
);
646 long HitTest( int x
, int y
, int &flags
) const;
647 void InsertItem( wxListItem
&item
);
648 void InsertColumn( long col
, const wxListItem
&item
);
649 int GetItemWidthWithImage(wxListItem
* item
);
650 void SortItems( wxListCtrlCompare fn
, wxIntPtr data
);
652 size_t GetItemCount() const;
653 bool IsEmpty() const { return GetItemCount() == 0; }
654 void SetItemCount(long count
);
656 // change the current (== focused) item, send a notification event
657 void ChangeCurrent(size_t current
);
658 void ResetCurrent() { ChangeCurrent((size_t)-1); }
659 bool HasCurrent() const { return m_current
!= (size_t)-1; }
661 // send out a wxListEvent
662 void SendNotify( size_t line
,
664 const wxPoint
& point
= wxDefaultPosition
);
666 // override base class virtual to reset m_lineHeight when the font changes
667 virtual bool SetFont(const wxFont
& font
)
669 if ( !wxWindow::SetFont(font
) )
677 // these are for wxListLineData usage only
679 // get the backpointer to the list ctrl
680 wxGenericListCtrl
*GetListCtrl() const
682 return wxStaticCast(GetParent(), wxGenericListCtrl
);
685 // get the height of all lines (assuming they all do have the same height)
686 wxCoord
GetLineHeight() const;
688 // get the y position of the given line (only for report view)
689 wxCoord
GetLineY(size_t line
) const;
691 // get the brush to use for the item highlighting
692 wxBrush
*GetHighlightBrush() const
694 return m_hasFocus
? m_highlightBrush
: m_highlightUnfocusedBrush
;
697 bool HasFocus() const
703 // the array of all line objects for a non virtual list control (for the
704 // virtual list control we only ever use m_lines[0])
705 wxListLineDataArray m_lines
;
707 // the list of column objects
708 wxListHeaderDataList m_columns
;
710 // currently focused item or -1
713 // the number of lines per page
716 // this flag is set when something which should result in the window
717 // redrawing happens (i.e. an item was added or deleted, or its appearance
718 // changed) and OnPaint() doesn't redraw the window while it is set which
719 // allows to minimize the number of repaintings when a lot of items are
720 // being added. The real repainting occurs only after the next OnIdle()
724 wxColour
*m_highlightColour
;
725 wxImageList
*m_small_image_list
;
726 wxImageList
*m_normal_image_list
;
728 int m_normal_spacing
;
732 wxTimer
*m_renameTimer
;
736 ColWidthArray m_aColWidths
;
738 // for double click logic
739 size_t m_lineLastClicked
,
740 m_lineBeforeLastClicked
,
741 m_lineSelectSingleOnUp
;
744 wxWindow
*GetMainWindowOfCompositeControl() { return GetParent(); }
746 // the total count of items in a virtual list control
749 // the object maintaining the items selection state, only used in virtual
751 wxSelectionStore m_selStore
;
753 // common part of all ctors
756 // get the line data for the given index
757 wxListLineData
*GetLine(size_t n
) const
759 wxASSERT_MSG( n
!= (size_t)-1, wxT("invalid line index") );
763 wxConstCast(this, wxListMainWindow
)->CacheLineData(n
);
770 // get a dummy line which can be used for geometry calculations and such:
771 // you must use GetLine() if you want to really draw the line
772 wxListLineData
*GetDummyLine() const;
774 // cache the line data of the n-th line in m_lines[0]
775 void CacheLineData(size_t line
);
777 // get the range of visible lines
778 void GetVisibleLinesRange(size_t *from
, size_t *to
);
780 // force us to recalculate the range of visible lines
781 void ResetVisibleLinesRange() { m_lineFrom
= (size_t)-1; }
783 // get the colour to be used for drawing the rules
784 wxColour
GetRuleColour() const
786 return wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT
);
790 // initialize the current item if needed
791 void UpdateCurrent();
793 // delete all items but don't refresh: called from dtor
794 void DoDeleteAllItems();
796 // the height of one line using the current font
797 wxCoord m_lineHeight
;
799 // the total header width or 0 if not calculated yet
800 wxCoord m_headerWidth
;
802 // the first and last lines being shown on screen right now (inclusive),
803 // both may be -1 if they must be calculated so never access them directly:
804 // use GetVisibleLinesRange() above instead
808 // the brushes to use for item highlighting when we do/don't have focus
809 wxBrush
*m_highlightBrush
,
810 *m_highlightUnfocusedBrush
;
812 // wrapper around the text control currently used for in place editing or
813 // NULL if no item is being edited
814 wxListTextCtrlWrapper
*m_textctrlWrapper
;
817 DECLARE_EVENT_TABLE()
819 friend class wxGenericListCtrl
;
822 #endif // wxUSE_LISTCTRL
823 #endif // _WX_GENERIC_LISTCTRL_PRIVATE_H_