Planeshift
Public Member Functions | Protected Member Functions | Protected Attributes

pawsTree Class Reference

#include <pawstree.h>

List of all members.

Public Member Functions

virtual void Deselect ()
virtual void Draw ()
 Draws the widget and all of it's children.
pawsTreeNodeGetSelected ()
virtual bool LoadChildren (iDocumentNode *node)
 Load widget children based on subtags of its <widget></widget> tag.
virtual void NewNode (pawsTreeNode *node)
virtual bool OnKeyDown (utf32_char keyCode, utf32_char keyChar, int modifiers)
 Process keydown messages.
virtual bool OnMouseDown (int button, int modifiers, int x, int y)
 Manage mouse down event to test for and apply window changes.
virtual bool OnScroll (int scrollDirection, pawsScrollBar *widget)
 Called whenever a window is scrolled.
 pawsTree (const pawsTree &origin)
 pawsTree ()
virtual bool PostSetup ()
 This is called after the widget and all of it's children have been created.
virtual void RemoveNode (pawsTreeNode *node)
virtual void Select (pawsTreeNode *)
void SetNotify (pawsWidget *_notificationTarget)
virtual void SetRoot (pawsTreeNode *root)
void SetScrollBars (bool horiz, bool vert)
void SetTreeDecorator (pawsITreeDecorator *decor)
void SetTreeLayout (pawsITreeLayout *layout)
virtual bool Setup (iDocumentNode *node)
 Setup this widget.
virtual ~pawsTree ()

Protected Member Functions

void cloneTreeNodes (const pawsTree &origin)
void SetScrollBarMax ()

Protected Attributes

pawsITreeDecoratordecor
pawsScrollBarhorizScrollBar
pawsITreeLayoutlayout
pawsWidgetnotificationTarget
pawsTreeNodeselected
pawsScrollBarvertScrollBar

Detailed Description

Definition at line 266 of file pawstree.h.


Constructor & Destructor Documentation

pawsTree::pawsTree ( )
pawsTree::pawsTree ( const pawsTree origin)
virtual pawsTree::~pawsTree ( ) [virtual]

Member Function Documentation

void pawsTree::cloneTreeNodes ( const pawsTree origin) [protected]
virtual void pawsTree::Deselect ( ) [virtual]
virtual void pawsTree::Draw ( ) [virtual]

Draws the widget and all of it's children.

Remarks:
Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented from pawsWidget.

pawsTreeNode* pawsTree::GetSelected ( )
virtual bool pawsTree::LoadChildren ( iDocumentNode *  node) [virtual]

Load widget children based on subtags of its <widget></widget> tag.

Parameters:
nodeThe xml data for the widget.

Reimplemented from pawsWidget.

virtual void pawsTree::NewNode ( pawsTreeNode node) [virtual]

Implements pawsTreeStruct.

virtual bool pawsTree::OnKeyDown ( utf32_char  keyCode,
utf32_char  keyChar,
int  modifiers 
) [virtual]

Process keydown messages.

Parameters:
keyCodeThe code for the pressed key.
keyCharThe key pressed.
modifiersUsed to modify tab behavior.
Returns:
bool TRUE for success FALSE if no action.
Remarks:
If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented from pawsWidget.

virtual bool pawsTree::OnMouseDown ( int  button,
int  modifiers,
int  x,
int  y 
) [virtual]

Manage mouse down event to test for and apply window changes.

Parameters:
buttonType of button: 1 resizable or movable, 2 context menu or config window.
modifiersUsed with PAWS_CONSTRUCTION.
xUsed to test for resize.
yUsed to test for resize.
Returns:
bool TRUE if movable or resizable.
Remarks:
calls OnMouseDown on it's parent.

Reimplemented from pawsWidget.

virtual bool pawsTree::OnScroll ( int  scrollDirection,
pawsScrollBar widget 
) [virtual]

Called whenever a window is scrolled.

Parameters:
scrollDirectionThe direction to move.
widgetThe scrollbar widget being manipulated.
Returns:
bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

virtual bool pawsTree::PostSetup ( ) [virtual]

This is called after the widget and all of it's children have been created.

Remarks:
This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

virtual void pawsTree::RemoveNode ( pawsTreeNode node) [virtual]

Implements pawsTreeStruct.

virtual void pawsTree::Select ( pawsTreeNode ) [virtual]
void pawsTree::SetNotify ( pawsWidget _notificationTarget)
virtual void pawsTree::SetRoot ( pawsTreeNode root) [virtual]

Reimplemented from pawsTreeStruct.

void pawsTree::SetScrollBarMax ( ) [protected]
void pawsTree::SetScrollBars ( bool  horiz,
bool  vert 
)
void pawsTree::SetTreeDecorator ( pawsITreeDecorator decor)
void pawsTree::SetTreeLayout ( pawsITreeLayout layout)
virtual bool pawsTree::Setup ( iDocumentNode *  ) [virtual]

Setup this widget.

Reimplemented from pawsWidget.

Reimplemented in pawsSimpleTree.


Member Data Documentation

Definition at line 313 of file pawstree.h.

Definition at line 317 of file pawstree.h.

Definition at line 312 of file pawstree.h.

Definition at line 316 of file pawstree.h.

Definition at line 315 of file pawstree.h.

Definition at line 317 of file pawstree.h.


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