include/wx/generic/private/listctrl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        listctrl.h
   3 // Purpose:     private definitions of wxListCtrl helpers
   4 // Author:      Robert Roebling
   5 //              Vadim Zeitlin (virtual list control support)
   6 // Id:          $Id$
   7 // Copyright:   (c) 1998 Robert Roebling
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_GENERIC_LISTCTRL_PRIVATE_H_
  12 #define _WX_GENERIC_LISTCTRL_PRIVATE_H_
  13
  14 #include "wx/defs.h"
  15
  16 #if wxUSE_LISTCTRL
  17
  18 #include "wx/listctrl.h"
  19 #include "wx/selstore.h"
  20 #include "wx/timer.h"
  21 #include "wx/settings.h"
  22
  23 // ============================================================================
  24 // private classes
  25 // ============================================================================
  26
  27 //-----------------------------------------------------------------------------
  28 //  wxColWidthInfo (internal)
  29 //-----------------------------------------------------------------------------
  30
  31 struct wxColWidthInfo
  32 {
  33     int     nMaxWidth;
  34     bool    bNeedsUpdate;   //  only set to true when an item whose
  35                             //  width == nMaxWidth is removed
  36
  37     wxColWidthInfo(int w = 0, bool needsUpdate = false)
  38     {
  39         nMaxWidth = w;
  40         bNeedsUpdate = needsUpdate;
  41     }
  42 };
  43
  44 WX_DEFINE_ARRAY_PTR(wxColWidthInfo *, ColWidthArray);
  45
  46 //-----------------------------------------------------------------------------
  47 //  wxListItemData (internal)
  48 //-----------------------------------------------------------------------------
  49
  50 class wxListItemData
  51 {
  52 public:
  53     wxListItemData(wxListMainWindow *owner);
  54     ~wxListItemData();
  55
  56     void SetItem( const wxListItem &info );
  57     void SetImage( int image ) { m_image = image; }
  58     void SetData( wxUIntPtr data ) { m_data = data; }
  59     void SetPosition( int x, int y );
  60     void SetSize( int width, int height );
  61
  62     bool HasText() const { return !m_text.empty(); }
  63     const wxString& GetText() const { return m_text; }
  64     void SetText(const wxString& text) { m_text = text; }
  65
  66     // we can't use empty string for measuring the string width/height, so
  67     // always return something
  68     wxString GetTextForMeasuring() const
  69     {
  70         wxString s = GetText();
  71         if ( s.empty() )
  72             s = wxT('H');
  73
  74         return s;
  75     }
  76
  77     bool IsHit( int x, int y ) const;
  78
  79     int GetX() const;
  80     int GetY() const;
  81     int GetWidth() const;
  82     int GetHeight() const;
  83
  84     int GetImage() const { return m_image; }
  85     bool HasImage() const { return GetImage() != -1; }
  86
  87     void GetItem( wxListItem &info ) const;
  88
  89     void SetAttr(wxListItemAttr *attr) { m_attr = attr; }
  90     wxListItemAttr *GetAttr() const { return m_attr; }
  91
  92 public:
  93     // the item image or -1
  94     int m_image;
  95
  96     // user data associated with the item
  97     wxUIntPtr m_data;
  98
  99     // the item coordinates are not used in report mode; instead this pointer is
 100     // NULL and the owner window is used to retrieve the item position and size
 101     wxRect *m_rect;
 102
 103     // the list ctrl we are in
 104     wxListMainWindow *m_owner;
 105
 106     // custom attributes or NULL
 107     wxListItemAttr *m_attr;
 108
 109 protected:
 110     // common part of all ctors
 111     void Init();
 112
 113     wxString m_text;
 114 };
 115
 116 //-----------------------------------------------------------------------------
 117 //  wxListHeaderData (internal)
 118 //-----------------------------------------------------------------------------
 119
 120 class wxListHeaderData : public wxObject
 121 {
 122 public:
 123     wxListHeaderData();
 124     wxListHeaderData( const wxListItem &info );
 125     void SetItem( const wxListItem &item );
 126     void SetPosition( int x, int y );
 127     void SetWidth( int w );
 128     void SetState( int state );
 129     void SetFormat( int format );
 130     void SetHeight( int h );
 131     bool HasImage() const;
 132
 133     bool HasText() const { return !m_text.empty(); }
 134     const wxString& GetText() const { return m_text; }
 135     void SetText(const wxString& text) { m_text = text; }
 136
 137     void GetItem( wxListItem &item );
 138
 139     bool IsHit( int x, int y ) const;
 140     int GetImage() const;
 141     int GetWidth() const;
 142     int GetFormat() const;
 143     int GetState() const;
 144
 145 protected:
 146     long      m_mask;
 147     int       m_image;
 148     wxString  m_text;
 149     int       m_format;
 150     int       m_width;
 151     int       m_xpos,
 152               m_ypos;
 153     int       m_height;
 154     int       m_state;
 155
 156 private:
 157     void Init();
 158 };
 159
 160 //-----------------------------------------------------------------------------
 161 //  wxListLineData (internal)
 162 //-----------------------------------------------------------------------------
 163
 164 WX_DECLARE_LIST(wxListItemData, wxListItemDataList);
 165
 166 class wxListLineData
 167 {
 168 public:
 169     // the list of subitems: only may have more than one item in report mode
 170     wxListItemDataList m_items;
 171
 172     // this is not used in report view
 173     struct GeometryInfo
 174     {
 175         // total item rect
 176         wxRect m_rectAll;
 177
 178         // label only
 179         wxRect m_rectLabel;
 180
 181         // icon only
 182         wxRect m_rectIcon;
 183
 184         // the part to be highlighted
 185         wxRect m_rectHighlight;
 186
 187         // extend all our rects to be centered inside the one of given width
 188         void ExtendWidth(wxCoord w)
 189         {
 190             wxASSERT_MSG( m_rectAll.width <= w,
 191                             wxT("width can only be increased") );
 192
 193             m_rectAll.width = w;
 194             m_rectLabel.x = m_rectAll.x + (w - m_rectLabel.width) / 2;
 195             m_rectIcon.x = m_rectAll.x + (w - m_rectIcon.width) / 2;
 196             m_rectHighlight.x = m_rectAll.x + (w - m_rectHighlight.width) / 2;
 197         }
 198     }
 199     *m_gi;
 200
 201     // is this item selected? [NB: not used in virtual mode]
 202     bool m_highlighted;
 203
 204     // back pointer to the list ctrl
 205     wxListMainWindow *m_owner;
 206
 207 public:
 208     wxListLineData(wxListMainWindow *owner);
 209
 210     ~wxListLineData()
 211     {
 212         WX_CLEAR_LIST(wxListItemDataList, m_items);
 213         delete m_gi;
 214     }
 215
 216     // called by the owner when it toggles report view
 217     void SetReportView(bool inReportView)
 218     {
 219         // we only need m_gi when we're not in report view so update as needed
 220         if ( inReportView )
 221         {
 222             delete m_gi;
 223             m_gi = NULL;
 224         }
 225         else
 226         {
 227             m_gi = new GeometryInfo;
 228         }
 229     }
 230
 231     // are we in report mode?
 232     inline bool InReportView() const;
 233
 234     // are we in virtual report mode?
 235     inline bool IsVirtual() const;
 236
 237     // these 2 methods shouldn't be called for report view controls, in that
 238     // case we determine our position/size ourselves
 239
 240     // calculate the size of the line
 241     void CalculateSize( wxDC *dc, int spacing );
 242
 243     // remember the position this line appears at
 244     void SetPosition( int x, int y, int spacing );
 245
 246     // wxListCtrl API
 247
 248     void SetImage( int image ) { SetImage(0, image); }
 249     int GetImage() const { return GetImage(0); }
 250     void SetImage( int index, int image );
 251     int GetImage( int index ) const;
 252
 253     bool HasImage() const { return GetImage() != -1; }
 254     bool HasText() const { return !GetText(0).empty(); }
 255
 256     void SetItem( int index, const wxListItem &info );
 257     void GetItem( int index, wxListItem &info );
 258
 259     wxString GetText(int index) const;
 260     void SetText( int index, const wxString& s );
 261
 262     wxListItemAttr *GetAttr() const;
 263     void SetAttr(wxListItemAttr *attr);
 264
 265     // return true if the highlighting really changed
 266     bool Highlight( bool on );
 267
 268     void ReverseHighlight();
 269
 270     bool IsHighlighted() const
 271     {
 272         wxASSERT_MSG( !IsVirtual(), wxT("unexpected call to IsHighlighted") );
 273
 274         return m_highlighted;
 275     }
 276
 277     // draw the line on the given DC in icon/list mode
 278     void Draw( wxDC *dc, bool current );
 279
 280     // the same in report mode: it needs more parameters as we don't store
 281     // everything in the item in report mode
 282     void DrawInReportMode( wxDC *dc,
 283                            const wxRect& rect,
 284                            const wxRect& rectHL,
 285                            bool highlighted,
 286                            bool current );
 287
 288 private:
 289     // set the line to contain num items (only can be > 1 in report mode)
 290     void InitItems( int num );
 291
 292     // get the mode (i.e. style)  of the list control
 293     inline int GetMode() const;
 294
 295     // Apply this item attributes to the given DC: set the text font and colour
 296     // and also erase the background appropriately.
 297     void ApplyAttributes(wxDC *dc,
 298                          const wxRect& rectHL,
 299                          bool highlighted,
 300                          bool current);
 301
 302     // draw the text on the DC with the correct justification; also add an
 303     // ellipsis if the text is too large to fit in the current width
 304     void DrawTextFormatted(wxDC *dc,
 305                            const wxString &text,
 306                            int col,
 307                            int x,
 308                            int yMid,    // this is middle, not top, of the text
 309                            int width);
 310 };
 311
 312 WX_DECLARE_OBJARRAY(wxListLineData, wxListLineDataArray);
 313
 314 //-----------------------------------------------------------------------------
 315 //  wxListHeaderWindow (internal)
 316 //-----------------------------------------------------------------------------
 317
 318 class wxListHeaderWindow : public wxWindow
 319 {
 320 protected:
 321     wxListMainWindow  *m_owner;
 322     const wxCursor    *m_currentCursor;
 323     wxCursor          *m_resizeCursor;
 324     bool               m_isDragging;
 325
 326     // column being resized or -1
 327     int m_column;
 328
 329     // divider line position in logical (unscrolled) coords
 330     int m_currentX;
 331
 332     // minimal position beyond which the divider line
 333     // can't be dragged in logical coords
 334     int m_minX;
 335
 336 public:
 337     wxListHeaderWindow();
 338
 339     wxListHeaderWindow( wxWindow *win,
 340                         wxWindowID id,
 341                         wxListMainWindow *owner,
 342                         const wxPoint &pos = wxDefaultPosition,
 343                         const wxSize &size = wxDefaultSize,
 344                         long style = 0,
 345                         const wxString &name = wxT("wxlistctrlcolumntitles") );
 346
 347     virtual ~wxListHeaderWindow();
 348
 349     void DrawCurrent();
 350     void AdjustDC( wxDC& dc );
 351
 352     void OnPaint( wxPaintEvent &event );
 353     void OnMouse( wxMouseEvent &event );
 354     void OnSetFocus( wxFocusEvent &event );
 355
 356     // needs refresh
 357     bool m_dirty;
 358
 359     // Update main window's column later
 360     bool m_sendSetColumnWidth;
 361     int m_colToSend;
 362     int m_widthToSend;
 363
 364     virtual void OnInternalIdle();
 365
 366 private:
 367     // common part of all ctors
 368     void Init();
 369
 370     // generate and process the list event of the given type, return true if
 371     // it wasn't vetoed, i.e. if we should proceed
 372     bool SendListEvent(wxEventType type, const wxPoint& pos);
 373
 374     DECLARE_EVENT_TABLE()
 375 };
 376
 377 //-----------------------------------------------------------------------------
 378 // wxListRenameTimer (internal)
 379 //-----------------------------------------------------------------------------
 380
 381 class wxListRenameTimer: public wxTimer
 382 {
 383 private:
 384     wxListMainWindow *m_owner;
 385
 386 public:
 387     wxListRenameTimer( wxListMainWindow *owner );
 388     void Notify();
 389 };
 390
 391 //-----------------------------------------------------------------------------
 392 // wxListTextCtrlWrapper: wraps a wxTextCtrl to make it work for inline editing
 393 //-----------------------------------------------------------------------------
 394
 395 class wxListTextCtrlWrapper : public wxEvtHandler
 396 {
 397 public:
 398     // NB: text must be a valid object but not Create()d yet
 399     wxListTextCtrlWrapper(wxListMainWindow *owner,
 400                           wxTextCtrl *text,
 401                           size_t itemEdit);
 402
 403     wxTextCtrl *GetText() const { return m_text; }
 404
 405     void EndEdit( bool discardChanges );
 406
 407 protected:
 408     void OnChar( wxKeyEvent &event );
 409     void OnKeyUp( wxKeyEvent &event );
 410     void OnKillFocus( wxFocusEvent &event );
 411
 412     bool AcceptChanges();
 413     void Finish( bool setfocus );
 414
 415 private:
 416     wxListMainWindow   *m_owner;
 417     wxTextCtrl         *m_text;
 418     wxString            m_startValue;
 419     size_t              m_itemEdited;
 420     bool                m_aboutToFinish;
 421
 422     DECLARE_EVENT_TABLE()
 423 };
 424
 425 //-----------------------------------------------------------------------------
 426 //  wxListMainWindow (internal)
 427 //-----------------------------------------------------------------------------
 428
 429 WX_DECLARE_LIST(wxListHeaderData, wxListHeaderDataList);
 430
 431 class wxListMainWindow : public wxWindow
 432 {
 433 public:
 434     wxListMainWindow();
 435     wxListMainWindow( wxWindow *parent,
 436                       wxWindowID id,
 437                       const wxPoint& pos = wxDefaultPosition,
 438                       const wxSize& size = wxDefaultSize,
 439                       long style = 0,
 440                       const wxString &name = wxT("listctrlmainwindow") );
 441
 442     virtual ~wxListMainWindow();
 443
 444     // called by the main control when its mode changes
 445     void SetReportView(bool inReportView);
 446
 447     // helper to simplify testing for wxLC_XXX flags
 448     bool HasFlag(int flag) const { return m_parent->HasFlag(flag); }
 449
 450     // return true if this is a virtual list control
 451     bool IsVirtual() const { return HasFlag(wxLC_VIRTUAL); }
 452
 453     // return true if the control is in report mode
 454     bool InReportView() const { return HasFlag(wxLC_REPORT); }
 455
 456     // return true if we are in single selection mode, false if multi sel
 457     bool IsSingleSel() const { return HasFlag(wxLC_SINGLE_SEL); }
 458
 459     // do we have a header window?
 460     bool HasHeader() const
 461         { return InReportView() && !HasFlag(wxLC_NO_HEADER); }
 462
 463     void HighlightAll( bool on );
 464
 465     // all these functions only do something if the line is currently visible
 466
 467     // change the line "selected" state, return true if it really changed
 468     bool HighlightLine( size_t line, bool highlight = true);
 469
 470     // as HighlightLine() but do it for the range of lines: this is incredibly
 471     // more efficient for virtual list controls!
 472     //
 473     // NB: unlike HighlightLine() this one does refresh the lines on screen
 474     void HighlightLines( size_t lineFrom, size_t lineTo, bool on = true );
 475
 476     // toggle the line state and refresh it
 477     void ReverseHighlight( size_t line )
 478         { HighlightLine(line, !IsHighlighted(line)); RefreshLine(line); }
 479
 480     // return true if the line is highlighted
 481     bool IsHighlighted(size_t line) const;
 482
 483     // refresh one or several lines at once
 484     void RefreshLine( size_t line );
 485     void RefreshLines( size_t lineFrom, size_t lineTo );
 486
 487     // refresh all selected items
 488     void RefreshSelected();
 489
 490     // refresh all lines below the given one: the difference with
 491     // RefreshLines() is that the index here might not be a valid one (happens
 492     // when the last line is deleted)
 493     void RefreshAfter( size_t lineFrom );
 494
 495     // the methods which are forwarded to wxListLineData itself in list/icon
 496     // modes but are here because the lines don't store their positions in the
 497     // report mode
 498
 499     // get the bound rect for the entire line
 500     wxRect GetLineRect(size_t line) const;
 501
 502     // get the bound rect of the label
 503     wxRect GetLineLabelRect(size_t line) const;
 504
 505     // get the bound rect of the items icon (only may be called if we do have
 506     // an icon!)
 507     wxRect GetLineIconRect(size_t line) const;
 508
 509     // get the rect to be highlighted when the item has focus
 510     wxRect GetLineHighlightRect(size_t line) const;
 511
 512     // get the size of the total line rect
 513     wxSize GetLineSize(size_t line) const
 514         { return GetLineRect(line).GetSize(); }
 515
 516     // return the hit code for the corresponding position (in this line)
 517     long HitTestLine(size_t line, int x, int y) const;
 518
 519     // bring the selected item into view, scrolling to it if necessary
 520     void MoveToItem(size_t item);
 521
 522     bool ScrollList( int WXUNUSED(dx), int dy );
 523
 524     // bring the current item into view
 525     void MoveToFocus() { MoveToItem(m_current); }
 526
 527     // start editing the label of the given item
 528     wxTextCtrl *EditLabel(long item,
 529                           wxClassInfo* textControlClass = wxCLASSINFO(wxTextCtrl));
 530     wxTextCtrl *GetEditControl() const
 531     {
 532         return m_textctrlWrapper ? m_textctrlWrapper->GetText() : NULL;
 533     }
 534
 535     void ResetTextControl(wxTextCtrl *text)
 536     {
 537         delete text;
 538         m_textctrlWrapper = NULL;
 539     }
 540
 541     void OnRenameTimer();
 542     bool OnRenameAccept(size_t itemEdit, const wxString& value);
 543     void OnRenameCancelled(size_t itemEdit);
 544
 545     void OnMouse( wxMouseEvent &event );
 546
 547     // called to switch the selection from the current item to newCurrent,
 548     void OnArrowChar( size_t newCurrent, const wxKeyEvent& event );
 549
 550     void OnChar( wxKeyEvent &event );
 551     void OnKeyDown( wxKeyEvent &event );
 552     void OnKeyUp( wxKeyEvent &event );
 553     void OnSetFocus( wxFocusEvent &event );
 554     void OnKillFocus( wxFocusEvent &event );
 555     void OnScroll( wxScrollWinEvent& event );
 556
 557     void OnPaint( wxPaintEvent &event );
 558
 559     void OnChildFocus(wxChildFocusEvent& event);
 560
 561     void DrawImage( int index, wxDC *dc, int x, int y );
 562     void GetImageSize( int index, int &width, int &height ) const;
 563     int GetTextLength( const wxString &s ) const;
 564
 565     void SetImageList( wxImageList *imageList, int which );
 566     void SetItemSpacing( int spacing, bool isSmall = false );
 567     int GetItemSpacing( bool isSmall = false );
 568
 569     void SetColumn( int col, wxListItem &item );
 570     void SetColumnWidth( int col, int width );
 571     void GetColumn( int col, wxListItem &item ) const;
 572     int GetColumnWidth( int col ) const;
 573     int GetColumnCount() const { return m_columns.GetCount(); }
 574
 575     // returns the sum of the heights of all columns
 576     int GetHeaderWidth() const;
 577
 578     int GetCountPerPage() const;
 579
 580     void SetItem( wxListItem &item );
 581     void GetItem( wxListItem &item ) const;
 582     void SetItemState( long item, long state, long stateMask );
 583     void SetItemStateAll( long state, long stateMask );
 584     int GetItemState( long item, long stateMask ) const;
 585     bool GetItemRect( long item, wxRect &rect ) const
 586     {
 587         return GetSubItemRect(item, wxLIST_GETSUBITEMRECT_WHOLEITEM, rect);
 588     }
 589     bool GetSubItemRect( long item, long subItem, wxRect& rect ) const;
 590     wxRect GetViewRect() const;
 591     bool GetItemPosition( long item, wxPoint& pos ) const;
 592     int GetSelectedItemCount() const;
 593
 594     wxString GetItemText(long item, int col = 0) const
 595     {
 596         wxListItem info;
 597         info.m_mask = wxLIST_MASK_TEXT;
 598         info.m_itemId = item;
 599         info.m_col = col;
 600         GetItem( info );
 601         return info.m_text;
 602     }
 603
 604     void SetItemText(long item, const wxString& value)
 605     {
 606         wxListItem info;
 607         info.m_mask = wxLIST_MASK_TEXT;
 608         info.m_itemId = item;
 609         info.m_text = value;
 610         SetItem( info );
 611     }
 612
 613     wxImageList* GetSmallImageList() const
 614         { return m_small_image_list; }
 615
 616     // set the scrollbars and update the positions of the items
 617     void RecalculatePositions(bool noRefresh = false);
 618
 619     // refresh the window and the header
 620     void RefreshAll();
 621
 622     long GetNextItem( long item, int geometry, int state ) const;
 623     void DeleteItem( long index );
 624     void DeleteAllItems();
 625     void DeleteColumn( int col );
 626     void DeleteEverything();
 627     void EnsureVisible( long index );
 628     long FindItem( long start, const wxString& str, bool partial = false );
 629     long FindItem( long start, wxUIntPtr data);
 630     long FindItem( const wxPoint& pt );
 631     long HitTest( int x, int y, int &flags ) const;
 632     void InsertItem( wxListItem &item );
 633     void InsertColumn( long col, wxListItem &item );
 634     int GetItemWidthWithImage(wxListItem * item);
 635     void SortItems( wxListCtrlCompare fn, wxIntPtr data );
 636
 637     size_t GetItemCount() const;
 638     bool IsEmpty() const { return GetItemCount() == 0; }
 639     void SetItemCount(long count);
 640
 641     // change the current (== focused) item, send a notification event
 642     void ChangeCurrent(size_t current);
 643     void ResetCurrent() { ChangeCurrent((size_t)-1); }
 644     bool HasCurrent() const { return m_current != (size_t)-1; }
 645
 646     // send out a wxListEvent
 647     void SendNotify( size_t line,
 648                      wxEventType command,
 649                      const wxPoint& point = wxDefaultPosition );
 650
 651     // override base class virtual to reset m_lineHeight when the font changes
 652     virtual bool SetFont(const wxFont& font)
 653     {
 654         if ( !wxWindow::SetFont(font) )
 655             return false;
 656
 657         m_lineHeight = 0;
 658
 659         return true;
 660     }
 661
 662     // these are for wxListLineData usage only
 663
 664     // get the backpointer to the list ctrl
 665     wxGenericListCtrl *GetListCtrl() const
 666     {
 667         return wxStaticCast(GetParent(), wxGenericListCtrl);
 668     }
 669
 670     // get the height of all lines (assuming they all do have the same height)
 671     wxCoord GetLineHeight() const;
 672
 673     // get the y position of the given line (only for report view)
 674     wxCoord GetLineY(size_t line) const;
 675
 676     // get the brush to use for the item highlighting
 677     wxBrush *GetHighlightBrush() const
 678     {
 679         return m_hasFocus ? m_highlightBrush : m_highlightUnfocusedBrush;
 680     }
 681
 682     bool HasFocus() const
 683     {
 684         return m_hasFocus;
 685     }
 686
 687 protected:
 688     // the array of all line objects for a non virtual list control (for the
 689     // virtual list control we only ever use m_lines[0])
 690     wxListLineDataArray  m_lines;
 691
 692     // the list of column objects
 693     wxListHeaderDataList m_columns;
 694
 695     // currently focused item or -1
 696     size_t               m_current;
 697
 698     // the number of lines per page
 699     int                  m_linesPerPage;
 700
 701     // this flag is set when something which should result in the window
 702     // redrawing happens (i.e. an item was added or deleted, or its appearance
 703     // changed) and OnPaint() doesn't redraw the window while it is set which
 704     // allows to minimize the number of repaintings when a lot of items are
 705     // being added. The real repainting occurs only after the next OnIdle()
 706     // call
 707     bool                 m_dirty;
 708
 709     wxColour            *m_highlightColour;
 710     wxImageList         *m_small_image_list;
 711     wxImageList         *m_normal_image_list;
 712     int                  m_small_spacing;
 713     int                  m_normal_spacing;
 714     bool                 m_hasFocus;
 715
 716     bool                 m_lastOnSame;
 717     wxTimer             *m_renameTimer;
 718     bool                 m_isCreated;
 719     int                  m_dragCount;
 720     wxPoint              m_dragStart;
 721     ColWidthArray        m_aColWidths;
 722
 723     // for double click logic
 724     size_t m_lineLastClicked,
 725            m_lineBeforeLastClicked,
 726            m_lineSelectSingleOnUp;
 727
 728 protected:
 729     wxWindow *GetMainWindowOfCompositeControl() { return GetParent(); }
 730
 731     // the total count of items in a virtual list control
 732     size_t m_countVirt;
 733
 734     // the object maintaining the items selection state, only used in virtual
 735     // controls
 736     wxSelectionStore m_selStore;
 737
 738     // common part of all ctors
 739     void Init();
 740
 741     // get the line data for the given index
 742     wxListLineData *GetLine(size_t n) const
 743     {
 744         wxASSERT_MSG( n != (size_t)-1, wxT("invalid line index") );
 745
 746         if ( IsVirtual() )
 747         {
 748             wxConstCast(this, wxListMainWindow)->CacheLineData(n);
 749             n = 0;
 750         }
 751
 752         return &m_lines[n];
 753     }
 754
 755     // get a dummy line which can be used for geometry calculations and such:
 756     // you must use GetLine() if you want to really draw the line
 757     wxListLineData *GetDummyLine() const;
 758
 759     // cache the line data of the n-th line in m_lines[0]
 760     void CacheLineData(size_t line);
 761
 762     // get the range of visible lines
 763     void GetVisibleLinesRange(size_t *from, size_t *to);
 764
 765     // force us to recalculate the range of visible lines
 766     void ResetVisibleLinesRange() { m_lineFrom = (size_t)-1; }
 767
 768     // get the colour to be used for drawing the rules
 769     wxColour GetRuleColour() const
 770     {
 771         return wxSystemSettings::GetColour(wxSYS_COLOUR_3DLIGHT);
 772     }
 773
 774 private:
 775     // initialize the current item if needed
 776     void UpdateCurrent();
 777
 778     // delete all items but don't refresh: called from dtor
 779     void DoDeleteAllItems();
 780
 781     // the height of one line using the current font
 782     wxCoord m_lineHeight;
 783
 784     // the total header width or 0 if not calculated yet
 785     wxCoord m_headerWidth;
 786
 787     // the first and last lines being shown on screen right now (inclusive),
 788     // both may be -1 if they must be calculated so never access them directly:
 789     // use GetVisibleLinesRange() above instead
 790     size_t m_lineFrom,
 791            m_lineTo;
 792
 793     // the brushes to use for item highlighting when we do/don't have focus
 794     wxBrush *m_highlightBrush,
 795             *m_highlightUnfocusedBrush;
 796
 797     // wrapper around the text control currently used for in place editing or
 798     // NULL if no item is being edited
 799     wxListTextCtrlWrapper *m_textctrlWrapper;
 800
 801
 802     DECLARE_EVENT_TABLE()
 803
 804     friend class wxGenericListCtrl;
 805 };
 806
 807 #endif // wxUSE_LISTCTRL
 808 #endif // _WX_GENERIC_LISTCTRL_PRIVATE_H_