Name

TreeModel —

A TreeModel is the abstract base class for TreeStore and ListStore. -

Synopsis

newtype
        TreeIter
newtype
        TreePath
treePathNew:: IO TreePath
treePathNewFromString:: String -> IO TreePath
treeModelGetColumnType:: TreeModelClass tm => tm -> Int -> IO TMType
treeModelGetIter:: TreeModelClass tm => tm -> TreePath -> IO (Maybe TreeIter)
treeModelGetIterFirst:: TreeModelClass tm => tm -> IO (Maybe TreeIter)
treeModelGetIterFromString:: TreeModelClass tm => tm -> String -> IO (Maybe TreeIter)
treeModelGetNColumns:: TreeModelClass tm => tm -> IO Int
treeModelGetValue:: TreeModelClass tm => tm -> TreeIter -> Int -> IO GenericValue
treeModelIterChildren:: TreeModelClass tm => tm -> TreeIter -> IO (Maybe TreeIter)
treeModelIterNChildren:: TreeModelClass tm => tm -> Maybe TreeIter -> IO Int
treeModelIterNext:: TreeModelClass tm => tm -> TreeIter -> IO Bool
treeModelIterNthChild:: TreeModelClass tm => tm -> Maybe TreeIter -> Int -> IO (Maybe TreeIter)
treeModelIterParent:: TreeModelClass tm => tm -> TreeIter -> IO (Maybe TreeIter)
treeModelRefNode:: TreeModelClass tm => tm -> TreeIter -> IO ()
treeModelUnrefNode:: TreeModelClass tm => tm -> TreeIter -> IO ()

treeModeliterHasChild <no type information>

treePathAppendIndex:: TreePath -> Int -> IO ()
treePathNewFirst:: IO TreePath
treePathToString:: TreePath -> IO String

Introduction

Most functions are defined in the latter two classes. This module provides the TreeIter and TreePath objects. -

Datatypes

newtype TreeIter

Tree Iterator : A pointer to an entry in a TreeStore or ListStore. Tree Iterator : A pointer to an entry in a TreeStore or ListStore.

newtype TreeIter =TreeIter (ForeignPtr (TreeIter))

newtype TreePath

TreePath : a list of indices to specify a subtree or node in the hierarchical TreeStore database. TreePath : a list of indices to specify a subtree or node in the hierarchical TreeStore database.

newtype TreePath =TreePath (ForeignPtr (TreePath))

Constructors

treePathNew

Create a new TreePath.

treePathNew

A TreePath is an hierarchical index. It is independent of a specific TreeModel.

treePathNewFromString

Turn a String into a TreePath.

treePathNewFromString:: String:: IO TreePath
path

Methods

treeModelGetColumnType

Retrieves the type of a specific column.

treeModelGetColumnType:: tm:: Int:: IO TMType
tmcol

treeModelGetIter

Turn a TreePath into a TreeIter.

treeModelGetIter:: tm:: TreePath:: IO (Maybe TreeIter)
tmtp

Returns Nothing if the tp is invalid.

treeModelGetIterFirst

Retrieves an TreeIter to the first entry.

treeModelGetIterFirst:: tm:: IO (Maybe TreeIter)
tm

Returns Nothing if the table is empty.

treeModelGetIterFromString

Turn a String into a TreeIter.

treeModelGetIterFromString:: tm:: String:: IO (Maybe TreeIter)
tmstr

Returns Nothing if the table is empty.

treeModelGetNColumns

Read the number of columns this TreeModel currently stores.

treeModelGetNColumns:: tm:: IO Int
tm

treeModelGetValue

Read the value of at a specific column and Iterator.

treeModelGetValue:: tm:: TreeIter:: Int:: IO GenericValue
tmitercol

treeModelIterChildren

Retrieve an iterator to the first child.

treeModelIterChildren:: tm:: TreeIter:: IO (Maybe TreeIter)
tmparent

treeModelIterNChildren

Return the number of children.

treeModelIterNChildren:: tm:: Maybe TreeIter:: IO Int
tmiter

If Nothing is specified for the tm argument, the function will work on toplevel elements.

treeModelIterNext

Advance the iterator to the next element.

treeModelIterNext:: tm:: TreeIter:: IO Bool
tmiter

If there is no other element on this hierarchy level, return False.

treeModelIterNthChild

Retrieve the nth child.

treeModelIterNthChild:: tm:: Maybe TreeIter:: Int:: IO (Maybe TreeIter)
tmparentn

If Nothing is specified for the tm argument, the function will work on toplevel elements.

treeModelIterParent

Retrieve the parent of this iterator.

treeModelIterParent:: tm:: TreeIter:: IO (Maybe TreeIter)
tmchild

treeModelRefNode

No clue.

treeModelRefNode:: tm:: TreeIter:: IO ()
tmiter

treeModelUnrefNode

No clue either.

treeModelUnrefNode:: tm:: TreeIter:: IO ()
tmiter
no type info on symbol treeModeliterHasChild

treePathAppendIndex

Add an index on the next level.

treePathAppendIndex:: TreePath:: Int:: IO ()
tpind

treePathNewFirst

Create a TreePath.

treePathNewFirst

The returned TreePath is an index to the first element.

treePathToString

Turn a TreePath into a String.

treePathToString:: TreePath:: IO String
tp