wxdataviewctrl_helpers.cpp File Reference

#include <wx/dataview.h>
#include <wxdataviewctrl_helpers.h>

Go to the source code of this file.

Functions
wxDataViewItem	GetPrevItem (wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
	Get the previous item in list order. More...
wxDataViewItem	GetNextItem (wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
	Get the next item in list order. More...
wxDataViewItem	GetPrevSibling (wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
	Get the previous sibling of an item. More...
wxDataViewItem	GetNextSibling (wxDataViewCtrl const &aView, wxDataViewItem const &aItem)
	Get the next sibling of an item. More...

Function Documentation

GetNextItem()

wxDataViewItem GetNextItem	(	wxDataViewCtrl const &	aView,
		wxDataViewItem const &	aItem
	)

Get the next item in list order.

Parameters

aView	- a wxDataViewCtrl with valid model
aItem	- a valid item in the model

Returns

the item after aItem, or an invalid item if aItem is at the bottom.

Definition at line 42 of file wxdataviewctrl_helpers.cpp.

{
    wxDataViewItem nextItem;

    if( !aItem.IsOk() )
    {
        // No selection. Select the first.
        wxDataViewItemArray children;
        aView.GetModel()->GetChildren( aItem, children );
        return children[0];
    }

    if( aView.IsExpanded( aItem ) )
    {
        wxDataViewItemArray children;
        aView.GetModel()->GetChildren( aItem, children );
        nextItem = children[0];
    }
    else
    {
        // Walk up levels until we find one that has a next sibling.
        for( wxDataViewItem walk = aItem; walk.IsOk(); walk = aView.GetModel()->GetParent( walk ) )
        {
            nextItem = GetNextSibling( aView, walk );

            if( nextItem.IsOk() )
                break;
        }
    }

    return nextItem;
}

References GetNextSibling().

Referenced by LIB_TREE::onQueryCharHook(), and WIDGET_HOTKEY_LIST::updateFromClientData().

GetNextSibling()

wxDataViewItem GetNextSibling	(	wxDataViewCtrl const &	aView,
		wxDataViewItem const &	aItem
	)

Get the next sibling of an item.

Parameters

aView	- awxDataViewCtrl with valid model
aItem	- a valid item in the model

Returns

the sibling after aItem, or an invalid item if aItem has no siblings after it.

Definition at line 99 of file wxdataviewctrl_helpers.cpp.

{
    wxDataViewItemArray siblings;
    wxDataViewItem      invalid;
    wxDataViewItem      parent = aView.GetModel()->GetParent( aItem );

    aView.GetModel()->GetChildren( parent, siblings );

    for( size_t i = 0; i < siblings.size(); ++i )
    {
        if( siblings[i] == aItem )
        {
            if( i == siblings.size() - 1 )
                return invalid;
            else
                return siblings[i + 1];
        }
    }

    return invalid;
}

Referenced by GetNextItem().

GetPrevItem()

wxDataViewItem GetPrevItem	(	wxDataViewCtrl const &	aView,
		wxDataViewItem const &	aItem
	)

Get the previous item in list order.

Parameters

aView	- a wxDataViewCtrl with valid model
aItem	- a valid item in the model

Returns

the item before aItem, or an invalid item if aItem is at the top.

Definition at line 23 of file wxdataviewctrl_helpers.cpp.

{
    auto prevItem = GetPrevSibling( aView, aItem );

    if( !prevItem.IsOk() )
    {
        prevItem = aView.GetModel()->GetParent( aItem );
    }
    else if( aView.IsExpanded( prevItem ) )
    {
        wxDataViewItemArray children;
        aView.GetModel()->GetChildren( prevItem, children );
        prevItem = children[children.size() - 1];
    }

    return prevItem;
}

References GetPrevSibling().

Referenced by LIB_TREE::onQueryCharHook().

GetPrevSibling()

wxDataViewItem GetPrevSibling	(	wxDataViewCtrl const &	aView,
		wxDataViewItem const &	aItem
	)

Get the previous sibling of an item.

Parameters

aView	- awxDataViewCtrl with valid model
aItem	- a valid item in the model

Returns

the sibling before aItem, or an invalid item if aItem has no siblings before it.

Definition at line 76 of file wxdataviewctrl_helpers.cpp.

{
    wxDataViewItemArray siblings;
    wxDataViewItem      invalid;
    wxDataViewItem      parent = aView.GetModel()->GetParent( aItem );

    aView.GetModel()->GetChildren( parent, siblings );

    for( size_t i = 0; i < siblings.size(); ++i )
    {
        if( siblings[i] == aItem )
        {
            if( i == 0 )
                return invalid;
            else
                return siblings[i - 1];
        }
    }

    return invalid;
}

Referenced by GetPrevItem().