KiCad PCB EDA Suite
Loading...
Searching...
No Matches
WX_DATAVIEWCTRL Class Reference

Extension of the wxDataViewCtrl to include some helper functions for working with items. More...

#include <wx_dataviewctrl.h>

Inheritance diagram for WX_DATAVIEWCTRL:

Public Member Functions

wxDataViewItem GetPrevItem (wxDataViewItem const &aItem)
 Get the previous item in list order.
 
wxDataViewItem GetNextItem (wxDataViewItem const &aItem)
 Get the next item in list order.
 
wxDataViewItem GetPrevSibling (wxDataViewItem const &aItem)
 Get the previous sibling of an item.
 
wxDataViewItem GetNextSibling (wxDataViewItem const &aItem)
 Get the next sibling of an item.
 
void DoSetToolTipText (const wxString &tip) override
 
void ExpandAll ()
 
void CollapseAll ()
 

Detailed Description

Extension of the wxDataViewCtrl to include some helper functions for working with items.

These should probably be sent upstream, since they may be useful to others, but for now just extend the class with them ourselves.

Definition at line 30 of file wx_dataviewctrl.h.

Member Function Documentation

◆ CollapseAll()

void WX_DATAVIEWCTRL::CollapseAll ( )

Definition at line 158 of file wx_dataviewctrl.cpp.

References recursiveDescent().

Referenced by LIB_TREE::CollapseAll(), and LIB_TREE::onQueryCharHook().

◆ DoSetToolTipText()

void WX_DATAVIEWCTRL::DoSetToolTipText ( const wxString &  tip)
inlineoverride

Definition at line 68 of file wx_dataviewctrl.h.

◆ ExpandAll()

void WX_DATAVIEWCTRL::ExpandAll ( )

Definition at line 152 of file wx_dataviewctrl.cpp.

References recursiveDescent().

Referenced by LIB_TREE::ExpandAll(), and LIB_TREE::onQueryCharHook().

◆ GetNextItem()

wxDataViewItem WX_DATAVIEWCTRL::GetNextItem ( wxDataViewItem const &  aItem)

Get the next item in list order.

Parameters
aItema valid item in the control's model
Returns
the item after aItem, or an invalid item if aItem is at the bottom.

Definition at line 44 of file wx_dataviewctrl.cpp.

References GetNextSibling().

Referenced by LIB_TREE::onQueryCharHook().

◆ GetNextSibling()

wxDataViewItem WX_DATAVIEWCTRL::GetNextSibling ( wxDataViewItem const &  aItem)

Get the next sibling of an item.

Parameters
aItema valid item in the control's model
Returns
the sibling after aItem, or an invalid item if aItem has no siblings after it.

Definition at line 110 of file wx_dataviewctrl.cpp.

Referenced by GetNextItem().

◆ GetPrevItem()

wxDataViewItem WX_DATAVIEWCTRL::GetPrevItem ( wxDataViewItem const &  aItem)

Get the previous item in list order.

Parameters
aItema valid item in the control's model
Returns
the item before aItem, or an invalid item if aItem is at the top.

Definition at line 23 of file wx_dataviewctrl.cpp.

References GetPrevSibling().

Referenced by LIB_TREE::onQueryCharHook().

◆ GetPrevSibling()

wxDataViewItem WX_DATAVIEWCTRL::GetPrevSibling ( wxDataViewItem const &  aItem)

Get the previous sibling of an item.

Parameters
aItema valid item in the control's model
Returns
the sibling before aItem, or an invalid item if aItem has no siblings before it.

Definition at line 87 of file wx_dataviewctrl.cpp.

Referenced by GetPrevItem().


The documentation for this class was generated from the following files: