1 /////////////////////////////////////////////////////////////////////////////
2 // Name: src/generic/listctrl.cpp
3 // Purpose: generic implementation of wxListCtrl
4 // Author: Robert Roebling
5 // Vadim Zeitlin (virtual list control support)
7 // Copyright: (c) 1998 Robert Roebling
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
13 // 1. we need to implement searching/sorting for virtual controls somehow
14 // 2. when changing selection the lines are refreshed twice
17 // For compilers that support precompilation, includes "wx.h".
18 #include "wx/wxprec.h"
26 #include "wx/listctrl.h"
29 #include "wx/scrolwin.h"
31 #include "wx/settings.h"
32 #include "wx/dynarray.h"
33 #include "wx/dcclient.h"
34 #include "wx/dcscreen.h"
36 #include "wx/settings.h"
40 #include "wx/imaglist.h"
41 #include "wx/renderer.h"
42 #include "wx/generic/private/listctrl.h"
45 #include "wx/osx/private.h"
48 #if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__)
49 #define "wx/msw/wrapwin.h"
52 // NOTE: If using the wxListBox visual attributes works everywhere then this can
53 // be removed, as well as the #else case below.
54 #define _USE_VISATTR 0
57 // ----------------------------------------------------------------------------
59 // ----------------------------------------------------------------------------
61 // // the height of the header window (FIXME: should depend on its font!)
62 // static const int HEADER_HEIGHT = 23;
64 static const int SCROLL_UNIT_X
= 15;
66 // the spacing between the lines (in report mode)
67 static const int LINE_SPACING
= 0;
69 // extra margins around the text label
71 static const int EXTRA_WIDTH
= 6;
73 static const int EXTRA_WIDTH
= 4;
77 static const int EXTRA_HEIGHT
= 6;
79 static const int EXTRA_HEIGHT
= 4;
82 // margin between the window and the items
83 static const int EXTRA_BORDER_X
= 2;
84 static const int EXTRA_BORDER_Y
= 2;
86 // offset for the header window
87 static const int HEADER_OFFSET_X
= 0;
88 static const int HEADER_OFFSET_Y
= 0;
90 // margin between rows of icons in [small] icon view
91 static const int MARGIN_BETWEEN_ROWS
= 6;
93 // when autosizing the columns, add some slack
94 static const int AUTOSIZE_COL_MARGIN
= 10;
96 // default width for the header columns
97 static const int WIDTH_COL_DEFAULT
= 80;
99 // the space between the image and the text in the report mode
100 static const int IMAGE_MARGIN_IN_REPORT_MODE
= 5;
102 // the space between the image and the text in the report mode in header
103 static const int HEADER_IMAGE_MARGIN_IN_REPORT_MODE
= 2;
107 // ----------------------------------------------------------------------------
108 // arrays/list implementations
109 // ----------------------------------------------------------------------------
111 #include "wx/listimpl.cpp"
112 WX_DEFINE_LIST(wxListItemDataList
)
114 #include "wx/arrimpl.cpp"
115 WX_DEFINE_OBJARRAY(wxListLineDataArray
)
117 #include "wx/listimpl.cpp"
118 WX_DEFINE_LIST(wxListHeaderDataList
)
121 // ----------------------------------------------------------------------------
123 // ----------------------------------------------------------------------------
125 wxListItemData::~wxListItemData()
127 // in the virtual list control the attributes are managed by the main
128 // program, so don't delete them
129 if ( !m_owner
->IsVirtual() )
135 void wxListItemData::Init()
143 wxListItemData::wxListItemData(wxListMainWindow
*owner
)
149 if ( owner
->InReportView() )
155 void wxListItemData::SetItem( const wxListItem
&info
)
157 if ( info
.m_mask
& wxLIST_MASK_TEXT
)
158 SetText(info
.m_text
);
159 if ( info
.m_mask
& wxLIST_MASK_IMAGE
)
160 m_image
= info
.m_image
;
161 if ( info
.m_mask
& wxLIST_MASK_DATA
)
162 m_data
= info
.m_data
;
164 if ( info
.HasAttributes() )
167 m_attr
->AssignFrom(*info
.GetAttributes());
169 m_attr
= new wxListItemAttr(*info
.GetAttributes());
177 m_rect
->width
= info
.m_width
;
181 void wxListItemData::SetPosition( int x
, int y
)
183 wxCHECK_RET( m_rect
, wxT("unexpected SetPosition() call") );
189 void wxListItemData::SetSize( int width
, int height
)
191 wxCHECK_RET( m_rect
, wxT("unexpected SetSize() call") );
194 m_rect
->width
= width
;
196 m_rect
->height
= height
;
199 bool wxListItemData::IsHit( int x
, int y
) const
201 wxCHECK_MSG( m_rect
, false, wxT("can't be called in this mode") );
203 return wxRect(GetX(), GetY(), GetWidth(), GetHeight()).Contains(x
, y
);
206 int wxListItemData::GetX() const
208 wxCHECK_MSG( m_rect
, 0, wxT("can't be called in this mode") );
213 int wxListItemData::GetY() const
215 wxCHECK_MSG( m_rect
, 0, wxT("can't be called in this mode") );
220 int wxListItemData::GetWidth() const
222 wxCHECK_MSG( m_rect
, 0, wxT("can't be called in this mode") );
224 return m_rect
->width
;
227 int wxListItemData::GetHeight() const
229 wxCHECK_MSG( m_rect
, 0, wxT("can't be called in this mode") );
231 return m_rect
->height
;
234 void wxListItemData::GetItem( wxListItem
&info
) const
236 long mask
= info
.m_mask
;
238 // by default, get everything for backwards compatibility
241 if ( mask
& wxLIST_MASK_TEXT
)
242 info
.m_text
= m_text
;
243 if ( mask
& wxLIST_MASK_IMAGE
)
244 info
.m_image
= m_image
;
245 if ( mask
& wxLIST_MASK_DATA
)
246 info
.m_data
= m_data
;
250 if ( m_attr
->HasTextColour() )
251 info
.SetTextColour(m_attr
->GetTextColour());
252 if ( m_attr
->HasBackgroundColour() )
253 info
.SetBackgroundColour(m_attr
->GetBackgroundColour());
254 if ( m_attr
->HasFont() )
255 info
.SetFont(m_attr
->GetFont());
259 //-----------------------------------------------------------------------------
261 //-----------------------------------------------------------------------------
263 void wxListHeaderData::Init()
275 wxListHeaderData::wxListHeaderData()
280 wxListHeaderData::wxListHeaderData( const wxListItem
&item
)
287 void wxListHeaderData::SetItem( const wxListItem
&item
)
289 m_mask
= item
.m_mask
;
291 if ( m_mask
& wxLIST_MASK_TEXT
)
292 m_text
= item
.m_text
;
294 if ( m_mask
& wxLIST_MASK_IMAGE
)
295 m_image
= item
.m_image
;
297 if ( m_mask
& wxLIST_MASK_FORMAT
)
298 m_format
= item
.m_format
;
300 if ( m_mask
& wxLIST_MASK_WIDTH
)
301 SetWidth(item
.m_width
);
303 if ( m_mask
& wxLIST_MASK_STATE
)
304 SetState(item
.m_state
);
307 void wxListHeaderData::SetPosition( int x
, int y
)
313 void wxListHeaderData::SetHeight( int h
)
318 void wxListHeaderData::SetWidth( int w
)
320 m_width
= w
< 0 ? WIDTH_COL_DEFAULT
: w
;
323 void wxListHeaderData::SetState( int flag
)
328 void wxListHeaderData::SetFormat( int format
)
333 bool wxListHeaderData::HasImage() const
335 return m_image
!= -1;
338 bool wxListHeaderData::IsHit( int x
, int y
) const
340 return ((x
>= m_xpos
) && (x
<= m_xpos
+m_width
) && (y
>= m_ypos
) && (y
<= m_ypos
+m_height
));
343 void wxListHeaderData::GetItem( wxListItem
& item
)
345 item
.m_mask
= m_mask
;
346 item
.m_text
= m_text
;
347 item
.m_image
= m_image
;
348 item
.m_format
= m_format
;
349 item
.m_width
= m_width
;
350 item
.m_state
= m_state
;
353 int wxListHeaderData::GetImage() const
358 int wxListHeaderData::GetWidth() const
363 int wxListHeaderData::GetFormat() const
368 int wxListHeaderData::GetState() const
373 //-----------------------------------------------------------------------------
375 //-----------------------------------------------------------------------------
377 inline int wxListLineData::GetMode() const
379 return m_owner
->GetListCtrl()->GetWindowStyleFlag() & wxLC_MASK_TYPE
;
382 inline bool wxListLineData::InReportView() const
384 return m_owner
->HasFlag(wxLC_REPORT
);
387 inline bool wxListLineData::IsVirtual() const
389 return m_owner
->IsVirtual();
392 wxListLineData::wxListLineData( wxListMainWindow
*owner
)
396 if ( InReportView() )
399 m_gi
= new GeometryInfo
;
401 m_highlighted
= false;
403 InitItems( GetMode() == wxLC_REPORT
? m_owner
->GetColumnCount() : 1 );
406 void wxListLineData::CalculateSize( wxDC
*dc
, int spacing
)
408 wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
409 wxCHECK_RET( node
, wxT("no subitems at all??") );
411 wxListItemData
*item
= node
->GetData();
419 case wxLC_SMALL_ICON
:
420 m_gi
->m_rectAll
.width
= spacing
;
427 m_gi
->m_rectLabel
.width
=
428 m_gi
->m_rectLabel
.height
= 0;
432 dc
->GetTextExtent( s
, &lw
, &lh
);
436 m_gi
->m_rectAll
.height
= spacing
+ lh
;
438 m_gi
->m_rectAll
.width
= lw
;
440 m_gi
->m_rectLabel
.width
= lw
;
441 m_gi
->m_rectLabel
.height
= lh
;
444 if (item
->HasImage())
447 m_owner
->GetImageSize( item
->GetImage(), w
, h
);
448 m_gi
->m_rectIcon
.width
= w
+ 8;
449 m_gi
->m_rectIcon
.height
= h
+ 8;
451 if ( m_gi
->m_rectIcon
.width
> m_gi
->m_rectAll
.width
)
452 m_gi
->m_rectAll
.width
= m_gi
->m_rectIcon
.width
;
453 if ( m_gi
->m_rectIcon
.height
+ lh
> m_gi
->m_rectAll
.height
- 4 )
454 m_gi
->m_rectAll
.height
= m_gi
->m_rectIcon
.height
+ lh
+ 4;
457 if ( item
->HasText() )
459 m_gi
->m_rectHighlight
.width
= m_gi
->m_rectLabel
.width
;
460 m_gi
->m_rectHighlight
.height
= m_gi
->m_rectLabel
.height
;
462 else // no text, highlight the icon
464 m_gi
->m_rectHighlight
.width
= m_gi
->m_rectIcon
.width
;
465 m_gi
->m_rectHighlight
.height
= m_gi
->m_rectIcon
.height
;
470 s
= item
->GetTextForMeasuring();
472 dc
->GetTextExtent( s
, &lw
, &lh
);
476 m_gi
->m_rectLabel
.width
= lw
;
477 m_gi
->m_rectLabel
.height
= lh
;
479 m_gi
->m_rectAll
.width
= lw
;
480 m_gi
->m_rectAll
.height
= lh
;
482 if (item
->HasImage())
485 m_owner
->GetImageSize( item
->GetImage(), w
, h
);
486 m_gi
->m_rectIcon
.width
= w
;
487 m_gi
->m_rectIcon
.height
= h
;
489 m_gi
->m_rectAll
.width
+= 4 + w
;
490 if (h
> m_gi
->m_rectAll
.height
)
491 m_gi
->m_rectAll
.height
= h
;
494 m_gi
->m_rectHighlight
.width
= m_gi
->m_rectAll
.width
;
495 m_gi
->m_rectHighlight
.height
= m_gi
->m_rectAll
.height
;
499 wxFAIL_MSG( wxT("unexpected call to SetSize") );
503 wxFAIL_MSG( wxT("unknown mode") );
508 void wxListLineData::SetPosition( int x
, int y
, int spacing
)
510 wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
511 wxCHECK_RET( node
, wxT("no subitems at all??") );
513 wxListItemData
*item
= node
->GetData();
518 case wxLC_SMALL_ICON
:
519 m_gi
->m_rectAll
.x
= x
;
520 m_gi
->m_rectAll
.y
= y
;
522 if ( item
->HasImage() )
524 m_gi
->m_rectIcon
.x
= m_gi
->m_rectAll
.x
+ 4 +
525 (m_gi
->m_rectAll
.width
- m_gi
->m_rectIcon
.width
) / 2;
526 m_gi
->m_rectIcon
.y
= m_gi
->m_rectAll
.y
+ 4;
529 if ( item
->HasText() )
531 if (m_gi
->m_rectAll
.width
> spacing
)
532 m_gi
->m_rectLabel
.x
= m_gi
->m_rectAll
.x
+ (EXTRA_WIDTH
/2);
534 m_gi
->m_rectLabel
.x
= m_gi
->m_rectAll
.x
+ (EXTRA_WIDTH
/2) + (spacing
/ 2) - (m_gi
->m_rectLabel
.width
/ 2);
535 m_gi
->m_rectLabel
.y
= m_gi
->m_rectAll
.y
+ m_gi
->m_rectAll
.height
+ 2 - m_gi
->m_rectLabel
.height
;
536 m_gi
->m_rectHighlight
.x
= m_gi
->m_rectLabel
.x
- 2;
537 m_gi
->m_rectHighlight
.y
= m_gi
->m_rectLabel
.y
- 2;
539 else // no text, highlight the icon
541 m_gi
->m_rectHighlight
.x
= m_gi
->m_rectIcon
.x
- 4;
542 m_gi
->m_rectHighlight
.y
= m_gi
->m_rectIcon
.y
- 4;
547 m_gi
->m_rectAll
.x
= x
;
548 m_gi
->m_rectAll
.y
= y
;
550 m_gi
->m_rectHighlight
.x
= m_gi
->m_rectAll
.x
;
551 m_gi
->m_rectHighlight
.y
= m_gi
->m_rectAll
.y
;
552 m_gi
->m_rectLabel
.y
= m_gi
->m_rectAll
.y
+ 2;
554 if (item
->HasImage())
556 m_gi
->m_rectIcon
.x
= m_gi
->m_rectAll
.x
+ 2;
557 m_gi
->m_rectIcon
.y
= m_gi
->m_rectAll
.y
+ 2;
558 m_gi
->m_rectLabel
.x
= m_gi
->m_rectAll
.x
+ 4 + (EXTRA_WIDTH
/2) + m_gi
->m_rectIcon
.width
;
562 m_gi
->m_rectLabel
.x
= m_gi
->m_rectAll
.x
+ (EXTRA_WIDTH
/2);
567 wxFAIL_MSG( wxT("unexpected call to SetPosition") );
571 wxFAIL_MSG( wxT("unknown mode") );
576 void wxListLineData::InitItems( int num
)
578 for (int i
= 0; i
< num
; i
++)
579 m_items
.Append( new wxListItemData(m_owner
) );
582 void wxListLineData::SetItem( int index
, const wxListItem
&info
)
584 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
585 wxCHECK_RET( node
, wxT("invalid column index in SetItem") );
587 wxListItemData
*item
= node
->GetData();
588 item
->SetItem( info
);
591 void wxListLineData::GetItem( int index
, wxListItem
&info
)
593 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
596 wxListItemData
*item
= node
->GetData();
597 item
->GetItem( info
);
601 wxString
wxListLineData::GetText(int index
) const
605 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
608 wxListItemData
*item
= node
->GetData();
615 void wxListLineData::SetText( int index
, const wxString
& s
)
617 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
620 wxListItemData
*item
= node
->GetData();
625 void wxListLineData::SetImage( int index
, int image
)
627 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
628 wxCHECK_RET( node
, wxT("invalid column index in SetImage()") );
630 wxListItemData
*item
= node
->GetData();
631 item
->SetImage(image
);
634 int wxListLineData::GetImage( int index
) const
636 wxListItemDataList::compatibility_iterator node
= m_items
.Item( index
);
637 wxCHECK_MSG( node
, -1, wxT("invalid column index in GetImage()") );
639 wxListItemData
*item
= node
->GetData();
640 return item
->GetImage();
643 wxListItemAttr
*wxListLineData::GetAttr() const
645 wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
646 wxCHECK_MSG( node
, NULL
, wxT("invalid column index in GetAttr()") );
648 wxListItemData
*item
= node
->GetData();
649 return item
->GetAttr();
652 void wxListLineData::SetAttr(wxListItemAttr
*attr
)
654 wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
655 wxCHECK_RET( node
, wxT("invalid column index in SetAttr()") );
657 wxListItemData
*item
= node
->GetData();
661 void wxListLineData::ApplyAttributes(wxDC
*dc
,
662 const wxRect
& rectHL
,
666 const wxListItemAttr
* const attr
= GetAttr();
668 wxWindow
* const listctrl
= m_owner
->GetParent();
670 const bool hasFocus
= listctrl
->HasFocus()
671 #if defined(__WXMAC__) && !defined(__WXUNIVERSAL__) && wxOSX_USE_CARBON
672 && IsControlActive( (ControlRef
)listctrl
->GetHandle() )
678 // don't use foreground colour for drawing highlighted items - this might
679 // make them completely invisible (and there is no way to do bit
680 // arithmetics on wxColour, unfortunately)
691 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_HIGHLIGHTTEXT
);
693 colText
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOXHIGHLIGHTTEXT
);
696 else if ( attr
&& attr
->HasTextColour() )
697 colText
= attr
->GetTextColour();
699 colText
= listctrl
->GetForegroundColour();
701 dc
->SetTextForeground(colText
);
705 if ( attr
&& attr
->HasFont() )
706 font
= attr
->GetFont();
708 font
= listctrl
->GetFont();
715 // Use the renderer method to ensure that the selected items use the
717 int flags
= wxCONTROL_SELECTED
;
719 flags
|= wxCONTROL_FOCUSED
;
721 flags
|= wxCONTROL_CURRENT
;
722 wxRendererNative::Get().
723 DrawItemSelectionRect( m_owner
, *dc
, rectHL
, flags
);
725 else if ( attr
&& attr
->HasBackgroundColour() )
727 // Draw the background using the items custom background colour.
728 dc
->SetBrush(attr
->GetBackgroundColour());
729 dc
->SetPen(*wxTRANSPARENT_PEN
);
730 dc
->DrawRectangle(rectHL
);
733 // just for debugging to better see where the items are
735 dc
->SetPen(*wxRED_PEN
);
736 dc
->SetBrush(*wxTRANSPARENT_BRUSH
);
737 dc
->DrawRectangle( m_gi
->m_rectAll
);
738 dc
->SetPen(*wxGREEN_PEN
);
739 dc
->DrawRectangle( m_gi
->m_rectIcon
);
743 void wxListLineData::Draw(wxDC
*dc
, bool current
)
745 wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
746 wxCHECK_RET( node
, wxT("no subitems at all??") );
748 ApplyAttributes(dc
, m_gi
->m_rectHighlight
, IsHighlighted(), current
);
750 wxListItemData
*item
= node
->GetData();
751 if (item
->HasImage())
753 // centre the image inside our rectangle, this looks nicer when items
754 // ae aligned in a row
755 const wxRect
& rectIcon
= m_gi
->m_rectIcon
;
757 m_owner
->DrawImage(item
->GetImage(), dc
, rectIcon
.x
, rectIcon
.y
);
762 const wxRect
& rectLabel
= m_gi
->m_rectLabel
;
764 wxDCClipper
clipper(*dc
, rectLabel
);
765 dc
->DrawText(item
->GetText(), rectLabel
.x
, rectLabel
.y
);
769 void wxListLineData::DrawInReportMode( wxDC
*dc
,
771 const wxRect
& rectHL
,
775 // TODO: later we should support setting different attributes for
776 // different columns - to do it, just add "col" argument to
777 // GetAttr() and move these lines into the loop below
779 ApplyAttributes(dc
, rectHL
, highlighted
, current
);
781 wxCoord x
= rect
.x
+ HEADER_OFFSET_X
,
782 yMid
= rect
.y
+ rect
.height
/2;
784 // This probably needs to be done
785 // on all platforms as the icons
786 // otherwise nearly touch the border
791 for ( wxListItemDataList::compatibility_iterator node
= m_items
.GetFirst();
793 node
= node
->GetNext(), col
++ )
795 wxListItemData
*item
= node
->GetData();
797 int width
= m_owner
->GetColumnWidth(col
);
802 const int wText
= width
;
803 wxDCClipper
clipper(*dc
, xOld
, rect
.y
, wText
, rect
.height
);
805 if ( item
->HasImage() )
808 m_owner
->GetImageSize( item
->GetImage(), ix
, iy
);
809 m_owner
->DrawImage( item
->GetImage(), dc
, xOld
, yMid
- iy
/2 );
811 ix
+= IMAGE_MARGIN_IN_REPORT_MODE
;
817 if ( item
->HasText() )
818 DrawTextFormatted(dc
, item
->GetText(), col
, xOld
, yMid
, width
);
822 void wxListLineData::DrawTextFormatted(wxDC
*dc
,
823 const wxString
& textOrig
,
829 // we don't support displaying multiple lines currently (and neither does
830 // wxMSW FWIW) so just merge all the lines
831 wxString
text(textOrig
);
832 text
.Replace(wxT("\n"), wxT(" "));
835 dc
->GetTextExtent(text
, &w
, &h
);
837 const wxCoord y
= yMid
- (h
+ 1)/2;
839 wxDCClipper
clipper(*dc
, x
, y
, width
, h
);
841 // determine if the string can fit inside the current width
844 // it can, draw it using the items alignment
846 m_owner
->GetColumn(col
, item
);
847 switch ( item
.GetAlign() )
849 case wxLIST_FORMAT_LEFT
:
853 case wxLIST_FORMAT_RIGHT
:
857 case wxLIST_FORMAT_CENTER
:
858 x
+= (width
- w
) / 2;
862 wxFAIL_MSG( wxT("unknown list item format") );
866 dc
->DrawText(text
, x
, y
);
868 else // otherwise, truncate and add an ellipsis if possible
870 // determine the base width
871 wxString
ellipsis(wxT("..."));
873 dc
->GetTextExtent(ellipsis
, &base_w
, &h
);
875 // continue until we have enough space or only one character left
877 size_t len
= text
.length();
878 wxString drawntext
= text
.Left(len
);
881 dc
->GetTextExtent(drawntext
.Last(), &w_c
, &h_c
);
882 drawntext
.RemoveLast();
885 if (w
+ base_w
<= width
)
889 // if still not enough space, remove ellipsis characters
890 while (ellipsis
.length() > 0 && w
+ base_w
> width
)
892 ellipsis
= ellipsis
.Left(ellipsis
.length() - 1);
893 dc
->GetTextExtent(ellipsis
, &base_w
, &h
);
897 dc
->DrawText(drawntext
, x
, y
);
898 dc
->DrawText(ellipsis
, x
+ w
, y
);
902 bool wxListLineData::Highlight( bool on
)
904 wxCHECK_MSG( !IsVirtual(), false, wxT("unexpected call to Highlight") );
906 if ( on
== m_highlighted
)
914 void wxListLineData::ReverseHighlight( void )
916 Highlight(!IsHighlighted());
919 //-----------------------------------------------------------------------------
920 // wxListHeaderWindow
921 //-----------------------------------------------------------------------------
923 BEGIN_EVENT_TABLE(wxListHeaderWindow
,wxWindow
)
924 EVT_PAINT (wxListHeaderWindow::OnPaint
)
925 EVT_MOUSE_EVENTS (wxListHeaderWindow::OnMouse
)
926 EVT_SET_FOCUS (wxListHeaderWindow::OnSetFocus
)
929 void wxListHeaderWindow::Init()
931 m_currentCursor
= NULL
;
932 m_isDragging
= false;
934 m_sendSetColumnWidth
= false;
937 wxListHeaderWindow::wxListHeaderWindow()
942 m_resizeCursor
= NULL
;
945 wxListHeaderWindow::wxListHeaderWindow( wxWindow
*win
,
947 wxListMainWindow
*owner
,
951 const wxString
&name
)
952 : wxWindow( win
, id
, pos
, size
, style
, name
)
957 m_resizeCursor
= new wxCursor( wxCURSOR_SIZEWE
);
960 wxVisualAttributes attr
= wxPanel::GetClassDefaultAttributes();
961 SetOwnForegroundColour( attr
.colFg
);
962 SetOwnBackgroundColour( attr
.colBg
);
964 SetOwnFont( attr
.font
);
966 SetOwnForegroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_WINDOWTEXT
));
967 SetOwnBackgroundColour( wxSystemSettings::GetColour(wxSYS_COLOUR_BTNFACE
));
969 SetOwnFont( wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
));
973 wxListHeaderWindow::~wxListHeaderWindow()
975 delete m_resizeCursor
;
978 #ifdef __WXUNIVERSAL__
979 #include "wx/univ/renderer.h"
980 #include "wx/univ/theme.h"
983 // shift the DC origin to match the position of the main window horz
984 // scrollbar: this allows us to always use logical coords
985 void wxListHeaderWindow::AdjustDC(wxDC
& dc
)
987 wxGenericListCtrl
*parent
= m_owner
->GetListCtrl();
990 parent
->GetScrollPixelsPerUnit( &xpix
, NULL
);
993 parent
->GetViewStart( &view_start
, NULL
);
998 dc
.GetDeviceOrigin( &org_x
, &org_y
);
1000 // account for the horz scrollbar offset
1002 if (GetLayoutDirection() == wxLayout_RightToLeft
)
1004 // Maybe we just have to check for m_signX
1005 // in the DC, but I leave the #ifdef __WXGTK__
1007 dc
.SetDeviceOrigin( org_x
+ (view_start
* xpix
), org_y
);
1011 dc
.SetDeviceOrigin( org_x
- (view_start
* xpix
), org_y
);
1014 void wxListHeaderWindow::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
1016 wxGenericListCtrl
*parent
= m_owner
->GetListCtrl();
1018 wxPaintDC
dc( this );
1022 dc
.SetFont( GetFont() );
1024 // width and height of the entire header window
1026 GetClientSize( &w
, &h
);
1027 parent
->CalcUnscrolledPosition(w
, 0, &w
, NULL
);
1029 dc
.SetBackgroundMode(wxBRUSHSTYLE_TRANSPARENT
);
1030 dc
.SetTextForeground(GetForegroundColour());
1032 int x
= HEADER_OFFSET_X
;
1033 int numColumns
= m_owner
->GetColumnCount();
1035 for ( int i
= 0; i
< numColumns
&& x
< w
; i
++ )
1037 m_owner
->GetColumn( i
, item
);
1038 int wCol
= item
.m_width
;
1044 if (!m_parent
->IsEnabled())
1045 flags
|= wxCONTROL_DISABLED
;
1047 // NB: The code below is not really Mac-specific, but since we are close
1048 // to 2.8 release and I don't have time to test on other platforms, I
1049 // defined this only for wxMac. If this behaviour is desired on
1050 // other platforms, please go ahead and revise or remove the #ifdef.
1052 if ( !m_owner
->IsVirtual() && (item
.m_mask
& wxLIST_MASK_STATE
) &&
1053 (item
.m_state
& wxLIST_STATE_SELECTED
) )
1054 flags
|= wxCONTROL_SELECTED
;
1058 flags
|= wxCONTROL_SPECIAL
; // mark as first column
1060 wxRendererNative::Get().DrawHeaderButton
1064 wxRect(x
, HEADER_OFFSET_Y
, cw
, ch
),
1068 // see if we have enough space for the column label
1070 // for this we need the width of the text
1073 dc
.GetTextExtent(item
.GetText(), &wLabel
, &hLabel
);
1074 wLabel
+= 2 * EXTRA_WIDTH
;
1076 // and the width of the icon, if any
1077 int ix
= 0, iy
= 0; // init them just to suppress the compiler warnings
1078 const int image
= item
.m_image
;
1079 wxImageList
*imageList
;
1082 imageList
= m_owner
->GetSmallImageList();
1085 imageList
->GetSize(image
, ix
, iy
);
1086 wLabel
+= ix
+ HEADER_IMAGE_MARGIN_IN_REPORT_MODE
;
1094 // ignore alignment if there is not enough space anyhow
1096 switch ( wLabel
< cw
? item
.GetAlign() : wxLIST_FORMAT_LEFT
)
1099 wxFAIL_MSG( wxT("unknown list item format") );
1102 case wxLIST_FORMAT_LEFT
:
1106 case wxLIST_FORMAT_RIGHT
:
1107 xAligned
= x
+ cw
- wLabel
;
1110 case wxLIST_FORMAT_CENTER
:
1111 xAligned
= x
+ (cw
- wLabel
) / 2;
1115 // draw the text and image clipping them so that they
1116 // don't overwrite the column boundary
1117 wxDCClipper
clipper(dc
, x
, HEADER_OFFSET_Y
, cw
, h
);
1119 // if we have an image, draw it on the right of the label
1126 xAligned
+ wLabel
- ix
- HEADER_IMAGE_MARGIN_IN_REPORT_MODE
,
1127 HEADER_OFFSET_Y
+ (h
- iy
)/2,
1128 wxIMAGELIST_DRAW_TRANSPARENT
1132 dc
.DrawText( item
.GetText(),
1133 xAligned
+ EXTRA_WIDTH
, (h
- hLabel
) / 2 );
1138 // Fill in what's missing to the right of the columns, otherwise we will
1139 // leave an unpainted area when columns are removed (and it looks better)
1142 wxRendererNative::Get().DrawHeaderButton
1146 wxRect(x
, HEADER_OFFSET_Y
, w
- x
, h
),
1147 wxCONTROL_DIRTY
// mark as last column
1152 void wxListHeaderWindow::OnInternalIdle()
1154 wxWindow::OnInternalIdle();
1156 if (m_sendSetColumnWidth
)
1158 m_owner
->SetColumnWidth( m_colToSend
, m_widthToSend
);
1159 m_sendSetColumnWidth
= false;
1163 void wxListHeaderWindow::DrawCurrent()
1166 // m_owner->SetColumnWidth( m_column, m_currentX - m_minX );
1167 m_sendSetColumnWidth
= true;
1168 m_colToSend
= m_column
;
1169 m_widthToSend
= m_currentX
- m_minX
;
1171 int x1
= m_currentX
;
1173 m_owner
->ClientToScreen( &x1
, &y1
);
1175 int x2
= m_currentX
;
1177 m_owner
->GetClientSize( NULL
, &y2
);
1178 m_owner
->ClientToScreen( &x2
, &y2
);
1181 dc
.SetLogicalFunction( wxINVERT
);
1182 dc
.SetPen( wxPen(*wxBLACK
, 2) );
1183 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
1187 dc
.DrawLine( x1
, y1
, x2
, y2
);
1189 dc
.SetLogicalFunction( wxCOPY
);
1191 dc
.SetPen( wxNullPen
);
1192 dc
.SetBrush( wxNullBrush
);
1196 void wxListHeaderWindow::OnMouse( wxMouseEvent
&event
)
1198 wxGenericListCtrl
*parent
= m_owner
->GetListCtrl();
1200 // we want to work with logical coords
1202 parent
->CalcUnscrolledPosition(event
.GetX(), 0, &x
, NULL
);
1203 int y
= event
.GetY();
1207 SendListEvent(wxEVT_COMMAND_LIST_COL_DRAGGING
, event
.GetPosition());
1209 // we don't draw the line beyond our window, but we allow dragging it
1212 GetClientSize( &w
, NULL
);
1213 parent
->CalcUnscrolledPosition(w
, 0, &w
, NULL
);
1216 // erase the line if it was drawn
1217 if ( m_currentX
< w
)
1220 if (event
.ButtonUp())
1223 m_isDragging
= false;
1225 m_owner
->SetColumnWidth( m_column
, m_currentX
- m_minX
);
1226 SendListEvent(wxEVT_COMMAND_LIST_COL_END_DRAG
, event
.GetPosition());
1233 m_currentX
= m_minX
+ 7;
1235 // draw in the new location
1236 if ( m_currentX
< w
)
1240 else // not dragging
1243 bool hit_border
= false;
1245 // end of the current column
1248 // find the column where this event occurred
1250 countCol
= m_owner
->GetColumnCount();
1251 for (col
= 0; col
< countCol
; col
++)
1253 xpos
+= m_owner
->GetColumnWidth( col
);
1256 if ( (abs(x
-xpos
) < 3) && (y
< 22) )
1258 // near the column border
1265 // inside the column
1272 if ( col
== countCol
)
1275 if (event
.LeftDown() || event
.RightUp())
1277 if (hit_border
&& event
.LeftDown())
1279 if ( SendListEvent(wxEVT_COMMAND_LIST_COL_BEGIN_DRAG
,
1280 event
.GetPosition()) )
1282 m_isDragging
= true;
1287 //else: column resizing was vetoed by the user code
1289 else // click on a column
1291 // record the selected state of the columns
1292 if (event
.LeftDown())
1294 for (int i
=0; i
< m_owner
->GetColumnCount(); i
++)
1297 m_owner
->GetColumn(i
, colItem
);
1298 long state
= colItem
.GetState();
1300 colItem
.SetState(state
| wxLIST_STATE_SELECTED
);
1302 colItem
.SetState(state
& ~wxLIST_STATE_SELECTED
);
1303 m_owner
->SetColumn(i
, colItem
);
1307 SendListEvent( event
.LeftDown()
1308 ? wxEVT_COMMAND_LIST_COL_CLICK
1309 : wxEVT_COMMAND_LIST_COL_RIGHT_CLICK
,
1310 event
.GetPosition());
1313 else if (event
.Moving())
1318 setCursor
= m_currentCursor
== wxSTANDARD_CURSOR
;
1319 m_currentCursor
= m_resizeCursor
;
1323 setCursor
= m_currentCursor
!= wxSTANDARD_CURSOR
;
1324 m_currentCursor
= wxSTANDARD_CURSOR
;
1328 SetCursor(*m_currentCursor
);
1333 void wxListHeaderWindow::OnSetFocus( wxFocusEvent
&WXUNUSED(event
) )
1335 m_owner
->SetFocus();
1339 bool wxListHeaderWindow::SendListEvent(wxEventType type
, const wxPoint
& pos
)
1341 wxWindow
*parent
= GetParent();
1342 wxListEvent
le( type
, parent
->GetId() );
1343 le
.SetEventObject( parent
);
1344 le
.m_pointDrag
= pos
;
1346 // the position should be relative to the parent window, not
1347 // this one for compatibility with MSW and common sense: the
1348 // user code doesn't know anything at all about this header
1349 // window, so why should it get positions relative to it?
1350 le
.m_pointDrag
.y
-= GetSize().y
;
1352 le
.m_col
= m_column
;
1353 return !parent
->GetEventHandler()->ProcessEvent( le
) || le
.IsAllowed();
1356 //-----------------------------------------------------------------------------
1357 // wxListRenameTimer (internal)
1358 //-----------------------------------------------------------------------------
1360 wxListRenameTimer::wxListRenameTimer( wxListMainWindow
*owner
)
1365 void wxListRenameTimer::Notify()
1367 m_owner
->OnRenameTimer();
1370 //-----------------------------------------------------------------------------
1371 // wxListTextCtrlWrapper (internal)
1372 //-----------------------------------------------------------------------------
1374 BEGIN_EVENT_TABLE(wxListTextCtrlWrapper
, wxEvtHandler
)
1375 EVT_CHAR (wxListTextCtrlWrapper::OnChar
)
1376 EVT_KEY_UP (wxListTextCtrlWrapper::OnKeyUp
)
1377 EVT_KILL_FOCUS (wxListTextCtrlWrapper::OnKillFocus
)
1380 wxListTextCtrlWrapper::wxListTextCtrlWrapper(wxListMainWindow
*owner
,
1383 : m_startValue(owner
->GetItemText(itemEdit
)),
1384 m_itemEdited(itemEdit
)
1388 m_aboutToFinish
= false;
1390 wxGenericListCtrl
*parent
= m_owner
->GetListCtrl();
1392 wxRect rectLabel
= owner
->GetLineLabelRect(itemEdit
);
1394 parent
->CalcScrolledPosition(rectLabel
.x
, rectLabel
.y
,
1395 &rectLabel
.x
, &rectLabel
.y
);
1397 m_text
->Create(owner
, wxID_ANY
, m_startValue
,
1398 wxPoint(rectLabel
.x
-4,rectLabel
.y
-4),
1399 wxSize(rectLabel
.width
+11,rectLabel
.height
+8));
1402 m_text
->PushEventHandler(this);
1405 void wxListTextCtrlWrapper::EndEdit(EndReason reason
)
1407 m_aboutToFinish
= true;
1412 // Notify the owner about the changes
1415 // Even if vetoed, close the control (consistent with MSW)
1420 m_owner
->OnRenameCancelled(m_itemEdited
);
1426 // Don't generate any notifications for the control being destroyed
1427 // and don't set focus to it neither.
1433 void wxListTextCtrlWrapper::Finish( bool setfocus
)
1435 m_text
->RemoveEventHandler(this);
1436 m_owner
->ResetTextControl( m_text
);
1438 wxPendingDelete
.Append( this );
1441 m_owner
->SetFocus();
1444 bool wxListTextCtrlWrapper::AcceptChanges()
1446 const wxString value
= m_text
->GetValue();
1448 // notice that we should always call OnRenameAccept() to generate the "end
1449 // label editing" event, even if the user hasn't really changed anything
1450 if ( !m_owner
->OnRenameAccept(m_itemEdited
, value
) )
1452 // vetoed by the user
1456 // accepted, do rename the item (unless nothing changed)
1457 if ( value
!= m_startValue
)
1458 m_owner
->SetItemText(m_itemEdited
, value
);
1463 void wxListTextCtrlWrapper::OnChar( wxKeyEvent
&event
)
1465 if ( !CheckForEndEditKey(event
) )
1469 bool wxListTextCtrlWrapper::CheckForEndEditKey(const wxKeyEvent
& event
)
1471 switch ( event
.m_keyCode
)
1474 EndEdit( End_Accept
);
1478 EndEdit( End_Discard
);
1488 void wxListTextCtrlWrapper::OnKeyUp( wxKeyEvent
&event
)
1490 if (m_aboutToFinish
)
1492 // auto-grow the textctrl:
1493 wxSize parentSize
= m_owner
->GetSize();
1494 wxPoint myPos
= m_text
->GetPosition();
1495 wxSize mySize
= m_text
->GetSize();
1497 m_text
->GetTextExtent(m_text
->GetValue() + wxT("MM"), &sx
, &sy
);
1498 if (myPos
.x
+ sx
> parentSize
.x
)
1499 sx
= parentSize
.x
- myPos
.x
;
1502 m_text
->SetSize(sx
, wxDefaultCoord
);
1508 void wxListTextCtrlWrapper::OnKillFocus( wxFocusEvent
&event
)
1510 if ( !m_aboutToFinish
)
1512 if ( !AcceptChanges() )
1513 m_owner
->OnRenameCancelled( m_itemEdited
);
1518 // We must let the native text control handle focus
1522 //-----------------------------------------------------------------------------
1524 //-----------------------------------------------------------------------------
1526 BEGIN_EVENT_TABLE(wxListMainWindow
, wxWindow
)
1527 EVT_PAINT (wxListMainWindow::OnPaint
)
1528 EVT_MOUSE_EVENTS (wxListMainWindow::OnMouse
)
1529 EVT_CHAR_HOOK (wxListMainWindow::OnCharHook
)
1530 EVT_CHAR (wxListMainWindow::OnChar
)
1531 EVT_KEY_DOWN (wxListMainWindow::OnKeyDown
)
1532 EVT_KEY_UP (wxListMainWindow::OnKeyUp
)
1533 EVT_SET_FOCUS (wxListMainWindow::OnSetFocus
)
1534 EVT_KILL_FOCUS (wxListMainWindow::OnKillFocus
)
1535 EVT_SCROLLWIN (wxListMainWindow::OnScroll
)
1536 EVT_CHILD_FOCUS (wxListMainWindow::OnChildFocus
)
1539 void wxListMainWindow::Init()
1544 m_lineTo
= (size_t)-1;
1550 m_small_image_list
= NULL
;
1551 m_normal_image_list
= NULL
;
1553 m_small_spacing
= 30;
1554 m_normal_spacing
= 40;
1558 m_isCreated
= false;
1560 m_lastOnSame
= false;
1561 m_renameTimer
= new wxListRenameTimer( this );
1562 m_textctrlWrapper
= NULL
;
1566 m_lineSelectSingleOnUp
=
1567 m_lineBeforeLastClicked
= (size_t)-1;
1570 wxListMainWindow::wxListMainWindow()
1575 m_highlightUnfocusedBrush
= NULL
;
1578 wxListMainWindow::wxListMainWindow( wxWindow
*parent
,
1583 const wxString
&name
)
1584 : wxWindow( parent
, id
, pos
, size
, style
, name
)
1588 m_highlightBrush
= new wxBrush
1590 wxSystemSettings::GetColour
1592 wxSYS_COLOUR_HIGHLIGHT
1597 m_highlightUnfocusedBrush
= new wxBrush
1599 wxSystemSettings::GetColour
1601 wxSYS_COLOUR_BTNSHADOW
1606 wxVisualAttributes attr
= wxGenericListCtrl::GetClassDefaultAttributes();
1607 SetOwnForegroundColour( attr
.colFg
);
1608 SetOwnBackgroundColour( attr
.colBg
);
1610 SetOwnFont( attr
.font
);
1613 wxListMainWindow::~wxListMainWindow()
1615 if ( m_textctrlWrapper
)
1616 m_textctrlWrapper
->EndEdit(wxListTextCtrlWrapper::End_Destroy
);
1619 WX_CLEAR_LIST(wxListHeaderDataList
, m_columns
);
1620 WX_CLEAR_ARRAY(m_aColWidths
);
1622 delete m_highlightBrush
;
1623 delete m_highlightUnfocusedBrush
;
1624 delete m_renameTimer
;
1627 void wxListMainWindow::SetReportView(bool inReportView
)
1629 const size_t count
= m_lines
.size();
1630 for ( size_t n
= 0; n
< count
; n
++ )
1632 m_lines
[n
].SetReportView(inReportView
);
1636 void wxListMainWindow::CacheLineData(size_t line
)
1638 wxGenericListCtrl
*listctrl
= GetListCtrl();
1640 wxListLineData
*ld
= GetDummyLine();
1642 size_t countCol
= GetColumnCount();
1643 for ( size_t col
= 0; col
< countCol
; col
++ )
1645 ld
->SetText(col
, listctrl
->OnGetItemText(line
, col
));
1646 ld
->SetImage(col
, listctrl
->OnGetItemColumnImage(line
, col
));
1649 ld
->SetAttr(listctrl
->OnGetItemAttr(line
));
1652 wxListLineData
*wxListMainWindow::GetDummyLine() const
1654 wxASSERT_MSG( !IsEmpty(), wxT("invalid line index") );
1655 wxASSERT_MSG( IsVirtual(), wxT("GetDummyLine() shouldn't be called") );
1657 wxListMainWindow
*self
= wxConstCast(this, wxListMainWindow
);
1659 // we need to recreate the dummy line if the number of columns in the
1660 // control changed as it would have the incorrect number of fields
1662 if ( !m_lines
.IsEmpty() &&
1663 m_lines
[0].m_items
.GetCount() != (size_t)GetColumnCount() )
1665 self
->m_lines
.Clear();
1668 if ( m_lines
.IsEmpty() )
1670 wxListLineData
*line
= new wxListLineData(self
);
1671 self
->m_lines
.Add(line
);
1673 // don't waste extra memory -- there never going to be anything
1674 // else/more in this array
1675 self
->m_lines
.Shrink();
1681 // ----------------------------------------------------------------------------
1682 // line geometry (report mode only)
1683 // ----------------------------------------------------------------------------
1685 wxCoord
wxListMainWindow::GetLineHeight() const
1687 // we cache the line height as calling GetTextExtent() is slow
1688 if ( !m_lineHeight
)
1690 wxListMainWindow
*self
= wxConstCast(this, wxListMainWindow
);
1692 wxClientDC
dc( self
);
1693 dc
.SetFont( GetFont() );
1696 dc
.GetTextExtent(wxT("H"), NULL
, &y
);
1698 if ( m_small_image_list
&& m_small_image_list
->GetImageCount() )
1701 m_small_image_list
->GetSize(0, iw
, ih
);
1706 self
->m_lineHeight
= y
+ LINE_SPACING
;
1709 return m_lineHeight
;
1712 wxCoord
wxListMainWindow::GetLineY(size_t line
) const
1714 wxASSERT_MSG( InReportView(), wxT("only works in report mode") );
1716 return LINE_SPACING
+ line
* GetLineHeight();
1719 wxRect
wxListMainWindow::GetLineRect(size_t line
) const
1721 if ( !InReportView() )
1722 return GetLine(line
)->m_gi
->m_rectAll
;
1725 rect
.x
= HEADER_OFFSET_X
;
1726 rect
.y
= GetLineY(line
);
1727 rect
.width
= GetHeaderWidth();
1728 rect
.height
= GetLineHeight();
1733 wxRect
wxListMainWindow::GetLineLabelRect(size_t line
) const
1735 if ( !InReportView() )
1736 return GetLine(line
)->m_gi
->m_rectLabel
;
1739 wxListLineData
*data
= GetLine(line
);
1740 wxListItemDataList::compatibility_iterator node
= data
->m_items
.GetFirst();
1743 wxListItemData
*item
= node
->GetData();
1744 if ( item
->HasImage() )
1747 GetImageSize( item
->GetImage(), ix
, iy
);
1748 image_x
= 3 + ix
+ IMAGE_MARGIN_IN_REPORT_MODE
;
1753 rect
.x
= image_x
+ HEADER_OFFSET_X
;
1754 rect
.y
= GetLineY(line
);
1755 rect
.width
= GetColumnWidth(0) - image_x
;
1756 rect
.height
= GetLineHeight();
1761 wxRect
wxListMainWindow::GetLineIconRect(size_t line
) const
1763 if ( !InReportView() )
1764 return GetLine(line
)->m_gi
->m_rectIcon
;
1766 wxListLineData
*ld
= GetLine(line
);
1767 wxASSERT_MSG( ld
->HasImage(), wxT("should have an image") );
1770 rect
.x
= HEADER_OFFSET_X
;
1771 rect
.y
= GetLineY(line
);
1772 GetImageSize(ld
->GetImage(), rect
.width
, rect
.height
);
1777 wxRect
wxListMainWindow::GetLineHighlightRect(size_t line
) const
1779 return InReportView() ? GetLineRect(line
)
1780 : GetLine(line
)->m_gi
->m_rectHighlight
;
1783 long wxListMainWindow::HitTestLine(size_t line
, int x
, int y
) const
1785 wxASSERT_MSG( line
< GetItemCount(), wxT("invalid line in HitTestLine") );
1787 wxListLineData
*ld
= GetLine(line
);
1789 if ( ld
->HasImage() && GetLineIconRect(line
).Contains(x
, y
) )
1790 return wxLIST_HITTEST_ONITEMICON
;
1792 // VS: Testing for "ld->HasText() || InReportView()" instead of
1793 // "ld->HasText()" is needed to make empty lines in report view
1795 if ( ld
->HasText() || InReportView() )
1797 wxRect rect
= InReportView() ? GetLineRect(line
)
1798 : GetLineLabelRect(line
);
1800 if ( rect
.Contains(x
, y
) )
1801 return wxLIST_HITTEST_ONITEMLABEL
;
1807 // ----------------------------------------------------------------------------
1808 // highlight (selection) handling
1809 // ----------------------------------------------------------------------------
1811 bool wxListMainWindow::IsHighlighted(size_t line
) const
1815 return m_selStore
.IsSelected(line
);
1819 wxListLineData
*ld
= GetLine(line
);
1820 wxCHECK_MSG( ld
, false, wxT("invalid index in IsHighlighted") );
1822 return ld
->IsHighlighted();
1826 void wxListMainWindow::HighlightLines( size_t lineFrom
,
1832 wxArrayInt linesChanged
;
1833 if ( !m_selStore
.SelectRange(lineFrom
, lineTo
, highlight
,
1836 // meny items changed state, refresh everything
1837 RefreshLines(lineFrom
, lineTo
);
1839 else // only a few items changed state, refresh only them
1841 size_t count
= linesChanged
.GetCount();
1842 for ( size_t n
= 0; n
< count
; n
++ )
1844 RefreshLine(linesChanged
[n
]);
1848 else // iterate over all items in non report view
1850 for ( size_t line
= lineFrom
; line
<= lineTo
; line
++ )
1852 if ( HighlightLine(line
, highlight
) )
1858 bool wxListMainWindow::HighlightLine( size_t line
, bool highlight
)
1864 changed
= m_selStore
.SelectItem(line
, highlight
);
1868 wxListLineData
*ld
= GetLine(line
);
1869 wxCHECK_MSG( ld
, false, wxT("invalid index in HighlightLine") );
1871 changed
= ld
->Highlight(highlight
);
1876 SendNotify( line
, highlight
? wxEVT_COMMAND_LIST_ITEM_SELECTED
1877 : wxEVT_COMMAND_LIST_ITEM_DESELECTED
);
1883 void wxListMainWindow::RefreshLine( size_t line
)
1885 if ( InReportView() )
1887 size_t visibleFrom
, visibleTo
;
1888 GetVisibleLinesRange(&visibleFrom
, &visibleTo
);
1890 if ( line
< visibleFrom
|| line
> visibleTo
)
1894 wxRect rect
= GetLineRect(line
);
1896 GetListCtrl()->CalcScrolledPosition( rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
1897 RefreshRect( rect
);
1900 void wxListMainWindow::RefreshLines( size_t lineFrom
, size_t lineTo
)
1902 // we suppose that they are ordered by caller
1903 wxASSERT_MSG( lineFrom
<= lineTo
, wxT("indices in disorder") );
1905 wxASSERT_MSG( lineTo
< GetItemCount(), wxT("invalid line range") );
1907 if ( InReportView() )
1909 size_t visibleFrom
, visibleTo
;
1910 GetVisibleLinesRange(&visibleFrom
, &visibleTo
);
1912 if ( lineFrom
< visibleFrom
)
1913 lineFrom
= visibleFrom
;
1914 if ( lineTo
> visibleTo
)
1919 rect
.y
= GetLineY(lineFrom
);
1920 rect
.width
= GetClientSize().x
;
1921 rect
.height
= GetLineY(lineTo
) - rect
.y
+ GetLineHeight();
1923 GetListCtrl()->CalcScrolledPosition( rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
1924 RefreshRect( rect
);
1928 // TODO: this should be optimized...
1929 for ( size_t line
= lineFrom
; line
<= lineTo
; line
++ )
1936 void wxListMainWindow::RefreshAfter( size_t lineFrom
)
1938 if ( InReportView() )
1940 size_t visibleFrom
, visibleTo
;
1941 GetVisibleLinesRange(&visibleFrom
, &visibleTo
);
1943 if ( lineFrom
< visibleFrom
)
1944 lineFrom
= visibleFrom
;
1945 else if ( lineFrom
> visibleTo
)
1950 rect
.y
= GetLineY(lineFrom
);
1951 GetListCtrl()->CalcScrolledPosition( rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
1953 wxSize size
= GetClientSize();
1954 rect
.width
= size
.x
;
1956 // refresh till the bottom of the window
1957 rect
.height
= size
.y
- rect
.y
;
1959 RefreshRect( rect
);
1963 // TODO: how to do it more efficiently?
1968 void wxListMainWindow::RefreshSelected()
1974 if ( InReportView() )
1976 GetVisibleLinesRange(&from
, &to
);
1981 to
= GetItemCount() - 1;
1984 if ( HasCurrent() && m_current
>= from
&& m_current
<= to
)
1985 RefreshLine(m_current
);
1987 for ( size_t line
= from
; line
<= to
; line
++ )
1989 // NB: the test works as expected even if m_current == -1
1990 if ( line
!= m_current
&& IsHighlighted(line
) )
1995 void wxListMainWindow::OnPaint( wxPaintEvent
&WXUNUSED(event
) )
1997 // Note: a wxPaintDC must be constructed even if no drawing is
1998 // done (a Windows requirement).
1999 wxPaintDC
dc( this );
2003 // nothing to draw or not the moment to draw it
2008 RecalculatePositions( false );
2010 GetListCtrl()->PrepareDC( dc
);
2013 GetListCtrl()->CalcScrolledPosition( 0, 0, &dev_x
, &dev_y
);
2015 dc
.SetFont( GetFont() );
2017 if ( InReportView() )
2019 int lineHeight
= GetLineHeight();
2021 size_t visibleFrom
, visibleTo
;
2022 GetVisibleLinesRange(&visibleFrom
, &visibleTo
);
2025 int xOrig
= dc
.LogicalToDeviceX( 0 );
2026 int yOrig
= dc
.LogicalToDeviceY( 0 );
2028 // tell the caller cache to cache the data
2031 wxListEvent
evCache(wxEVT_COMMAND_LIST_CACHE_HINT
,
2032 GetParent()->GetId());
2033 evCache
.SetEventObject( GetParent() );
2034 evCache
.m_oldItemIndex
= visibleFrom
;
2035 evCache
.m_item
.m_itemId
=
2036 evCache
.m_itemIndex
= visibleTo
;
2037 GetParent()->GetEventHandler()->ProcessEvent( evCache
);
2040 for ( size_t line
= visibleFrom
; line
<= visibleTo
; line
++ )
2042 rectLine
= GetLineRect(line
);
2045 if ( !IsExposed(rectLine
.x
+ xOrig
, rectLine
.y
+ yOrig
,
2046 rectLine
.width
, rectLine
.height
) )
2048 // don't redraw unaffected lines to avoid flicker
2052 GetLine(line
)->DrawInReportMode( &dc
,
2054 GetLineHighlightRect(line
),
2055 IsHighlighted(line
),
2056 line
== m_current
);
2059 if ( HasFlag(wxLC_HRULES
) )
2061 wxPen
pen(GetRuleColour(), 1, wxPENSTYLE_SOLID
);
2062 wxSize clientSize
= GetClientSize();
2064 size_t i
= visibleFrom
;
2065 if (i
== 0) i
= 1; // Don't draw the first one
2066 for ( ; i
<= visibleTo
; i
++ )
2069 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
2070 dc
.DrawLine(0 - dev_x
, i
* lineHeight
,
2071 clientSize
.x
- dev_x
, i
* lineHeight
);
2074 // Draw last horizontal rule
2075 if ( visibleTo
== GetItemCount() - 1 )
2078 dc
.SetBrush( *wxTRANSPARENT_BRUSH
);
2079 dc
.DrawLine(0 - dev_x
, (m_lineTo
+ 1) * lineHeight
,
2080 clientSize
.x
- dev_x
, (m_lineTo
+ 1) * lineHeight
);
2084 // Draw vertical rules if required
2085 if ( HasFlag(wxLC_VRULES
) && !IsEmpty() )
2087 wxPen
pen(GetRuleColour(), 1, wxPENSTYLE_SOLID
);
2088 wxRect firstItemRect
, lastItemRect
;
2090 GetItemRect(visibleFrom
, firstItemRect
);
2091 GetItemRect(visibleTo
, lastItemRect
);
2092 int x
= firstItemRect
.GetX();
2094 dc
.SetBrush(* wxTRANSPARENT_BRUSH
);
2096 for (int col
= 0; col
< GetColumnCount(); col
++)
2098 int colWidth
= GetColumnWidth(col
);
2100 int x_pos
= x
- dev_x
;
2101 if (col
< GetColumnCount()-1) x_pos
-= 2;
2102 dc
.DrawLine(x_pos
, firstItemRect
.GetY() - 1 - dev_y
,
2103 x_pos
, lastItemRect
.GetBottom() + 1 - dev_y
);
2109 size_t count
= GetItemCount();
2110 for ( size_t i
= 0; i
< count
; i
++ )
2112 GetLine(i
)->Draw( &dc
, i
== m_current
);
2116 // DrawFocusRect() is unusable under Mac, it draws outside of the highlight
2117 // rectangle somehow and so leaves traces when the item is not selected any
2118 // more, see #12229.
2123 if ( IsHighlighted(m_current
) )
2124 flags
|= wxCONTROL_SELECTED
;
2126 wxRendererNative::Get().
2127 DrawFocusRect(this, dc
, GetLineHighlightRect(m_current
), flags
);
2129 #endif // !__WXMAC__
2132 void wxListMainWindow::HighlightAll( bool on
)
2134 if ( IsSingleSel() )
2136 wxASSERT_MSG( !on
, wxT("can't do this in a single selection control") );
2138 // we just have one item to turn off
2139 if ( HasCurrent() && IsHighlighted(m_current
) )
2141 HighlightLine(m_current
, false);
2142 RefreshLine(m_current
);
2145 else // multi selection
2148 HighlightLines(0, GetItemCount() - 1, on
);
2152 void wxListMainWindow::OnChildFocus(wxChildFocusEvent
& WXUNUSED(event
))
2154 // Do nothing here. This prevents the default handler in wxScrolledWindow
2155 // from needlessly scrolling the window when the edit control is
2156 // dismissed. See ticket #9563.
2159 void wxListMainWindow::SendNotify( size_t line
,
2160 wxEventType command
,
2161 const wxPoint
& point
)
2163 wxListEvent
le( command
, GetParent()->GetId() );
2164 le
.SetEventObject( GetParent() );
2166 le
.m_item
.m_itemId
=
2167 le
.m_itemIndex
= line
;
2169 // set only for events which have position
2170 if ( point
!= wxDefaultPosition
)
2171 le
.m_pointDrag
= point
;
2173 // don't try to get the line info for virtual list controls: the main
2174 // program has it anyhow and if we did it would result in accessing all
2175 // the lines, even those which are not visible now and this is precisely
2176 // what we're trying to avoid
2179 if ( line
!= (size_t)-1 )
2181 GetLine(line
)->GetItem( 0, le
.m_item
);
2183 //else: this happens for wxEVT_COMMAND_LIST_ITEM_FOCUSED event
2185 //else: there may be no more such item
2187 GetParent()->GetEventHandler()->ProcessEvent( le
);
2190 void wxListMainWindow::ChangeCurrent(size_t current
)
2192 m_current
= current
;
2194 // as the current item changed, we shouldn't start editing it when the
2195 // "slow click" timer expires as the click happened on another item
2196 if ( m_renameTimer
->IsRunning() )
2197 m_renameTimer
->Stop();
2199 SendNotify(current
, wxEVT_COMMAND_LIST_ITEM_FOCUSED
);
2202 wxTextCtrl
*wxListMainWindow::EditLabel(long item
, wxClassInfo
* textControlClass
)
2204 wxCHECK_MSG( (item
>= 0) && ((size_t)item
< GetItemCount()), NULL
,
2205 wxT("wrong index in wxGenericListCtrl::EditLabel()") );
2207 wxASSERT_MSG( textControlClass
->IsKindOf(CLASSINFO(wxTextCtrl
)),
2208 wxT("EditLabel() needs a text control") );
2210 size_t itemEdit
= (size_t)item
;
2212 wxListEvent
le( wxEVT_COMMAND_LIST_BEGIN_LABEL_EDIT
, GetParent()->GetId() );
2213 le
.SetEventObject( GetParent() );
2214 le
.m_item
.m_itemId
=
2215 le
.m_itemIndex
= item
;
2216 wxListLineData
*data
= GetLine(itemEdit
);
2217 wxCHECK_MSG( data
, NULL
, wxT("invalid index in EditLabel()") );
2218 data
->GetItem( 0, le
.m_item
);
2220 if ( GetParent()->GetEventHandler()->ProcessEvent( le
) && !le
.IsAllowed() )
2222 // vetoed by user code
2226 // We have to call this here because the label in question might just have
2227 // been added and no screen update taken place.
2230 // TODO: use wxTheApp->SafeYieldFor(NULL, wxEVT_CATEGORY_UI) instead
2231 // so that no pending events may change the item count (see below)
2232 // IMPORTANT: needs to be tested!
2235 // Pending events dispatched by wxSafeYield might have changed the item
2237 if ( (size_t)item
>= GetItemCount() )
2241 wxTextCtrl
* const text
= (wxTextCtrl
*)textControlClass
->CreateObject();
2242 m_textctrlWrapper
= new wxListTextCtrlWrapper(this, text
, item
);
2243 return m_textctrlWrapper
->GetText();
2246 void wxListMainWindow::OnRenameTimer()
2248 wxCHECK_RET( HasCurrent(), wxT("unexpected rename timer") );
2250 EditLabel( m_current
);
2253 bool wxListMainWindow::OnRenameAccept(size_t itemEdit
, const wxString
& value
)
2255 wxListEvent
le( wxEVT_COMMAND_LIST_END_LABEL_EDIT
, GetParent()->GetId() );
2256 le
.SetEventObject( GetParent() );
2257 le
.m_item
.m_itemId
=
2258 le
.m_itemIndex
= itemEdit
;
2260 wxListLineData
*data
= GetLine(itemEdit
);
2262 wxCHECK_MSG( data
, false, wxT("invalid index in OnRenameAccept()") );
2264 data
->GetItem( 0, le
.m_item
);
2265 le
.m_item
.m_text
= value
;
2266 return !GetParent()->GetEventHandler()->ProcessEvent( le
) ||
2270 void wxListMainWindow::OnRenameCancelled(size_t itemEdit
)
2272 // let owner know that the edit was cancelled
2273 wxListEvent
le( wxEVT_COMMAND_LIST_END_LABEL_EDIT
, GetParent()->GetId() );
2275 le
.SetEditCanceled(true);
2277 le
.SetEventObject( GetParent() );
2278 le
.m_item
.m_itemId
=
2279 le
.m_itemIndex
= itemEdit
;
2281 wxListLineData
*data
= GetLine(itemEdit
);
2282 wxCHECK_RET( data
, wxT("invalid index in OnRenameCancelled()") );
2284 data
->GetItem( 0, le
.m_item
);
2285 GetEventHandler()->ProcessEvent( le
);
2288 void wxListMainWindow::OnMouse( wxMouseEvent
&event
)
2291 // On wxMac we can't depend on the EVT_KILL_FOCUS event to properly
2292 // shutdown the edit control when the mouse is clicked elsewhere on the
2293 // listctrl because the order of events is different (or something like
2294 // that), so explicitly end the edit if it is active.
2295 if ( event
.LeftDown() && m_textctrlWrapper
)
2296 m_textctrlWrapper
->EndEdit(wxListTextCtrlWrapper::End_Accept
);
2299 if ( event
.LeftDown() )
2302 event
.SetEventObject( GetParent() );
2303 if ( GetParent()->GetEventHandler()->ProcessEvent( event
) )
2306 if (event
.GetEventType() == wxEVT_MOUSEWHEEL
)
2308 // let the base class handle mouse wheel events.
2313 if ( !HasCurrent() || IsEmpty() )
2315 if (event
.RightDown())
2317 SendNotify( (size_t)-1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
, event
.GetPosition() );
2319 wxContextMenuEvent
evtCtx(wxEVT_CONTEXT_MENU
,
2320 GetParent()->GetId(),
2321 ClientToScreen(event
.GetPosition()));
2322 evtCtx
.SetEventObject(GetParent());
2323 GetParent()->GetEventHandler()->ProcessEvent(evtCtx
);
2331 if ( !(event
.Dragging() || event
.ButtonDown() || event
.LeftUp() ||
2332 event
.ButtonDClick()) )
2335 int x
= event
.GetX();
2336 int y
= event
.GetY();
2337 GetListCtrl()->CalcUnscrolledPosition( x
, y
, &x
, &y
);
2339 // where did we hit it (if we did)?
2342 size_t count
= GetItemCount(),
2345 if ( InReportView() )
2347 current
= y
/ GetLineHeight();
2348 if ( current
< count
)
2349 hitResult
= HitTestLine(current
, x
, y
);
2353 // TODO: optimize it too! this is less simple than for report view but
2354 // enumerating all items is still not a way to do it!!
2355 for ( current
= 0; current
< count
; current
++ )
2357 hitResult
= HitTestLine(current
, x
, y
);
2363 // Update drag events counter first as we must do it even if the mouse is
2364 // not on any item right now as we must keep count in case we started
2365 // dragging from the empty control area but continued to do it over a valid
2366 // item -- in this situation we must not start dragging this item.
2367 if (event
.Dragging())
2372 // The only mouse event that can be generated without any valid item is
2373 // wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK as it can be useful to have a global
2374 // popup menu for the list control itself which should be shown even when
2375 // the user clicks outside of any item.
2378 // outside of any item
2379 if (event
.RightDown())
2381 SendNotify( (size_t) -1, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
, event
.GetPosition() );
2383 wxContextMenuEvent
evtCtx(
2385 GetParent()->GetId(),
2386 ClientToScreen(event
.GetPosition()));
2387 evtCtx
.SetEventObject(GetParent());
2388 GetParent()->GetEventHandler()->ProcessEvent(evtCtx
);
2392 // reset the selection and bail out
2393 HighlightAll(false);
2399 if ( event
.Dragging() )
2401 if (m_dragCount
== 1)
2403 // we have to report the raw, physical coords as we want to be
2404 // able to call HitTest(event.m_pointDrag) from the user code to
2405 // get the item being dragged
2406 m_dragStart
= event
.GetPosition();
2409 if (m_dragCount
!= 3)
2412 int command
= event
.RightIsDown() ? wxEVT_COMMAND_LIST_BEGIN_RDRAG
2413 : wxEVT_COMMAND_LIST_BEGIN_DRAG
;
2415 SendNotify( m_lineLastClicked
, command
, m_dragStart
);
2420 bool forceClick
= false;
2421 if (event
.ButtonDClick())
2423 if ( m_renameTimer
->IsRunning() )
2424 m_renameTimer
->Stop();
2426 m_lastOnSame
= false;
2428 if ( current
== m_lineLastClicked
)
2430 SendNotify( current
, wxEVT_COMMAND_LIST_ITEM_ACTIVATED
);
2436 // The first click was on another item, so don't interpret this as
2437 // a double click, but as a simple click instead
2444 if (m_lineSelectSingleOnUp
!= (size_t)-1)
2446 // select single line
2447 HighlightAll( false );
2448 ReverseHighlight(m_lineSelectSingleOnUp
);
2453 if ((current
== m_current
) &&
2454 (hitResult
== wxLIST_HITTEST_ONITEMLABEL
) &&
2455 HasFlag(wxLC_EDIT_LABELS
) )
2457 if ( !InReportView() ||
2458 GetLineLabelRect(current
).Contains(x
, y
) )
2460 int dclick
= wxSystemSettings::GetMetric(wxSYS_DCLICK_MSEC
);
2461 m_renameTimer
->Start(dclick
> 0 ? dclick
: 250, true);
2466 m_lastOnSame
= false;
2467 m_lineSelectSingleOnUp
= (size_t)-1;
2471 // This is necessary, because after a DnD operation in
2472 // from and to ourself, the up event is swallowed by the
2473 // DnD code. So on next non-up event (which means here and
2474 // now) m_lineSelectSingleOnUp should be reset.
2475 m_lineSelectSingleOnUp
= (size_t)-1;
2477 if (event
.RightDown())
2479 m_lineBeforeLastClicked
= m_lineLastClicked
;
2480 m_lineLastClicked
= current
;
2482 // If the item is already selected, do not update the selection.
2483 // Multi-selections should not be cleared if a selected item is clicked.
2484 if (!IsHighlighted(current
))
2486 HighlightAll(false);
2487 ChangeCurrent(current
);
2488 ReverseHighlight(m_current
);
2491 SendNotify( current
, wxEVT_COMMAND_LIST_ITEM_RIGHT_CLICK
, event
.GetPosition() );
2493 // Allow generation of context menu event
2496 else if (event
.MiddleDown())
2498 SendNotify( current
, wxEVT_COMMAND_LIST_ITEM_MIDDLE_CLICK
);
2500 else if ( event
.LeftDown() || forceClick
)
2502 m_lineBeforeLastClicked
= m_lineLastClicked
;
2503 m_lineLastClicked
= current
;
2505 size_t oldCurrent
= m_current
;
2506 bool oldWasSelected
= IsHighlighted(m_current
);
2508 bool cmdModifierDown
= event
.CmdDown();
2509 if ( IsSingleSel() || !(cmdModifierDown
|| event
.ShiftDown()) )
2511 if ( IsSingleSel() || !IsHighlighted(current
) )
2513 HighlightAll( false );
2515 ChangeCurrent(current
);
2517 ReverseHighlight(m_current
);
2519 else // multi sel & current is highlighted & no mod keys
2521 m_lineSelectSingleOnUp
= current
;
2522 ChangeCurrent(current
); // change focus
2525 else // multi sel & either ctrl or shift is down
2527 if (cmdModifierDown
)
2529 ChangeCurrent(current
);
2531 ReverseHighlight(m_current
);
2533 else if (event
.ShiftDown())
2535 ChangeCurrent(current
);
2537 size_t lineFrom
= oldCurrent
,
2540 if ( lineTo
< lineFrom
)
2543 lineFrom
= m_current
;
2546 HighlightLines(lineFrom
, lineTo
);
2548 else // !ctrl, !shift
2550 // test in the enclosing if should make it impossible
2551 wxFAIL_MSG( wxT("how did we get here?") );
2555 if (m_current
!= oldCurrent
)
2556 RefreshLine( oldCurrent
);
2558 // forceClick is only set if the previous click was on another item
2559 m_lastOnSame
= !forceClick
&& (m_current
== oldCurrent
) && oldWasSelected
;
2563 void wxListMainWindow::MoveToItem(size_t item
)
2565 if ( item
== (size_t)-1 )
2568 wxRect rect
= GetLineRect(item
);
2570 int client_w
, client_h
;
2571 GetClientSize( &client_w
, &client_h
);
2573 const int hLine
= GetLineHeight();
2575 int view_x
= SCROLL_UNIT_X
* GetListCtrl()->GetScrollPos( wxHORIZONTAL
);
2576 int view_y
= hLine
* GetListCtrl()->GetScrollPos( wxVERTICAL
);
2578 if ( InReportView() )
2580 // the next we need the range of lines shown it might be different,
2581 // so recalculate it
2582 ResetVisibleLinesRange();
2584 if (rect
.y
< view_y
)
2585 GetListCtrl()->Scroll( -1, rect
.y
/ hLine
);
2586 if (rect
.y
+ rect
.height
+ 5 > view_y
+ client_h
)
2587 GetListCtrl()->Scroll( -1, (rect
.y
+ rect
.height
- client_h
+ hLine
) / hLine
);
2590 // At least on Mac the visible lines value will get reset inside of
2591 // Scroll *before* it actually scrolls the window because of the
2592 // Update() that happens there, so it will still have the wrong value.
2593 // So let's reset it again and wait for it to be recalculated in the
2594 // next paint event. I would expect this problem to show up in wxGTK
2595 // too but couldn't duplicate it there. Perhaps the order of events
2596 // is different... --Robin
2597 ResetVisibleLinesRange();
2605 if (rect
.x
-view_x
< 5)
2606 sx
= (rect
.x
- 5) / SCROLL_UNIT_X
;
2607 if (rect
.x
+ rect
.width
- 5 > view_x
+ client_w
)
2608 sx
= (rect
.x
+ rect
.width
- client_w
+ SCROLL_UNIT_X
) / SCROLL_UNIT_X
;
2610 if (rect
.y
-view_y
< 5)
2611 sy
= (rect
.y
- 5) / hLine
;
2612 if (rect
.y
+ rect
.height
- 5 > view_y
+ client_h
)
2613 sy
= (rect
.y
+ rect
.height
- client_h
+ hLine
) / hLine
;
2615 GetListCtrl()->Scroll(sx
, sy
);
2619 bool wxListMainWindow::ScrollList(int WXUNUSED(dx
), int dy
)
2621 if ( !InReportView() )
2623 // TODO: this should work in all views but is not implemented now
2628 GetVisibleLinesRange(&top
, &bottom
);
2630 if ( bottom
== (size_t)-1 )
2633 ResetVisibleLinesRange();
2635 int hLine
= GetLineHeight();
2637 GetListCtrl()->Scroll(-1, top
+ dy
/ hLine
);
2640 // see comment in MoveToItem() for why we do this
2641 ResetVisibleLinesRange();
2647 // ----------------------------------------------------------------------------
2648 // keyboard handling
2649 // ----------------------------------------------------------------------------
2651 void wxListMainWindow::OnArrowChar(size_t newCurrent
, const wxKeyEvent
& event
)
2653 wxCHECK_RET( newCurrent
< (size_t)GetItemCount(),
2654 wxT("invalid item index in OnArrowChar()") );
2656 size_t oldCurrent
= m_current
;
2658 // in single selection we just ignore Shift as we can't select several
2660 if ( event
.ShiftDown() && !IsSingleSel() )
2662 ChangeCurrent(newCurrent
);
2664 // refresh the old focus to remove it
2665 RefreshLine( oldCurrent
);
2667 // select all the items between the old and the new one
2668 if ( oldCurrent
> newCurrent
)
2670 newCurrent
= oldCurrent
;
2671 oldCurrent
= m_current
;
2674 HighlightLines(oldCurrent
, newCurrent
);
2678 // all previously selected items are unselected unless ctrl is held
2679 // in a multiselection control
2680 if ( !event
.ControlDown() || IsSingleSel() )
2681 HighlightAll(false);
2683 ChangeCurrent(newCurrent
);
2685 // refresh the old focus to remove it
2686 RefreshLine( oldCurrent
);
2688 // in single selection mode we must always have a selected item
2689 if ( !event
.ControlDown() || IsSingleSel() )
2690 HighlightLine( m_current
, true );
2693 RefreshLine( m_current
);
2698 void wxListMainWindow::OnKeyDown( wxKeyEvent
&event
)
2700 wxWindow
*parent
= GetParent();
2702 // propagate the key event upwards
2703 wxKeyEvent
ke(event
);
2704 ke
.SetEventObject( parent
);
2705 if (parent
->GetEventHandler()->ProcessEvent( ke
))
2708 // send a list event
2709 wxListEvent
le( wxEVT_COMMAND_LIST_KEY_DOWN
, parent
->GetId() );
2710 le
.m_item
.m_itemId
=
2711 le
.m_itemIndex
= m_current
;
2713 GetLine(m_current
)->GetItem( 0, le
.m_item
);
2714 le
.m_code
= event
.GetKeyCode();
2715 le
.SetEventObject( parent
);
2716 if (parent
->GetEventHandler()->ProcessEvent( le
))
2722 void wxListMainWindow::OnKeyUp( wxKeyEvent
&event
)
2724 wxWindow
*parent
= GetParent();
2726 // propagate the key event upwards
2727 wxKeyEvent
ke(event
);
2728 if (parent
->GetEventHandler()->ProcessEvent( ke
))
2734 void wxListMainWindow::OnCharHook( wxKeyEvent
&event
)
2736 if ( m_textctrlWrapper
)
2738 // When an in-place editor is active we should ensure that it always
2739 // gets the key events that are special to it.
2740 if ( m_textctrlWrapper
->CheckForEndEditKey(event
) )
2742 // Skip the call to wxEvent::Skip() below.
2750 void wxListMainWindow::OnChar( wxKeyEvent
&event
)
2752 wxWindow
*parent
= GetParent();
2754 // propagate the char event upwards
2755 wxKeyEvent
ke(event
);
2756 ke
.SetEventObject( parent
);
2757 if (parent
->GetEventHandler()->ProcessEvent( ke
))
2760 if ( HandleAsNavigationKey(event
) )
2763 // no item -> nothing to do
2770 // don't use m_linesPerPage directly as it might not be computed yet
2771 const int pageSize
= GetCountPerPage();
2772 wxCHECK_RET( pageSize
, wxT("should have non zero page size") );
2774 if (GetLayoutDirection() == wxLayout_RightToLeft
)
2776 if (event
.GetKeyCode() == WXK_RIGHT
)
2777 event
.m_keyCode
= WXK_LEFT
;
2778 else if (event
.GetKeyCode() == WXK_LEFT
)
2779 event
.m_keyCode
= WXK_RIGHT
;
2782 switch ( event
.GetKeyCode() )
2785 if ( m_current
> 0 )
2786 OnArrowChar( m_current
- 1, event
);
2790 if ( m_current
< (size_t)GetItemCount() - 1 )
2791 OnArrowChar( m_current
+ 1, event
);
2796 OnArrowChar( GetItemCount() - 1, event
);
2801 OnArrowChar( 0, event
);
2806 int steps
= InReportView() ? pageSize
- 1
2807 : m_current
% pageSize
;
2809 int index
= m_current
- steps
;
2813 OnArrowChar( index
, event
);
2819 int steps
= InReportView()
2821 : pageSize
- (m_current
% pageSize
) - 1;
2823 size_t index
= m_current
+ steps
;
2824 size_t count
= GetItemCount();
2825 if ( index
>= count
)
2828 OnArrowChar( index
, event
);
2833 if ( !InReportView() )
2835 int index
= m_current
- pageSize
;
2839 OnArrowChar( index
, event
);
2844 if ( !InReportView() )
2846 size_t index
= m_current
+ pageSize
;
2848 size_t count
= GetItemCount();
2849 if ( index
>= count
)
2852 OnArrowChar( index
, event
);
2857 if ( IsSingleSel() )
2859 if ( event
.ControlDown() )
2861 ReverseHighlight(m_current
);
2863 else // normal space press
2865 SendNotify( m_current
, wxEVT_COMMAND_LIST_ITEM_ACTIVATED
);
2868 else // multiple selection
2870 ReverseHighlight(m_current
);
2876 SendNotify( m_current
, wxEVT_COMMAND_LIST_ITEM_ACTIVATED
);
2884 // ----------------------------------------------------------------------------
2886 // ----------------------------------------------------------------------------
2888 void wxListMainWindow::OnSetFocus( wxFocusEvent
&WXUNUSED(event
) )
2892 wxFocusEvent
event( wxEVT_SET_FOCUS
, GetParent()->GetId() );
2893 event
.SetEventObject( GetParent() );
2894 if ( GetParent()->GetEventHandler()->ProcessEvent( event
) )
2898 // wxGTK sends us EVT_SET_FOCUS events even if we had never got
2899 // EVT_KILL_FOCUS before which means that we finish by redrawing the items
2900 // which are already drawn correctly resulting in horrible flicker - avoid
2910 void wxListMainWindow::OnKillFocus( wxFocusEvent
&WXUNUSED(event
) )
2914 wxFocusEvent
event( wxEVT_KILL_FOCUS
, GetParent()->GetId() );
2915 event
.SetEventObject( GetParent() );
2916 if ( GetParent()->GetEventHandler()->ProcessEvent( event
) )
2924 void wxListMainWindow::DrawImage( int index
, wxDC
*dc
, int x
, int y
)
2926 if ( HasFlag(wxLC_ICON
) && (m_normal_image_list
))
2928 m_normal_image_list
->Draw( index
, *dc
, x
, y
, wxIMAGELIST_DRAW_TRANSPARENT
);
2930 else if ( HasFlag(wxLC_SMALL_ICON
) && (m_small_image_list
))
2932 m_small_image_list
->Draw( index
, *dc
, x
, y
, wxIMAGELIST_DRAW_TRANSPARENT
);
2934 else if ( HasFlag(wxLC_LIST
) && (m_small_image_list
))
2936 m_small_image_list
->Draw( index
, *dc
, x
, y
, wxIMAGELIST_DRAW_TRANSPARENT
);
2938 else if ( InReportView() && (m_small_image_list
))
2940 m_small_image_list
->Draw( index
, *dc
, x
, y
, wxIMAGELIST_DRAW_TRANSPARENT
);
2944 void wxListMainWindow::GetImageSize( int index
, int &width
, int &height
) const
2946 if ( HasFlag(wxLC_ICON
) && m_normal_image_list
)
2948 m_normal_image_list
->GetSize( index
, width
, height
);
2950 else if ( HasFlag(wxLC_SMALL_ICON
) && m_small_image_list
)
2952 m_small_image_list
->GetSize( index
, width
, height
);
2954 else if ( HasFlag(wxLC_LIST
) && m_small_image_list
)
2956 m_small_image_list
->GetSize( index
, width
, height
);
2958 else if ( InReportView() && m_small_image_list
)
2960 m_small_image_list
->GetSize( index
, width
, height
);
2969 void wxListMainWindow::SetImageList( wxImageList
*imageList
, int which
)
2973 // calc the spacing from the icon size
2974 int width
= 0, height
= 0;
2976 if ((imageList
) && (imageList
->GetImageCount()) )
2977 imageList
->GetSize(0, width
, height
);
2979 if (which
== wxIMAGE_LIST_NORMAL
)
2981 m_normal_image_list
= imageList
;
2982 m_normal_spacing
= width
+ 8;
2985 if (which
== wxIMAGE_LIST_SMALL
)
2987 m_small_image_list
= imageList
;
2988 m_small_spacing
= width
+ 14;
2989 m_lineHeight
= 0; // ensure that the line height will be recalc'd
2993 void wxListMainWindow::SetItemSpacing( int spacing
, bool isSmall
)
2997 m_small_spacing
= spacing
;
2999 m_normal_spacing
= spacing
;
3002 int wxListMainWindow::GetItemSpacing( bool isSmall
)
3004 return isSmall
? m_small_spacing
: m_normal_spacing
;
3007 // ----------------------------------------------------------------------------
3009 // ----------------------------------------------------------------------------
3012 wxListMainWindow::ComputeMinHeaderWidth(const wxListHeaderData
* column
) const
3014 wxClientDC
dc(const_cast<wxListMainWindow
*>(this));
3016 int width
= dc
.GetTextExtent(column
->GetText()).x
+ AUTOSIZE_COL_MARGIN
;
3018 width
+= 2*EXTRA_WIDTH
;
3020 // check for column header's image availability
3021 const int image
= column
->GetImage();
3024 if ( m_small_image_list
)
3027 m_small_image_list
->GetSize(image
, ix
, iy
);
3028 width
+= ix
+ HEADER_IMAGE_MARGIN_IN_REPORT_MODE
;
3035 void wxListMainWindow::SetColumn( int col
, const wxListItem
&item
)
3037 wxListHeaderDataList::compatibility_iterator node
= m_columns
.Item( col
);
3039 wxCHECK_RET( node
, wxT("invalid column index in SetColumn") );
3041 wxListHeaderData
*column
= node
->GetData();
3042 column
->SetItem( item
);
3044 if ( item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
3045 column
->SetWidth(ComputeMinHeaderWidth(column
));
3047 wxListHeaderWindow
*headerWin
= GetListCtrl()->m_headerWin
;
3049 headerWin
->m_dirty
= true;
3053 // invalidate it as it has to be recalculated
3057 void wxListMainWindow::SetColumnWidth( int col
, int width
)
3059 wxCHECK_RET( col
>= 0 && col
< GetColumnCount(),
3060 wxT("invalid column index") );
3062 wxCHECK_RET( InReportView(),
3063 wxT("SetColumnWidth() can only be called in report mode.") );
3067 wxListHeaderWindow
*headerWin
= GetListCtrl()->m_headerWin
;
3069 headerWin
->m_dirty
= true;
3071 wxListHeaderDataList::compatibility_iterator node
= m_columns
.Item( col
);
3072 wxCHECK_RET( node
, wxT("no column?") );
3074 wxListHeaderData
*column
= node
->GetData();
3076 size_t count
= GetItemCount();
3078 if (width
== wxLIST_AUTOSIZE_USEHEADER
)
3080 width
= ComputeMinHeaderWidth(column
);
3082 else if ( width
== wxLIST_AUTOSIZE
)
3084 width
= ComputeMinHeaderWidth(column
);
3088 wxClientDC
dc(this);
3089 dc
.SetFont( GetFont() );
3091 int max
= AUTOSIZE_COL_MARGIN
;
3093 // if the cached column width isn't valid then recalculate it
3094 if (m_aColWidths
.Item(col
)->bNeedsUpdate
)
3096 for (size_t i
= 0; i
< count
; i
++)
3098 wxListLineData
*line
= GetLine( i
);
3099 wxListItemDataList::compatibility_iterator n
= line
->m_items
.Item( col
);
3101 wxCHECK_RET( n
, wxT("no subitem?") );
3103 wxListItemData
*itemData
= n
->GetData();
3106 itemData
->GetItem(item
);
3107 int itemWidth
= GetItemWidthWithImage(&item
);
3108 if (itemWidth
> max
)
3112 m_aColWidths
.Item(col
)->bNeedsUpdate
= false;
3113 m_aColWidths
.Item(col
)->nMaxWidth
= max
;
3116 max
= m_aColWidths
.Item(col
)->nMaxWidth
+ AUTOSIZE_COL_MARGIN
;
3122 column
->SetWidth( width
);
3124 // invalidate it as it has to be recalculated
3128 int wxListMainWindow::GetHeaderWidth() const
3130 if ( !m_headerWidth
)
3132 wxListMainWindow
*self
= wxConstCast(this, wxListMainWindow
);
3134 size_t count
= GetColumnCount();
3135 for ( size_t col
= 0; col
< count
; col
++ )
3137 self
->m_headerWidth
+= GetColumnWidth(col
);
3141 return m_headerWidth
;
3144 void wxListMainWindow::GetColumn( int col
, wxListItem
&item
) const
3146 wxListHeaderDataList::compatibility_iterator node
= m_columns
.Item( col
);
3147 wxCHECK_RET( node
, wxT("invalid column index in GetColumn") );
3149 wxListHeaderData
*column
= node
->GetData();
3150 column
->GetItem( item
);
3153 int wxListMainWindow::GetColumnWidth( int col
) const
3155 wxListHeaderDataList::compatibility_iterator node
= m_columns
.Item( col
);
3156 wxCHECK_MSG( node
, 0, wxT("invalid column index") );
3158 wxListHeaderData
*column
= node
->GetData();
3159 return column
->GetWidth();
3162 // ----------------------------------------------------------------------------
3164 // ----------------------------------------------------------------------------
3166 void wxListMainWindow::SetItem( wxListItem
&item
)
3168 long id
= item
.m_itemId
;
3169 wxCHECK_RET( id
>= 0 && (size_t)id
< GetItemCount(),
3170 wxT("invalid item index in SetItem") );
3174 wxListLineData
*line
= GetLine((size_t)id
);
3175 line
->SetItem( item
.m_col
, item
);
3177 // Set item state if user wants
3178 if ( item
.m_mask
& wxLIST_MASK_STATE
)
3179 SetItemState( item
.m_itemId
, item
.m_state
, item
.m_state
);
3183 // update the Max Width Cache if needed
3184 int width
= GetItemWidthWithImage(&item
);
3186 if (width
> m_aColWidths
.Item(item
.m_col
)->nMaxWidth
)
3187 m_aColWidths
.Item(item
.m_col
)->nMaxWidth
= width
;
3191 // update the item on screen unless we're going to update everything soon
3196 GetItemRect(id
, rectItem
);
3197 RefreshRect(rectItem
);
3201 void wxListMainWindow::SetItemStateAll(long state
, long stateMask
)
3206 // first deal with selection
3207 if ( stateMask
& wxLIST_STATE_SELECTED
)
3209 // set/clear select state
3212 // optimized version for virtual listctrl.
3213 m_selStore
.SelectRange(0, GetItemCount() - 1, state
== wxLIST_STATE_SELECTED
);
3216 else if ( state
& wxLIST_STATE_SELECTED
)
3218 const long count
= GetItemCount();
3219 for( long i
= 0; i
< count
; i
++ )
3221 SetItemState( i
, wxLIST_STATE_SELECTED
, wxLIST_STATE_SELECTED
);
3227 // clear for non virtual (somewhat optimized by using GetNextItem())
3229 while ( (i
= GetNextItem(i
, wxLIST_NEXT_ALL
, wxLIST_STATE_SELECTED
)) != -1 )
3231 SetItemState( i
, 0, wxLIST_STATE_SELECTED
);
3236 if ( HasCurrent() && (state
== 0) && (stateMask
& wxLIST_STATE_FOCUSED
) )
3238 // unfocus all: only one item can be focussed, so clearing focus for
3239 // all items is simply clearing focus of the focussed item.
3240 SetItemState(m_current
, state
, stateMask
);
3242 //(setting focus to all items makes no sense, so it is not handled here.)
3245 void wxListMainWindow::SetItemState( long litem
, long state
, long stateMask
)
3249 SetItemStateAll(state
, stateMask
);
3253 wxCHECK_RET( litem
>= 0 && (size_t)litem
< GetItemCount(),
3254 wxT("invalid list ctrl item index in SetItem") );
3256 size_t oldCurrent
= m_current
;
3257 size_t item
= (size_t)litem
; // safe because of the check above
3259 // do we need to change the focus?
3260 if ( stateMask
& wxLIST_STATE_FOCUSED
)
3262 if ( state
& wxLIST_STATE_FOCUSED
)
3264 // don't do anything if this item is already focused
3265 if ( item
!= m_current
)
3267 ChangeCurrent(item
);
3269 if ( oldCurrent
!= (size_t)-1 )
3271 if ( IsSingleSel() )
3273 HighlightLine(oldCurrent
, false);
3276 RefreshLine(oldCurrent
);
3279 RefreshLine( m_current
);
3284 // don't do anything if this item is not focused
3285 if ( item
== m_current
)
3289 if ( IsSingleSel() )
3291 // we must unselect the old current item as well or we
3292 // might end up with more than one selected item in a
3293 // single selection control
3294 HighlightLine(oldCurrent
, false);
3297 RefreshLine( oldCurrent
);
3302 // do we need to change the selection state?
3303 if ( stateMask
& wxLIST_STATE_SELECTED
)
3305 bool on
= (state
& wxLIST_STATE_SELECTED
) != 0;
3307 if ( IsSingleSel() )
3311 // selecting the item also makes it the focused one in the
3313 if ( m_current
!= item
)
3315 ChangeCurrent(item
);
3317 if ( oldCurrent
!= (size_t)-1 )
3319 HighlightLine( oldCurrent
, false );
3320 RefreshLine( oldCurrent
);
3326 // only the current item may be selected anyhow
3327 if ( item
!= m_current
)
3332 if ( HighlightLine(item
, on
) )
3339 int wxListMainWindow::GetItemState( long item
, long stateMask
) const
3341 wxCHECK_MSG( item
>= 0 && (size_t)item
< GetItemCount(), 0,
3342 wxT("invalid list ctrl item index in GetItemState()") );
3344 int ret
= wxLIST_STATE_DONTCARE
;
3346 if ( stateMask
& wxLIST_STATE_FOCUSED
)
3348 if ( (size_t)item
== m_current
)
3349 ret
|= wxLIST_STATE_FOCUSED
;
3352 if ( stateMask
& wxLIST_STATE_SELECTED
)
3354 if ( IsHighlighted(item
) )
3355 ret
|= wxLIST_STATE_SELECTED
;
3361 void wxListMainWindow::GetItem( wxListItem
&item
) const
3363 wxCHECK_RET( item
.m_itemId
>= 0 && (size_t)item
.m_itemId
< GetItemCount(),
3364 wxT("invalid item index in GetItem") );
3366 wxListLineData
*line
= GetLine((size_t)item
.m_itemId
);
3367 line
->GetItem( item
.m_col
, item
);
3369 // Get item state if user wants it
3370 if ( item
.m_mask
& wxLIST_MASK_STATE
)
3371 item
.m_state
= GetItemState( item
.m_itemId
, wxLIST_STATE_SELECTED
|
3372 wxLIST_STATE_FOCUSED
);
3375 // ----------------------------------------------------------------------------
3377 // ----------------------------------------------------------------------------
3379 size_t wxListMainWindow::GetItemCount() const
3381 return IsVirtual() ? m_countVirt
: m_lines
.GetCount();
3384 void wxListMainWindow::SetItemCount(long count
)
3386 m_selStore
.SetItemCount(count
);
3387 m_countVirt
= count
;
3389 ResetVisibleLinesRange();
3391 // scrollbars must be reset
3395 int wxListMainWindow::GetSelectedItemCount() const
3397 // deal with the quick case first
3398 if ( IsSingleSel() )
3399 return HasCurrent() ? IsHighlighted(m_current
) : false;
3401 // virtual controls remmebers all its selections itself
3403 return m_selStore
.GetSelectedCount();
3405 // TODO: we probably should maintain the number of items selected even for
3406 // non virtual controls as enumerating all lines is really slow...
3407 size_t countSel
= 0;
3408 size_t count
= GetItemCount();
3409 for ( size_t line
= 0; line
< count
; line
++ )
3411 if ( GetLine(line
)->IsHighlighted() )
3418 // ----------------------------------------------------------------------------
3419 // item position/size
3420 // ----------------------------------------------------------------------------
3422 wxRect
wxListMainWindow::GetViewRect() const
3424 wxASSERT_MSG( !HasFlag(wxLC_LIST
), "not implemented for list view" );
3426 // we need to find the longest/tallest label
3427 wxCoord xMax
= 0, yMax
= 0;
3428 const int count
= GetItemCount();
3431 for ( int i
= 0; i
< count
; i
++ )
3433 // we need logical, not physical, coordinates here, so use
3434 // GetLineRect() instead of GetItemRect()
3435 wxRect r
= GetLineRect(i
);
3437 wxCoord x
= r
.GetRight(),
3447 // some fudge needed to make it look prettier
3448 xMax
+= 2 * EXTRA_BORDER_X
;
3449 yMax
+= 2 * EXTRA_BORDER_Y
;
3451 // account for the scrollbars if necessary
3452 const wxSize sizeAll
= GetClientSize();
3453 if ( xMax
> sizeAll
.x
)
3454 yMax
+= wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
3455 if ( yMax
> sizeAll
.y
)
3456 xMax
+= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
3458 return wxRect(0, 0, xMax
, yMax
);
3462 wxListMainWindow::GetSubItemRect(long item
, long subItem
, wxRect
& rect
) const
3464 wxCHECK_MSG( subItem
== wxLIST_GETSUBITEMRECT_WHOLEITEM
|| InReportView(),
3466 wxT("GetSubItemRect only meaningful in report view") );
3467 wxCHECK_MSG( item
>= 0 && (size_t)item
< GetItemCount(), false,
3468 wxT("invalid item in GetSubItemRect") );
3470 // ensure that we're laid out, otherwise we could return nonsense
3473 wxConstCast(this, wxListMainWindow
)->
3474 RecalculatePositions(true /* no refresh */);
3477 rect
= GetLineRect((size_t)item
);
3479 // Adjust rect to specified column
3480 if ( subItem
!= wxLIST_GETSUBITEMRECT_WHOLEITEM
)
3482 wxCHECK_MSG( subItem
>= 0 && subItem
< GetColumnCount(), false,
3483 wxT("invalid subItem in GetSubItemRect") );
3485 for (int i
= 0; i
< subItem
; i
++)
3487 rect
.x
+= GetColumnWidth(i
);
3489 rect
.width
= GetColumnWidth(subItem
);
3492 GetListCtrl()->CalcScrolledPosition(rect
.x
, rect
.y
, &rect
.x
, &rect
.y
);
3497 bool wxListMainWindow::GetItemPosition(long item
, wxPoint
& pos
) const
3500 GetItemRect(item
, rect
);
3508 // ----------------------------------------------------------------------------
3509 // geometry calculation
3510 // ----------------------------------------------------------------------------
3512 void wxListMainWindow::RecalculatePositions(bool noRefresh
)
3514 const int lineHeight
= GetLineHeight();
3516 wxClientDC
dc( this );
3517 dc
.SetFont( GetFont() );
3519 const size_t count
= GetItemCount();
3522 if ( HasFlag(wxLC_ICON
) && m_normal_image_list
)
3523 iconSpacing
= m_normal_spacing
;
3524 else if ( HasFlag(wxLC_SMALL_ICON
) && m_small_image_list
)
3525 iconSpacing
= m_small_spacing
;
3529 // Note that we do not call GetClientSize() here but
3530 // GetSize() and subtract the border size for sunken
3531 // borders manually. This is technically incorrect,
3532 // but we need to know the client area's size WITHOUT
3533 // scrollbars here. Since we don't know if there are
3534 // any scrollbars, we use GetSize() instead. Another
3535 // solution would be to call SetScrollbars() here to
3536 // remove the scrollbars and call GetClientSize() then,
3537 // but this might result in flicker and - worse - will
3538 // reset the scrollbars to 0 which is not good at all
3539 // if you resize a dialog/window, but don't want to
3540 // reset the window scrolling. RR.
3541 // Furthermore, we actually do NOT subtract the border
3542 // width as 2 pixels is just the extra space which we
3543 // need around the actual content in the window. Other-
3544 // wise the text would e.g. touch the upper border. RR.
3547 GetSize( &clientWidth
, &clientHeight
);
3549 if ( InReportView() )
3551 // all lines have the same height and we scroll one line per step
3552 int entireHeight
= count
* lineHeight
+ LINE_SPACING
;
3554 m_linesPerPage
= clientHeight
/ lineHeight
;
3556 ResetVisibleLinesRange();
3558 GetListCtrl()->SetScrollbars( SCROLL_UNIT_X
, lineHeight
,
3559 GetHeaderWidth() / SCROLL_UNIT_X
,
3560 (entireHeight
+ lineHeight
- 1) / lineHeight
,
3561 GetListCtrl()->GetScrollPos(wxHORIZONTAL
),
3562 GetListCtrl()->GetScrollPos(wxVERTICAL
),
3567 // we have 3 different layout strategies: either layout all items
3568 // horizontally/vertically (wxLC_ALIGN_XXX styles explicitly given) or
3569 // to arrange them in top to bottom, left to right (don't ask me why
3570 // not the other way round...) order
3571 if ( HasFlag(wxLC_ALIGN_LEFT
| wxLC_ALIGN_TOP
) )
3573 int x
= EXTRA_BORDER_X
;
3574 int y
= EXTRA_BORDER_Y
;
3576 wxCoord widthMax
= 0;
3579 for ( i
= 0; i
< count
; i
++ )
3581 wxListLineData
*line
= GetLine(i
);
3582 line
->CalculateSize( &dc
, iconSpacing
);
3583 line
->SetPosition( x
, y
, iconSpacing
);
3585 wxSize sizeLine
= GetLineSize(i
);
3587 if ( HasFlag(wxLC_ALIGN_TOP
) )
3589 if ( sizeLine
.x
> widthMax
)
3590 widthMax
= sizeLine
.x
;
3594 else // wxLC_ALIGN_LEFT
3596 x
+= sizeLine
.x
+ MARGIN_BETWEEN_ROWS
;
3600 if ( HasFlag(wxLC_ALIGN_TOP
) )
3602 // traverse the items again and tweak their sizes so that they are
3603 // all the same in a row
3604 for ( i
= 0; i
< count
; i
++ )
3606 wxListLineData
*line
= GetLine(i
);
3607 line
->m_gi
->ExtendWidth(widthMax
);
3611 GetListCtrl()->SetScrollbars
3615 (x
+ SCROLL_UNIT_X
) / SCROLL_UNIT_X
,
3616 (y
+ lineHeight
) / lineHeight
,
3617 GetListCtrl()->GetScrollPos( wxHORIZONTAL
),
3618 GetListCtrl()->GetScrollPos( wxVERTICAL
),
3622 else // "flowed" arrangement, the most complicated case
3624 // at first we try without any scrollbars, if the items don't fit into
3625 // the window, we recalculate after subtracting the space taken by the
3628 int entireWidth
= 0;
3630 for (int tries
= 0; tries
< 2; tries
++)
3632 entireWidth
= 2 * EXTRA_BORDER_X
;
3636 // Now we have decided that the items do not fit into the
3637 // client area, so we need a scrollbar
3638 entireWidth
+= SCROLL_UNIT_X
;
3641 int x
= EXTRA_BORDER_X
;
3642 int y
= EXTRA_BORDER_Y
;
3644 // Note that "row" here is vertical, i.e. what is called
3645 // "column" in many other places in wxWidgets.
3646 int maxWidthInThisRow
= 0;
3649 int currentlyVisibleLines
= 0;
3651 for (size_t i
= 0; i
< count
; i
++)
3653 currentlyVisibleLines
++;
3654 wxListLineData
*line
= GetLine( i
);
3655 line
->CalculateSize( &dc
, iconSpacing
);
3656 line
->SetPosition( x
, y
, iconSpacing
);
3658 wxSize sizeLine
= GetLineSize( i
);
3660 if ( maxWidthInThisRow
< sizeLine
.x
)
3661 maxWidthInThisRow
= sizeLine
.x
;
3664 if (currentlyVisibleLines
> m_linesPerPage
)
3665 m_linesPerPage
= currentlyVisibleLines
;
3667 // Have we reached the end of the row either because no
3668 // more items would fit or because there are simply no more
3670 if ( y
+ sizeLine
.y
>= clientHeight
3673 // Adjust all items in this row to have the same
3674 // width to ensure that they all align horizontally in
3676 if ( HasFlag(wxLC_ICON
) || HasFlag(wxLC_SMALL_ICON
) )
3678 size_t firstRowLine
= i
- currentlyVisibleLines
+ 1;
3679 for (size_t j
= firstRowLine
; j
<= i
; j
++)
3681 GetLine(j
)->m_gi
->ExtendWidth(maxWidthInThisRow
);
3685 currentlyVisibleLines
= 0;
3687 maxWidthInThisRow
+= MARGIN_BETWEEN_ROWS
;
3688 x
+= maxWidthInThisRow
;
3689 entireWidth
+= maxWidthInThisRow
;
3690 maxWidthInThisRow
= 0;
3693 if ( (tries
== 0) &&
3694 (entireWidth
+ SCROLL_UNIT_X
> clientWidth
) )
3696 clientHeight
-= wxSystemSettings::
3697 GetMetric(wxSYS_HSCROLL_Y
);
3702 if ( i
== count
- 1 )
3703 tries
= 1; // Everything fits, no second try required.
3707 GetListCtrl()->SetScrollbars
3711 (entireWidth
+ SCROLL_UNIT_X
) / SCROLL_UNIT_X
,
3713 GetListCtrl()->GetScrollPos( wxHORIZONTAL
),
3722 // FIXME: why should we call it from here?
3729 void wxListMainWindow::RefreshAll()
3734 wxListHeaderWindow
*headerWin
= GetListCtrl()->m_headerWin
;
3735 if ( headerWin
&& headerWin
->m_dirty
)
3737 headerWin
->m_dirty
= false;
3738 headerWin
->Refresh();
3742 void wxListMainWindow::UpdateCurrent()
3744 if ( !HasCurrent() && !IsEmpty() )
3748 long wxListMainWindow::GetNextItem( long item
,
3749 int WXUNUSED(geometry
),
3753 max
= GetItemCount();
3754 wxCHECK_MSG( (ret
== -1) || (ret
< max
), -1,
3755 wxT("invalid listctrl index in GetNextItem()") );
3757 // notice that we start with the next item (or the first one if item == -1)
3758 // and this is intentional to allow writing a simple loop to iterate over
3759 // all selected items
3762 // this is not an error because the index was OK initially,
3763 // just no such item
3770 size_t count
= GetItemCount();
3771 for ( size_t line
= (size_t)ret
; line
< count
; line
++ )
3773 if ( (state
& wxLIST_STATE_FOCUSED
) && (line
== m_current
) )
3776 if ( (state
& wxLIST_STATE_SELECTED
) && IsHighlighted(line
) )
3783 // ----------------------------------------------------------------------------
3785 // ----------------------------------------------------------------------------
3787 void wxListMainWindow::DeleteItem( long lindex
)
3789 size_t count
= GetItemCount();
3791 wxCHECK_RET( (lindex
>= 0) && ((size_t)lindex
< count
),
3792 wxT("invalid item index in DeleteItem") );
3794 size_t index
= (size_t)lindex
;
3796 // we don't need to adjust the index for the previous items
3797 if ( HasCurrent() && m_current
>= index
)
3799 // if the current item is being deleted, we want the next one to
3800 // become selected - unless there is no next one - so don't adjust
3801 // m_current in this case
3802 if ( m_current
!= index
|| m_current
== count
- 1 )
3806 if ( InReportView() )
3808 // mark the Column Max Width cache as dirty if the items in the line
3809 // we're deleting contain the Max Column Width
3810 wxListLineData
* const line
= GetLine(index
);
3811 wxListItemDataList::compatibility_iterator n
;
3812 wxListItemData
*itemData
;
3816 for (size_t i
= 0; i
< m_columns
.GetCount(); i
++)
3818 n
= line
->m_items
.Item( i
);
3819 itemData
= n
->GetData();
3820 itemData
->GetItem(item
);
3822 itemWidth
= GetItemWidthWithImage(&item
);
3824 if (itemWidth
>= m_aColWidths
.Item(i
)->nMaxWidth
)
3825 m_aColWidths
.Item(i
)->bNeedsUpdate
= true;
3828 ResetVisibleLinesRange();
3831 SendNotify( index
, wxEVT_COMMAND_LIST_DELETE_ITEM
, wxDefaultPosition
);
3836 m_selStore
.OnItemDelete(index
);
3840 m_lines
.RemoveAt( index
);
3843 // we need to refresh the (vert) scrollbar as the number of items changed
3846 RefreshAfter(index
);
3849 void wxListMainWindow::DeleteColumn( int col
)
3851 wxListHeaderDataList::compatibility_iterator node
= m_columns
.Item( col
);
3853 wxCHECK_RET( node
, wxT("invalid column index in DeleteColumn()") );
3856 delete node
->GetData();
3857 m_columns
.Erase( node
);
3861 // update all the items
3862 for ( size_t i
= 0; i
< m_lines
.GetCount(); i
++ )
3864 wxListLineData
* const line
= GetLine(i
);
3866 // In the following atypical but possible scenario it can be
3867 // legal to call DeleteColumn() but the items may not have any
3869 // 1. In report view, insert a second column.
3870 // 2. Still in report view, add an item with 2 values.
3871 // 3. Switch to an icon (or list) view.
3872 // 4. Add an item -- necessarily with 1 value only.
3873 // 5. Switch back to report view.
3874 // 6. Call DeleteColumn().
3875 // So we need to check for this as otherwise we would simply crash
3877 if ( line
->m_items
.GetCount() <= static_cast<unsigned>(col
) )
3880 wxListItemDataList::compatibility_iterator n
= line
->m_items
.Item( col
);
3881 delete n
->GetData();
3882 line
->m_items
.Erase(n
);
3886 if ( InReportView() ) // we only cache max widths when in Report View
3888 delete m_aColWidths
.Item(col
);
3889 m_aColWidths
.RemoveAt(col
);
3892 // invalidate it as it has to be recalculated
3896 void wxListMainWindow::DoDeleteAllItems()
3899 // nothing to do - in particular, don't send the event
3904 // to make the deletion of all items faster, we don't send the
3905 // notifications for each item deletion in this case but only one event
3906 // for all of them: this is compatible with wxMSW and documented in
3907 // DeleteAllItems() description
3909 wxListEvent
event( wxEVT_COMMAND_LIST_DELETE_ALL_ITEMS
, GetParent()->GetId() );
3910 event
.SetEventObject( GetParent() );
3911 GetParent()->GetEventHandler()->ProcessEvent( event
);
3919 if ( InReportView() )
3921 ResetVisibleLinesRange();
3922 for (size_t i
= 0; i
< m_aColWidths
.GetCount(); i
++)
3924 m_aColWidths
.Item(i
)->bNeedsUpdate
= true;
3931 void wxListMainWindow::DeleteAllItems()
3935 RecalculatePositions();
3938 void wxListMainWindow::DeleteEverything()
3940 WX_CLEAR_LIST(wxListHeaderDataList
, m_columns
);
3941 WX_CLEAR_ARRAY(m_aColWidths
);
3946 // ----------------------------------------------------------------------------
3947 // scanning for an item
3948 // ----------------------------------------------------------------------------
3950 void wxListMainWindow::EnsureVisible( long index
)
3952 wxCHECK_RET( index
>= 0 && (size_t)index
< GetItemCount(),
3953 wxT("invalid index in EnsureVisible") );
3955 // We have to call this here because the label in question might just have
3956 // been added and its position is not known yet
3958 RecalculatePositions(true /* no refresh */);
3960 MoveToItem((size_t)index
);
3963 long wxListMainWindow::FindItem(long start
, const wxString
& str
, bool partial
)
3969 wxString str_upper
= str
.Upper();
3973 size_t count
= GetItemCount();
3974 for ( size_t i
= (size_t)pos
; i
< count
; i
++ )
3976 wxListLineData
*line
= GetLine(i
);
3977 wxString line_upper
= line
->GetText(0).Upper();
3980 if (line_upper
== str_upper
)
3985 if (line_upper
.find(str_upper
) == 0)
3993 long wxListMainWindow::FindItem(long start
, wxUIntPtr data
)
3999 size_t count
= GetItemCount();
4000 for (size_t i
= (size_t)pos
; i
< count
; i
++)
4002 wxListLineData
*line
= GetLine(i
);
4004 line
->GetItem( 0, item
);
4005 if (item
.m_data
== data
)
4012 long wxListMainWindow::FindItem( const wxPoint
& pt
)
4015 GetVisibleLinesRange( &topItem
, NULL
);
4018 GetItemPosition( GetItemCount() - 1, p
);
4022 long id
= (long)floor( pt
.y
* double(GetItemCount() - topItem
- 1) / p
.y
+ topItem
);
4023 if ( id
>= 0 && id
< (long)GetItemCount() )
4029 long wxListMainWindow::HitTest( int x
, int y
, int &flags
) const
4031 GetListCtrl()->CalcUnscrolledPosition( x
, y
, &x
, &y
);
4033 size_t count
= GetItemCount();
4035 if ( InReportView() )
4037 size_t current
= y
/ GetLineHeight();
4038 if ( current
< count
)
4040 flags
= HitTestLine(current
, x
, y
);
4047 // TODO: optimize it too! this is less simple than for report view but
4048 // enumerating all items is still not a way to do it!!
4049 for ( size_t current
= 0; current
< count
; current
++ )
4051 flags
= HitTestLine(current
, x
, y
);
4060 // ----------------------------------------------------------------------------
4062 // ----------------------------------------------------------------------------
4064 void wxListMainWindow::InsertItem( wxListItem
&item
)
4066 wxASSERT_MSG( !IsVirtual(), wxT("can't be used with virtual control") );
4068 int count
= GetItemCount();
4069 wxCHECK_RET( item
.m_itemId
>= 0, wxT("invalid item index") );
4071 if (item
.m_itemId
> count
)
4072 item
.m_itemId
= count
;
4074 size_t id
= item
.m_itemId
;
4078 if ( InReportView() )
4080 ResetVisibleLinesRange();
4082 const unsigned col
= item
.GetColumn();
4083 wxCHECK_RET( col
< m_aColWidths
.size(), "invalid item column" );
4085 // calculate the width of the item and adjust the max column width
4086 wxColWidthInfo
*pWidthInfo
= m_aColWidths
.Item(col
);
4087 int width
= GetItemWidthWithImage(&item
);
4088 item
.SetWidth(width
);
4089 if (width
> pWidthInfo
->nMaxWidth
)
4090 pWidthInfo
->nMaxWidth
= width
;
4093 wxListLineData
*line
= new wxListLineData(this);
4095 line
->SetItem( item
.m_col
, item
);
4096 if ( item
.m_mask
& wxLIST_MASK_IMAGE
)
4098 // Reset the buffered height if it's not big enough for the new image.
4099 int image
= item
.GetImage();
4100 if ( m_small_image_list
&& image
!= -1 && InReportView() )
4102 int imageWidth
, imageHeight
;
4103 m_small_image_list
->GetSize(image
, imageWidth
, imageHeight
);
4105 if ( imageHeight
> m_lineHeight
)
4110 m_lines
.Insert( line
, id
);
4114 // If an item is selected at or below the point of insertion, we need to
4115 // increment the member variables because the current row's index has gone
4117 if ( HasCurrent() && m_current
>= id
)
4120 SendNotify(id
, wxEVT_COMMAND_LIST_INSERT_ITEM
);
4122 RefreshLines(id
, GetItemCount() - 1);
4125 void wxListMainWindow::InsertColumn( long col
, const wxListItem
&item
)
4128 if ( InReportView() )
4130 wxListHeaderData
*column
= new wxListHeaderData( item
);
4131 if (item
.m_width
== wxLIST_AUTOSIZE_USEHEADER
)
4132 column
->SetWidth(ComputeMinHeaderWidth(column
));
4134 wxColWidthInfo
*colWidthInfo
= new wxColWidthInfo();
4136 bool insert
= (col
>= 0) && ((size_t)col
< m_columns
.GetCount());
4139 wxListHeaderDataList::compatibility_iterator
4140 node
= m_columns
.Item( col
);
4141 m_columns
.Insert( node
, column
);
4142 m_aColWidths
.Insert( colWidthInfo
, col
);
4146 m_columns
.Append( column
);
4147 m_aColWidths
.Add( colWidthInfo
);
4152 // update all the items
4153 for ( size_t i
= 0; i
< m_lines
.GetCount(); i
++ )
4155 wxListLineData
* const line
= GetLine(i
);
4156 wxListItemData
* const data
= new wxListItemData(this);
4158 line
->m_items
.Insert(col
, data
);
4160 line
->m_items
.Append(data
);
4164 // invalidate it as it has to be recalculated
4169 int wxListMainWindow::GetItemWidthWithImage(wxListItem
* item
)
4172 wxClientDC
dc(this);
4174 dc
.SetFont( GetFont() );
4176 if (item
->GetImage() != -1)
4179 GetImageSize( item
->GetImage(), ix
, iy
);
4183 if (!item
->GetText().empty())
4186 dc
.GetTextExtent( item
->GetText(), &w
, NULL
);
4193 // ----------------------------------------------------------------------------
4195 // ----------------------------------------------------------------------------
4197 static wxListCtrlCompare list_ctrl_compare_func_2
;
4198 static wxIntPtr list_ctrl_compare_data
;
4200 int LINKAGEMODE
list_ctrl_compare_func_1( wxListLineData
**arg1
, wxListLineData
**arg2
)
4202 wxListLineData
*line1
= *arg1
;
4203 wxListLineData
*line2
= *arg2
;
4205 line1
->GetItem( 0, item
);
4206 wxUIntPtr data1
= item
.m_data
;
4207 line2
->GetItem( 0, item
);
4208 wxUIntPtr data2
= item
.m_data
;
4209 return list_ctrl_compare_func_2( data1
, data2
, list_ctrl_compare_data
);
4212 void wxListMainWindow::SortItems( wxListCtrlCompare fn
, wxIntPtr data
)
4214 // selections won't make sense any more after sorting the items so reset
4216 HighlightAll(false);
4219 list_ctrl_compare_func_2
= fn
;
4220 list_ctrl_compare_data
= data
;
4221 m_lines
.Sort( list_ctrl_compare_func_1
);
4225 // ----------------------------------------------------------------------------
4227 // ----------------------------------------------------------------------------
4229 void wxListMainWindow::OnScroll(wxScrollWinEvent
& event
)
4231 // update our idea of which lines are shown when we redraw the window the
4233 ResetVisibleLinesRange();
4235 if ( event
.GetOrientation() == wxHORIZONTAL
&& HasHeader() )
4237 wxGenericListCtrl
* lc
= GetListCtrl();
4238 wxCHECK_RET( lc
, wxT("no listctrl window?") );
4240 if (lc
->m_headerWin
) // when we use wxLC_NO_HEADER, m_headerWin==NULL
4242 lc
->m_headerWin
->Refresh();
4243 lc
->m_headerWin
->Update();
4248 int wxListMainWindow::GetCountPerPage() const
4250 if ( !m_linesPerPage
)
4252 wxConstCast(this, wxListMainWindow
)->
4253 m_linesPerPage
= GetClientSize().y
/ GetLineHeight();
4256 return m_linesPerPage
;
4259 void wxListMainWindow::GetVisibleLinesRange(size_t *from
, size_t *to
)
4261 wxASSERT_MSG( InReportView(), wxT("this is for report mode only") );
4263 if ( m_lineFrom
== (size_t)-1 )
4265 size_t count
= GetItemCount();
4268 m_lineFrom
= GetListCtrl()->GetScrollPos(wxVERTICAL
);
4270 // this may happen if SetScrollbars() hadn't been called yet
4271 if ( m_lineFrom
>= count
)
4272 m_lineFrom
= count
- 1;
4274 // we redraw one extra line but this is needed to make the redrawing
4275 // logic work when there is a fractional number of lines on screen
4276 m_lineTo
= m_lineFrom
+ m_linesPerPage
;
4277 if ( m_lineTo
>= count
)
4278 m_lineTo
= count
- 1;
4280 else // empty control
4283 m_lineTo
= (size_t)-1;
4287 wxASSERT_MSG( IsEmpty() ||
4288 (m_lineFrom
<= m_lineTo
&& m_lineTo
< GetItemCount()),
4289 wxT("GetVisibleLinesRange() returns incorrect result") );
4297 // -------------------------------------------------------------------------------------
4298 // wxGenericListCtrl
4299 // -------------------------------------------------------------------------------------
4301 IMPLEMENT_DYNAMIC_CLASS(wxGenericListCtrl
, wxControl
)
4303 BEGIN_EVENT_TABLE(wxGenericListCtrl
,wxListCtrlBase
)
4304 EVT_SIZE(wxGenericListCtrl::OnSize
)
4305 EVT_SCROLLWIN(wxGenericListCtrl::OnScroll
)
4308 void wxGenericListCtrl::Init()
4310 m_imageListNormal
= NULL
;
4311 m_imageListSmall
= NULL
;
4312 m_imageListState
= NULL
;
4314 m_ownsImageListNormal
=
4315 m_ownsImageListSmall
=
4316 m_ownsImageListState
= false;
4322 wxGenericListCtrl::~wxGenericListCtrl()
4324 if (m_ownsImageListNormal
)
4325 delete m_imageListNormal
;
4326 if (m_ownsImageListSmall
)
4327 delete m_imageListSmall
;
4328 if (m_ownsImageListState
)
4329 delete m_imageListState
;
4332 void wxGenericListCtrl::CreateOrDestroyHeaderWindowAsNeeded()
4334 bool needs_header
= HasHeader();
4335 bool has_header
= (m_headerWin
!= NULL
);
4337 if (needs_header
== has_header
)
4342 m_headerWin
= new wxListHeaderWindow
4344 this, wxID_ANY
, m_mainWin
,
4349 wxRendererNative::Get().GetHeaderButtonHeight(this)
4354 #if defined( __WXMAC__ )
4355 static wxFont
font( wxOSX_SYSTEM_FONT_SMALL
);
4356 m_headerWin
->SetFont( font
);
4359 GetSizer()->Prepend( m_headerWin
, 0, wxGROW
);
4363 GetSizer()->Detach( m_headerWin
);
4365 wxDELETE(m_headerWin
);
4369 bool wxGenericListCtrl::Create(wxWindow
*parent
,
4374 const wxValidator
&validator
,
4375 const wxString
&name
)
4379 // just like in other ports, an assert will fail if the user doesn't give any type style:
4380 wxASSERT_MSG( (style
& wxLC_MASK_TYPE
),
4381 wxT("wxListCtrl style should have exactly one mode bit set") );
4383 if ( !wxListCtrlBase::Create( parent
, id
, pos
, size
,
4384 style
| wxVSCROLL
| wxHSCROLL
,
4389 style
&= ~wxBORDER_MASK
;
4390 style
|= wxBORDER_THEME
;
4393 m_mainWin
= new wxListMainWindow( this, wxID_ANY
, wxPoint(0, 0), size
, style
);
4395 SetTargetWindow( m_mainWin
);
4397 // We use the cursor keys for moving the selection, not scrolling, so call
4398 // this method to ensure wxScrollHelperEvtHandler doesn't catch all
4399 // keyboard events forwarded to us from wxListMainWindow.
4400 DisableKeyboardScrolling();
4402 wxBoxSizer
*sizer
= new wxBoxSizer( wxVERTICAL
);
4403 sizer
->Add( m_mainWin
, 1, wxGROW
);
4406 CreateOrDestroyHeaderWindowAsNeeded();
4408 SetInitialSize(size
);
4413 wxBorder
wxGenericListCtrl::GetDefaultBorder() const
4415 return wxBORDER_THEME
;
4418 #if defined(__WXMSW__) && !defined(__WXWINCE__) && !defined(__WXUNIVERSAL__)
4419 WXLRESULT
wxGenericListCtrl::MSWWindowProc(WXUINT nMsg
,
4423 WXLRESULT rc
= wxListCtrlBase::MSWWindowProc(nMsg
, wParam
, lParam
);
4425 // we need to process arrows ourselves for scrolling
4426 if ( nMsg
== WM_GETDLGCODE
)
4428 rc
|= DLGC_WANTARROWS
;
4435 wxSize
wxGenericListCtrl::GetSizeAvailableForScrollTarget(const wxSize
& size
)
4437 wxSize newsize
= size
;
4439 newsize
.y
-= m_headerWin
->GetSize().y
;
4444 void wxGenericListCtrl::OnScroll(wxScrollWinEvent
& event
)
4446 // update our idea of which lines are shown when we redraw
4447 // the window the next time
4448 m_mainWin
->ResetVisibleLinesRange();
4450 HandleOnScroll( event
);
4452 if ( event
.GetOrientation() == wxHORIZONTAL
&& HasHeader() )
4454 m_headerWin
->Refresh();
4455 m_headerWin
->Update();
4459 void wxGenericListCtrl::SetSingleStyle( long style
, bool add
)
4461 wxASSERT_MSG( !(style
& wxLC_VIRTUAL
),
4462 wxT("wxLC_VIRTUAL can't be [un]set") );
4464 long flag
= GetWindowStyle();
4468 if (style
& wxLC_MASK_TYPE
)
4469 flag
&= ~(wxLC_MASK_TYPE
| wxLC_VIRTUAL
);
4470 if (style
& wxLC_MASK_ALIGN
)
4471 flag
&= ~wxLC_MASK_ALIGN
;
4472 if (style
& wxLC_MASK_SORT
)
4473 flag
&= ~wxLC_MASK_SORT
;
4481 // some styles can be set without recreating everything (as happens in
4482 // SetWindowStyleFlag() which calls wxListMainWindow::DeleteEverything())
4483 if ( !(style
& ~(wxLC_HRULES
| wxLC_VRULES
)) )
4486 wxWindow::SetWindowStyleFlag(flag
);
4490 SetWindowStyleFlag( flag
);
4494 void wxGenericListCtrl::SetWindowStyleFlag( long flag
)
4496 // we add wxHSCROLL and wxVSCROLL in ctor unconditionally and it never
4497 // makes sense to remove them as we'll always add scrollbars anyhow when
4499 flag
|= wxHSCROLL
| wxVSCROLL
;
4501 const bool wasInReportView
= HasFlag(wxLC_REPORT
);
4503 // update the window style first so that the header is created or destroyed
4504 // corresponding to the new style
4505 wxWindow::SetWindowStyleFlag( flag
);
4509 const bool inReportView
= (flag
& wxLC_REPORT
) != 0;
4510 if ( inReportView
!= wasInReportView
)
4512 // we need to notify the main window about this change as it must
4513 // update its data structures
4514 m_mainWin
->SetReportView(inReportView
);
4517 // m_mainWin->DeleteEverything(); wxMSW doesn't do that
4519 CreateOrDestroyHeaderWindowAsNeeded();
4521 GetSizer()->Layout();
4525 bool wxGenericListCtrl::GetColumn(int col
, wxListItem
&item
) const
4527 m_mainWin
->GetColumn( col
, item
);
4531 bool wxGenericListCtrl::SetColumn( int col
, const wxListItem
& item
)
4533 m_mainWin
->SetColumn( col
, item
);
4537 int wxGenericListCtrl::GetColumnWidth( int col
) const
4539 return m_mainWin
->GetColumnWidth( col
);
4542 bool wxGenericListCtrl::SetColumnWidth( int col
, int width
)
4544 m_mainWin
->SetColumnWidth( col
, width
);
4548 int wxGenericListCtrl::GetCountPerPage() const
4550 return m_mainWin
->GetCountPerPage(); // different from Windows ?
4553 bool wxGenericListCtrl::GetItem( wxListItem
&info
) const
4555 m_mainWin
->GetItem( info
);
4559 bool wxGenericListCtrl::SetItem( wxListItem
&info
)
4561 m_mainWin
->SetItem( info
);
4565 long wxGenericListCtrl::SetItem( long index
, int col
, const wxString
& label
, int imageId
)
4568 info
.m_text
= label
;
4569 info
.m_mask
= wxLIST_MASK_TEXT
;
4570 info
.m_itemId
= index
;
4574 info
.m_image
= imageId
;
4575 info
.m_mask
|= wxLIST_MASK_IMAGE
;
4578 m_mainWin
->SetItem(info
);
4582 int wxGenericListCtrl::GetItemState( long item
, long stateMask
) const
4584 return m_mainWin
->GetItemState( item
, stateMask
);
4587 bool wxGenericListCtrl::SetItemState( long item
, long state
, long stateMask
)
4589 m_mainWin
->SetItemState( item
, state
, stateMask
);
4594 wxGenericListCtrl::SetItemImage( long item
, int image
, int WXUNUSED(selImage
) )
4596 return SetItemColumnImage(item
, 0, image
);
4600 wxGenericListCtrl::SetItemColumnImage( long item
, long column
, int image
)
4603 info
.m_image
= image
;
4604 info
.m_mask
= wxLIST_MASK_IMAGE
;
4605 info
.m_itemId
= item
;
4606 info
.m_col
= column
;
4607 m_mainWin
->SetItem( info
);
4611 wxString
wxGenericListCtrl::GetItemText( long item
, int col
) const
4613 return m_mainWin
->GetItemText(item
, col
);
4616 void wxGenericListCtrl::SetItemText( long item
, const wxString
& str
)
4618 m_mainWin
->SetItemText(item
, str
);
4621 wxUIntPtr
wxGenericListCtrl::GetItemData( long item
) const
4624 info
.m_mask
= wxLIST_MASK_DATA
;
4625 info
.m_itemId
= item
;
4626 m_mainWin
->GetItem( info
);
4630 bool wxGenericListCtrl::SetItemPtrData( long item
, wxUIntPtr data
)
4633 info
.m_mask
= wxLIST_MASK_DATA
;
4634 info
.m_itemId
= item
;
4636 m_mainWin
->SetItem( info
);
4640 wxRect
wxGenericListCtrl::GetViewRect() const
4642 return m_mainWin
->GetViewRect();
4645 bool wxGenericListCtrl::GetItemRect(long item
, wxRect
& rect
, int code
) const
4647 return GetSubItemRect(item
, wxLIST_GETSUBITEMRECT_WHOLEITEM
, rect
, code
);
4650 bool wxGenericListCtrl::GetSubItemRect(long item
,
4653 int WXUNUSED(code
)) const
4655 if ( !m_mainWin
->GetSubItemRect( item
, subItem
, rect
) )
4658 if ( m_mainWin
->HasHeader() )
4659 rect
.y
+= m_headerWin
->GetSize().y
+ 1;
4664 bool wxGenericListCtrl::GetItemPosition( long item
, wxPoint
& pos
) const
4666 m_mainWin
->GetItemPosition( item
, pos
);
4670 bool wxGenericListCtrl::SetItemPosition( long WXUNUSED(item
), const wxPoint
& WXUNUSED(pos
) )
4675 int wxGenericListCtrl::GetItemCount() const
4677 return m_mainWin
->GetItemCount();
4680 int wxGenericListCtrl::GetColumnCount() const
4682 return m_mainWin
->GetColumnCount();
4685 void wxGenericListCtrl::SetItemSpacing( int spacing
, bool isSmall
)
4687 m_mainWin
->SetItemSpacing( spacing
, isSmall
);
4690 wxSize
wxGenericListCtrl::GetItemSpacing() const
4692 const int spacing
= m_mainWin
->GetItemSpacing(HasFlag(wxLC_SMALL_ICON
));
4694 return wxSize(spacing
, spacing
);
4697 #if WXWIN_COMPATIBILITY_2_6
4698 int wxGenericListCtrl::GetItemSpacing( bool isSmall
) const
4700 return m_mainWin
->GetItemSpacing( isSmall
);
4702 #endif // WXWIN_COMPATIBILITY_2_6
4704 void wxGenericListCtrl::SetItemTextColour( long item
, const wxColour
&col
)
4707 info
.m_itemId
= item
;
4708 info
.SetTextColour( col
);
4709 m_mainWin
->SetItem( info
);
4712 wxColour
wxGenericListCtrl::GetItemTextColour( long item
) const
4715 info
.m_itemId
= item
;
4716 m_mainWin
->GetItem( info
);
4717 return info
.GetTextColour();
4720 void wxGenericListCtrl::SetItemBackgroundColour( long item
, const wxColour
&col
)
4723 info
.m_itemId
= item
;
4724 info
.SetBackgroundColour( col
);
4725 m_mainWin
->SetItem( info
);
4728 wxColour
wxGenericListCtrl::GetItemBackgroundColour( long item
) const
4731 info
.m_itemId
= item
;
4732 m_mainWin
->GetItem( info
);
4733 return info
.GetBackgroundColour();
4736 void wxGenericListCtrl::SetItemFont( long item
, const wxFont
&f
)
4739 info
.m_itemId
= item
;
4741 m_mainWin
->SetItem( info
);
4744 wxFont
wxGenericListCtrl::GetItemFont( long item
) const
4747 info
.m_itemId
= item
;
4748 m_mainWin
->GetItem( info
);
4749 return info
.GetFont();
4752 int wxGenericListCtrl::GetSelectedItemCount() const
4754 return m_mainWin
->GetSelectedItemCount();
4757 wxColour
wxGenericListCtrl::GetTextColour() const
4759 return GetForegroundColour();
4762 void wxGenericListCtrl::SetTextColour(const wxColour
& col
)
4764 SetForegroundColour(col
);
4767 long wxGenericListCtrl::GetTopItem() const
4770 m_mainWin
->GetVisibleLinesRange(&top
, NULL
);
4774 long wxGenericListCtrl::GetNextItem( long item
, int geom
, int state
) const
4776 return m_mainWin
->GetNextItem( item
, geom
, state
);
4779 wxImageList
*wxGenericListCtrl::GetImageList(int which
) const
4781 if (which
== wxIMAGE_LIST_NORMAL
)
4782 return m_imageListNormal
;
4783 else if (which
== wxIMAGE_LIST_SMALL
)
4784 return m_imageListSmall
;
4785 else if (which
== wxIMAGE_LIST_STATE
)
4786 return m_imageListState
;
4791 void wxGenericListCtrl::SetImageList( wxImageList
*imageList
, int which
)
4793 if ( which
== wxIMAGE_LIST_NORMAL
)
4795 if (m_ownsImageListNormal
)
4796 delete m_imageListNormal
;
4797 m_imageListNormal
= imageList
;
4798 m_ownsImageListNormal
= false;
4800 else if ( which
== wxIMAGE_LIST_SMALL
)
4802 if (m_ownsImageListSmall
)
4803 delete m_imageListSmall
;
4804 m_imageListSmall
= imageList
;
4805 m_ownsImageListSmall
= false;
4807 else if ( which
== wxIMAGE_LIST_STATE
)
4809 if (m_ownsImageListState
)
4810 delete m_imageListState
;
4811 m_imageListState
= imageList
;
4812 m_ownsImageListState
= false;
4815 m_mainWin
->SetImageList( imageList
, which
);
4818 void wxGenericListCtrl::AssignImageList(wxImageList
*imageList
, int which
)
4820 SetImageList(imageList
, which
);
4821 if ( which
== wxIMAGE_LIST_NORMAL
)
4822 m_ownsImageListNormal
= true;
4823 else if ( which
== wxIMAGE_LIST_SMALL
)
4824 m_ownsImageListSmall
= true;
4825 else if ( which
== wxIMAGE_LIST_STATE
)
4826 m_ownsImageListState
= true;
4829 bool wxGenericListCtrl::Arrange( int WXUNUSED(flag
) )
4834 bool wxGenericListCtrl::DeleteItem( long item
)
4836 m_mainWin
->DeleteItem( item
);
4840 bool wxGenericListCtrl::DeleteAllItems()
4842 m_mainWin
->DeleteAllItems();
4846 bool wxGenericListCtrl::DeleteAllColumns()
4848 size_t count
= m_mainWin
->m_columns
.GetCount();
4849 for ( size_t n
= 0; n
< count
; n
++ )
4854 void wxGenericListCtrl::ClearAll()
4856 m_mainWin
->DeleteEverything();
4859 bool wxGenericListCtrl::DeleteColumn( int col
)
4861 m_mainWin
->DeleteColumn( col
);
4863 // if we don't have the header any longer, we need to relayout the window
4864 // if ( !GetColumnCount() )
4867 // Ensure that the non-existent columns are really removed from display.
4873 wxTextCtrl
*wxGenericListCtrl::EditLabel(long item
,
4874 wxClassInfo
* textControlClass
)
4876 return m_mainWin
->EditLabel( item
, textControlClass
);
4879 wxTextCtrl
*wxGenericListCtrl::GetEditControl() const
4881 return m_mainWin
->GetEditControl();
4884 bool wxGenericListCtrl::EnsureVisible( long item
)
4886 m_mainWin
->EnsureVisible( item
);
4890 long wxGenericListCtrl::FindItem( long start
, const wxString
& str
, bool partial
)
4892 return m_mainWin
->FindItem( start
, str
, partial
);
4895 long wxGenericListCtrl::FindItem( long start
, wxUIntPtr data
)
4897 return m_mainWin
->FindItem( start
, data
);
4900 long wxGenericListCtrl::FindItem( long WXUNUSED(start
), const wxPoint
& pt
,
4901 int WXUNUSED(direction
))
4903 return m_mainWin
->FindItem( pt
);
4906 // TODO: sub item hit testing
4907 long wxGenericListCtrl::HitTest(const wxPoint
& point
, int& flags
, long *) const
4909 return m_mainWin
->HitTest( (int)point
.x
, (int)point
.y
, flags
);
4912 long wxGenericListCtrl::InsertItem( wxListItem
& info
)
4914 m_mainWin
->InsertItem( info
);
4915 return info
.m_itemId
;
4918 long wxGenericListCtrl::InsertItem( long index
, const wxString
&label
)
4921 info
.m_text
= label
;
4922 info
.m_mask
= wxLIST_MASK_TEXT
;
4923 info
.m_itemId
= index
;
4924 return InsertItem( info
);
4927 long wxGenericListCtrl::InsertItem( long index
, int imageIndex
)
4930 info
.m_mask
= wxLIST_MASK_IMAGE
;
4931 info
.m_image
= imageIndex
;
4932 info
.m_itemId
= index
;
4933 return InsertItem( info
);
4936 long wxGenericListCtrl::InsertItem( long index
, const wxString
&label
, int imageIndex
)
4939 info
.m_text
= label
;
4940 info
.m_image
= imageIndex
;
4941 info
.m_mask
= wxLIST_MASK_TEXT
;
4942 if (imageIndex
> -1)
4943 info
.m_mask
|= wxLIST_MASK_IMAGE
;
4944 info
.m_itemId
= index
;
4945 return InsertItem( info
);
4948 long wxGenericListCtrl::DoInsertColumn( long col
, const wxListItem
&item
)
4950 wxCHECK_MSG( InReportView(), -1, wxT("can't add column in non report mode") );
4952 m_mainWin
->InsertColumn( col
, item
);
4954 // NOTE: if wxLC_NO_HEADER was given, then we are in report view mode but
4955 // still have m_headerWin==NULL
4957 m_headerWin
->Refresh();
4962 bool wxGenericListCtrl::ScrollList( int dx
, int dy
)
4964 return m_mainWin
->ScrollList(dx
, dy
);
4968 // fn is a function which takes 3 long arguments: item1, item2, data.
4969 // item1 is the long data associated with a first item (NOT the index).
4970 // item2 is the long data associated with a second item (NOT the index).
4971 // data is the same value as passed to SortItems.
4972 // The return value is a negative number if the first item should precede the second
4973 // item, a positive number of the second item should precede the first,
4974 // or zero if the two items are equivalent.
4975 // data is arbitrary data to be passed to the sort function.
4977 bool wxGenericListCtrl::SortItems( wxListCtrlCompare fn
, wxIntPtr data
)
4979 m_mainWin
->SortItems( fn
, data
);
4983 // ----------------------------------------------------------------------------
4985 // ----------------------------------------------------------------------------
4987 void wxGenericListCtrl::OnSize(wxSizeEvent
& WXUNUSED(event
))
4989 if (!m_mainWin
) return;
4991 // We need to override OnSize so that our scrolled
4992 // window a) does call Layout() to use sizers for
4993 // positioning the controls but b) does not query
4994 // the sizer for their size and use that for setting
4995 // the scrollable area as set that ourselves by
4996 // calling SetScrollbar() further down.
5000 m_mainWin
->RecalculatePositions();
5005 void wxGenericListCtrl::OnInternalIdle()
5007 wxWindow::OnInternalIdle();
5009 if (m_mainWin
->m_dirty
)
5010 m_mainWin
->RecalculatePositions();
5013 // ----------------------------------------------------------------------------
5015 // ----------------------------------------------------------------------------
5017 bool wxGenericListCtrl::SetBackgroundColour( const wxColour
&colour
)
5021 m_mainWin
->SetBackgroundColour( colour
);
5022 m_mainWin
->m_dirty
= true;
5028 bool wxGenericListCtrl::SetForegroundColour( const wxColour
&colour
)
5030 if ( !wxWindow::SetForegroundColour( colour
) )
5035 m_mainWin
->SetForegroundColour( colour
);
5036 m_mainWin
->m_dirty
= true;
5040 m_headerWin
->SetForegroundColour( colour
);
5045 bool wxGenericListCtrl::SetFont( const wxFont
&font
)
5047 if ( !wxWindow::SetFont( font
) )
5052 m_mainWin
->SetFont( font
);
5053 m_mainWin
->m_dirty
= true;
5058 m_headerWin
->SetFont( font
);
5059 // CalculateAndSetHeaderHeight();
5069 wxGenericListCtrl::GetClassDefaultAttributes(wxWindowVariant variant
)
5072 // Use the same color scheme as wxListBox
5073 return wxListBox::GetClassDefaultAttributes(variant
);
5075 wxUnusedVar(variant
);
5076 wxVisualAttributes attr
;
5077 attr
.colFg
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOXTEXT
);
5078 attr
.colBg
= wxSystemSettings::GetColour(wxSYS_COLOUR_LISTBOX
);
5079 attr
.font
= wxSystemSettings::GetFont(wxSYS_DEFAULT_GUI_FONT
);
5084 // ----------------------------------------------------------------------------
5085 // methods forwarded to m_mainWin
5086 // ----------------------------------------------------------------------------
5088 #if wxUSE_DRAG_AND_DROP
5090 void wxGenericListCtrl::SetDropTarget( wxDropTarget
*dropTarget
)
5092 m_mainWin
->SetDropTarget( dropTarget
);
5095 wxDropTarget
*wxGenericListCtrl::GetDropTarget() const
5097 return m_mainWin
->GetDropTarget();
5102 bool wxGenericListCtrl::SetCursor( const wxCursor
&cursor
)
5104 return m_mainWin
? m_mainWin
->wxWindow::SetCursor(cursor
) : false;
5107 wxColour
wxGenericListCtrl::GetBackgroundColour() const
5109 return m_mainWin
? m_mainWin
->GetBackgroundColour() : wxColour();
5112 wxColour
wxGenericListCtrl::GetForegroundColour() const
5114 return m_mainWin
? m_mainWin
->GetForegroundColour() : wxColour();
5117 bool wxGenericListCtrl::DoPopupMenu( wxMenu
*menu
, int x
, int y
)
5120 return m_mainWin
->PopupMenu( menu
, x
, y
);
5126 void wxGenericListCtrl::DoClientToScreen( int *x
, int *y
) const
5128 // It's not clear whether this can be called before m_mainWin is created
5129 // but it seems better to be on the safe side and check.
5131 m_mainWin
->DoClientToScreen(x
, y
);
5133 wxListCtrlBase::DoClientToScreen(x
, y
);
5136 void wxGenericListCtrl::DoScreenToClient( int *x
, int *y
) const
5138 // At least in wxGTK/Univ build this method can be called before m_mainWin
5139 // is created so avoid crashes in this case.
5141 m_mainWin
->DoScreenToClient(x
, y
);
5143 wxListCtrlBase::DoScreenToClient(x
, y
);
5146 void wxGenericListCtrl::SetFocus()
5148 // The test in window.cpp fails as we are a composite
5149 // window, so it checks against "this", but not m_mainWin.
5150 if ( DoFindFocus() != this )
5151 m_mainWin
->SetFocus();
5154 wxSize
wxGenericListCtrl::DoGetBestClientSize() const
5156 // Something is better than nothing even if this is completely arbitrary.
5157 wxSize
sizeBest(100, 80);
5159 if ( !InReportView() )
5161 // Ensure that our minimal width is at least big enough to show all our
5162 // items. This is important for wxListbook to size itself correctly.
5164 // Remember the offset of the first item: this corresponds to the
5165 // margins around the item so we will add it to the minimal size below
5166 // to ensure that we have equal margins on all sides.
5169 // We can iterate over all items as there shouldn't be too many of them
5170 // in non-report view. If it ever becomes a problem, we could examine
5171 // just the first few items probably, the determination of the best
5172 // size is less important if we will need scrollbars anyhow.
5173 for ( int n
= 0; n
< GetItemCount(); n
++ )
5175 const wxRect itemRect
= m_mainWin
->GetLineRect(n
);
5178 // Remember the position of the first item as all the rest are
5179 // offset by at least this number of pixels too.
5180 ofs
= itemRect
.GetPosition();
5183 sizeBest
.IncTo(itemRect
.GetSize());
5186 sizeBest
.IncBy(2*ofs
);
5189 // If we have the scrollbars we need to account for them too. And to
5190 // make sure the scrollbars status is up to date we need to call this
5191 // function to set them.
5192 m_mainWin
->RecalculatePositions(true /* no refresh */);
5194 // Unfortunately we can't use wxWindow::HasScrollbar() here as we need
5195 // to use m_mainWin client/virtual size for determination of whether we
5196 // use scrollbars and not the size of this window itself. Maybe that
5197 // function should be extended to work correctly in the case when our
5198 // scrollbars manage a different window from this one but currently it
5200 const wxSize sizeClient
= m_mainWin
->GetClientSize();
5201 const wxSize sizeVirt
= m_mainWin
->GetVirtualSize();
5203 if ( sizeVirt
.x
> sizeClient
.x
/* HasScrollbar(wxHORIZONTAL) */ )
5204 sizeBest
.y
+= wxSystemSettings::GetMetric(wxSYS_HSCROLL_Y
);
5206 if ( sizeVirt
.y
> sizeClient
.y
/* HasScrollbar(wxVERTICAL) */ )
5207 sizeBest
.x
+= wxSystemSettings::GetMetric(wxSYS_VSCROLL_X
);
5213 // ----------------------------------------------------------------------------
5214 // virtual list control support
5215 // ----------------------------------------------------------------------------
5217 wxString
wxGenericListCtrl::OnGetItemText(long WXUNUSED(item
), long WXUNUSED(col
)) const
5219 // this is a pure virtual function, in fact - which is not really pure
5220 // because the controls which are not virtual don't need to implement it
5221 wxFAIL_MSG( wxT("wxGenericListCtrl::OnGetItemText not supposed to be called") );
5223 return wxEmptyString
;
5226 int wxGenericListCtrl::OnGetItemImage(long WXUNUSED(item
)) const
5228 wxCHECK_MSG(!GetImageList(wxIMAGE_LIST_SMALL
),
5230 wxT("List control has an image list, OnGetItemImage or OnGetItemColumnImage should be overridden."));
5234 int wxGenericListCtrl::OnGetItemColumnImage(long item
, long column
) const
5237 return OnGetItemImage(item
);
5243 wxGenericListCtrl::OnGetItemAttr(long WXUNUSED_UNLESS_DEBUG(item
)) const
5245 wxASSERT_MSG( item
>= 0 && item
< GetItemCount(),
5246 wxT("invalid item index in OnGetItemAttr()") );
5248 // no attributes by default
5252 void wxGenericListCtrl::SetItemCount(long count
)
5254 wxASSERT_MSG( IsVirtual(), wxT("this is for virtual controls only") );
5256 m_mainWin
->SetItemCount(count
);
5259 void wxGenericListCtrl::RefreshItem(long item
)
5261 m_mainWin
->RefreshLine(item
);
5264 void wxGenericListCtrl::RefreshItems(long itemFrom
, long itemTo
)
5266 m_mainWin
->RefreshLines(itemFrom
, itemTo
);
5269 // Generic wxListCtrl is more or less a container for two other
5270 // windows which drawings are done upon. These are namely
5271 // 'm_headerWin' and 'm_mainWin'.
5272 // Here we override 'virtual wxWindow::Refresh()' to mimic the
5273 // behaviour wxListCtrl has under wxMSW.
5275 void wxGenericListCtrl::Refresh(bool eraseBackground
, const wxRect
*rect
)
5279 // The easy case, no rectangle specified.
5281 m_headerWin
->Refresh(eraseBackground
);
5284 m_mainWin
->Refresh(eraseBackground
);
5288 // Refresh the header window
5291 wxRect rectHeader
= m_headerWin
->GetRect();
5292 rectHeader
.Intersect(*rect
);
5293 if (rectHeader
.GetWidth() && rectHeader
.GetHeight())
5296 m_headerWin
->GetPosition(&x
, &y
);
5297 rectHeader
.Offset(-x
, -y
);
5298 m_headerWin
->Refresh(eraseBackground
, &rectHeader
);
5302 // Refresh the main window
5305 wxRect rectMain
= m_mainWin
->GetRect();
5306 rectMain
.Intersect(*rect
);
5307 if (rectMain
.GetWidth() && rectMain
.GetHeight())
5310 m_mainWin
->GetPosition(&x
, &y
);
5311 rectMain
.Offset(-x
, -y
);
5312 m_mainWin
->Refresh(eraseBackground
, &rectMain
);
5318 void wxGenericListCtrl::Update()
5322 if ( m_mainWin
->m_dirty
)
5323 m_mainWin
->RecalculatePositions();
5325 m_mainWin
->Update();
5329 m_headerWin
->Update();
5332 #endif // wxUSE_LISTCTRL