omUITreeNode Class Reference
[USER INTERFACE classes of the OpenMAIA Library]

#include <omUITreeNode.h>

Inheritance diagram for omUITreeNode:


Public Member Functions
	omUITreeNode (omUITreeNode , omObject , int)
	omUITreeNode (omUITreeNode , omUIButton )
	~omUITreeNode ()
void	DeleteChildren ()
void	AddNode (omUITreeNode *)
void	AddLeaf (omUIButton *)
omUITreeNode *	GetParentNode ()
bool	IsYourWindow (void *)
void	DeAction (bool)
void	Tick ()
void	Action ()
void	PaintWindows ()
void	Show ()
bool	GetActionStatus ()
void	Repaint ()
virtual void	Execute ()
virtual void	LightOn ()
virtual void	LightOff ()
Data Fields
bool	actioned
Protected Attributes
omUITreeNode *	parent
std::vector< omUITreeNode * >	nodes
omUIButton *	leaf
int	nnodes
int	currentNode
int	scanCount
int	scanMax
omObject *	data
bool	isLeaf

Detailed Description

This class is a superclass for a generic node of a maia keyboard tree. This class can be a node or a leaf of the tree. It handles some signals passed through the tree. These signals are used to handle events for implementing the automatic timed scan of the virtual keyboard. The class contains a pointer to a MaiaLittleWindow object. If the node is a leaf this pointer points to the leaf object else it's null. You can use this pointer to handle your own button inherit from MaiaLittleWindow. The class also contains a pointer to GenericNodeData class than contains all data needed to the node. You can inherit a your own data class from GenericNodeData.

Constructor & Destructor Documentation

omUITreeNode::omUITreeNode ( omUITreeNode * p,

omObject * d,

int ms

)

Constructor of the class.The constructor of the class generates a new object and allocates data. omUITreeNode derived class and GenericNodeData derived class can be used to handle specific node and specific data.
Parameters:

p Pointer to the parent node

d Pointer to the Node Data

ms Maximum number of scan cycles before exit in automatic scan mode. \ (Set to -1 to infinite loop)

omUITreeNode::omUITreeNode ( omUITreeNode * p,

omUIButton * but

)

Constructor of the class as a tree lead.The constructor of the class generates a new object and allocates data. omUITreeNode derived class and GenericNodeData derived class can be used to handle specific node and specific data.
Parameters:

p Pointer to the parent node

but Pointer to button (a omUIButton derived class)

omUITreeNode::~omUITreeNode ( )

Member Function Documentation

void omUITreeNode::Action ( ) [virtual]

Pass the action signal to the node. Action indicate that user fired the button or the group of buttons.
Reimplemented from omObject.

void omUITreeNode::AddLeaf ( omUIButton * l )

Add a new node as a leaf of this node in the tree structure.
Parameters:

l Pointer to omUIButton to insert as leaf.

void omUITreeNode::AddNode ( omUITreeNode * node )

Add a new node as a child of this node in the tree structure.
Parameters:

node Pointer to node to add.

void omUITreeNode::DeAction ( bool )

void omUITreeNode::DeleteChildren ( )

Delete all children wihout deleting this node. used in the root node only.

void omUITreeNode::Execute ( ) [virtual]

Run application dependent functions when the block is selected by the user. The Execute command is called by the parent node when it is actioned by the user. By default if the node is a leaf the leaf Execute() method is called. The function can be overriddent to handle specific cases.

bool omUITreeNode::GetActionStatus ( )

Return the status of the actioned flag.
Returns:
actioned flag status.

omUITreeNode * omUITreeNode::GetParentNode ( )

Return the parent node pointer
Returns:
parent node pointer

bool omUITreeNode::IsYourWindow ( void * wh ) [virtual]

Check if the passed window handler belong to the associated leaf or to any child leaf. The handler is a void * so this method is not system dependent.
Parameters:

wh window handler to check

Returns:
true if wh is handler of leaf or any child leaf, false otehrwise

Reimplemented from omObject.

void omUITreeNode::LightOff ( ) [virtual]

Force the node to light off state This method is called turn off the highlight status of the group. The function by default passes the signal to all the children and if it is a leaf the signal is passed to the leaf object. This function can be overridden to do specific work.

void omUITreeNode::LightOn ( ) [virtual]

Force the node to light on state. This method is called to highlight the group. The function by default passes the signal to all the children and if it is a leaf the signal is passed to the leaf object. This function can be overridden to do specific work.

void omUITreeNode::PaintWindows ( )

Paint default picture of all windows

void omUITreeNode::Repaint ( )

Send Repain() message to all subnodes. This method is used to repaint all tree or some parts of it.

void omUITreeNode::Show ( )

Show all the windows of this node

void omUITreeNode::Tick ( ) [virtual]

Pass the tick signal to the node. Tick signal is used to comunicate to the node that a scan event was occoured. If the node is not a leaf it comunicates the signal to children. If the node is a leaf the signal is used to change display status (scanned or not scanned).
Reimplemented from omObject.