CMenu.TreeIter

Fields

None

Methods

get_alias ()

get_directory ()

get_entry ()

get_header ()

get_separator ()

next ()

Details

class CMenu.TreeIter
get_alias()
Returns:

An alias

Return type:

CMenu.TreeAlias

This method may only be called if CMenu.TreeIter.next() returned CMenu.TreeItemType.ALIAS.

get_directory()
Returns:

A directory

Return type:

CMenu.TreeDirectory

This method may only be called if CMenu.TreeIter.next() returned CMenu.TreeItemType.DIRECTORY.

get_entry()
Returns:

An entry

Return type:

CMenu.TreeEntry

This method may only be called if CMenu.TreeIter.next() returned CMenu.TreeItemType.ENTRY.

get_header()
Returns:

A header

Return type:

CMenu.TreeHeader

This method may only be called if CMenu.TreeIter.next() returned CMenu.TreeItemType.HEADER.

get_separator()
Returns:

A separator

Return type:

CMenu.TreeSeparator

This method may only be called if CMenu.TreeIter.next() returned CMenu.TreeItemType.SEPARATOR.

next()
Returns:

The type of the next item that can be retrived from the iterator

Return type:

CMenu.TreeItemType

Change the iterator to the next item, and return its type. If there are no more items, CMenu.TreeItemType.INVALID is returned.