Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

GRAPHICTREE Class Reference

< GENERATING_DOXYGEN_OUTPUT More...

#include <mi32/grtree.h>

List of all members.

Public Types

enum  FLAGS {
  FirstAtTop = 0x00000000, FirstAtBottom = 0x00000001, NoScrollHorizontal = 0x00000002, AllowChildSelection = 0x00000004,
  AllowChildReorder = 0x00000008, IncludeExpandIcons = 0x00000010, ItemMayHaveChildren = 0x00000020, SingleSelectionOnly = 0x00000040,
  ChildrenHidden = 0x00000080
}

Public Member Functions

void DeleteChildren (void *ParentReference, UINT32 ParentRefIndex, bool redraw=true)
ITEM * FindItemByRef (const void *RefPointer, UINT32 RefIndex) const
void * GetActiveChild (void *ParentReference, UINT32 ParentRefIndex)
ITEM * GetActiveItem () const
Widget GetDrawingArea () const
void * GetFirstItem (void *ParentReference, UINT32 ParentRefIndex) const
void * GetNextItem (void *ItemReference, UINT32 ItemRefIndex) const
void * GetParentItem (void *ItemReference, UINT32 ItemRefIndex) const
void * GetPrivData () const
const ITEM * GetRootItem () const
Widget GetWidget () const
 GRAPHICTREE (Widget parent, const char *sizefield, Arg *arglist, int argcount, FLAGS flags=FirstAtTop)
ITEM * ItemAdd (void *ItemReference, UINT32 ItemRefIndex, void(*MsgHandler)(ITEM::MSG *), int position, FLAGS flags=FirstAtTop)
ITEM * ItemAdd (void *ParentReference, UINT32 ParentRefIndex, void *ItemReference, UINT32 ItemRefIndex, void(*MsgHandler)(ITEM::MSG *), int position, FLAGS flags=FirstAtTop)
bool ItemAreChildrenVisible (void *ItemReference, UINT32 ItemRefIndex)
bool ItemDelete (void *ItemReference, UINT32 ItemRefIndex, bool redraw=true)
bool ItemExists (void *ItemReference, UINT32 ItemRefIndex)
int ItemGetPosition (void *ItemReference, UINT32 ItemRefIndex)
void * ItemGetPrivPtr (void *ItemReference, UINT32 ItemRefIndex)
bool ItemIsVisible (void *ItemReference, UINT32 ItemRefIndex)
void ItemNotifyChanged (void *ItemReference, UINT32 ItemRefIndex, bool redraw=true)
void ItemRedraw (void *ItemReference, UINT32 ItemRefIndex)
void ItemSetChildMarginBottom (void *ItemReference, UINT32 ItemRefIndex, UINT8 Margin)
void ItemSetChildMarginLeft (void *ItemReference, UINT32 ItemRefIndex, UINT8 Margin)
void ItemSetChildMarginRight (void *ItemReference, UINT32 ItemRefIndex, UINT8 Margin)
void ItemSetChildMarginTop (void *ItemReference, UINT32 ItemRefIndex, UINT8 Margin)
void ItemSetChildrenVisible (void *ItemReference, UINT32 ItemRefIndex, bool visible, bool redraw=true)
void ItemSetChildSpacing (void *ItemReference, UINT32 ItemRefIndex, UINT8 Spacing)
void ItemSetPosition (void *ItemReference, UINT32 ItemRefIndex, int position, bool redraw=true)
void ItemSetPrivPtr (void *ItemReference, UINT32 ItemRefIndex, void *PrivPtr)
void ItemSetVisible (void *ItemReference, UINT32 ItemRefIndex, bool visible, bool redraw=true)
void NotifyChanged (bool redraw=true)
void Redraw (LRECT2D *rect=0)
void RedrawDisable ()
void RedrawEnable (bool redraw=true)
void ScrollToItem (ITEM *item)
void SetActiveChild (void *ParentReference, void *ItemReference)
void SetActiveChild (void *ParentReference, UINT32 ParentRefIndex, void *ItemReference, UINT32 ItemRefIndex)
void SetActiveItem (ITEM *item)
void SetPrivData (void *data)
 ~GRAPHICTREE ()

Detailed Description

< GENERATING_DOXYGEN_OUTPUT

Definition at line 164 of file grtree.h.

Member Enumeration Documentation

enum GRAPHICTREE::FLAGS
 

Flags used in tree and item creation.

Enumeration values:
FirstAtTop 
FirstAtBottom 
NoScrollHorizontal  Don't include horizontal scrollbar.
AllowChildSelection 
AllowChildReorder 
IncludeExpandIcons  Include expand/collapse icons.
ItemMayHaveChildren  Item may have children, determine when attempt to expand.
SingleSelectionOnly  Only single tree item may be selected at a time.
ChildrenHidden  Children initially hidden.

Definition at line 168 of file grtree.h.

Constructor & Destructor Documentation

GRAPHICTREE::GRAPHICTREE (  Widget  parent,
const char *  sizefield,
Arg *  arglist,
int  argcount,
FLAGS  flags = FirstAtTop
) 
 

Constructor.

GRAPHICTREE::~GRAPHICTREE (   ) 
 

Destructor.

Member Function Documentation

void GRAPHICTREE::DeleteChildren (  void *  ParentReference,
UINT32  ParentRefIndex,
bool  redraw = true
) 
 

Delete all children of specified parent.

ITEM* GRAPHICTREE::FindItemByRef (  const void *  RefPointer,
UINT32  RefIndex
)  const
 

Find item matching specified reference pointer and index.

Returns:
Pointer to item or NULL if none found.

void* GRAPHICTREE::GetActiveChild (  void *  ParentReference,
UINT32  ParentRefIndex
) 
 

Get "active" child for given parent if any.

ITEM* GRAPHICTREE::GetActiveItem (   )  const [inline]
 

get 'active' item in single-selection mode.

Returns:
Pointer to active item, NULL if none active.

Definition at line 434 of file grtree.h.

Widget GRAPHICTREE::GetDrawingArea (   )  const [inline]
 

Get DrawingArea widget for GraphicTree.

Definition at line 439 of file grtree.h.

void* GRAPHICTREE::GetFirstItem (  void *  ParentReference,
UINT32  ParentRefIndex
)  const
 

Get first child for given parent.

void* GRAPHICTREE::GetNextItem (  void *  ItemReference,
UINT32  ItemRefIndex
)  const
 

Get next "sibling" item.

void* GRAPHICTREE::GetParentItem (  void *  ItemReference,
UINT32  ItemRefIndex
)  const
 

void* GRAPHICTREE::GetPrivData (   )  const [inline]
 

Definition at line 461 of file grtree.h.

const ITEM* GRAPHICTREE::GetRootItem (   )  const [inline]
 

Definition at line 466 of file grtree.h.

Widget GRAPHICTREE::GetWidget (   )  const [inline]
 

Get widget.

Definition at line 471 of file grtree.h.

ITEM* GRAPHICTREE::ItemAdd (  void *  ItemReference,
UINT32  ItemRefIndex,
void(*  MsgHandler)(ITEM::MSG *),
int  position,
FLAGS  flags = FirstAtTop
)  [inline]
 

Add item to GRAPHICTREE as child of root.

Returns:
Pointer to ITEM added.

Definition at line 490 of file grtree.h.

ITEM* GRAPHICTREE::ItemAdd (  void *  ParentReference,
UINT32  ParentRefIndex,
void *  ItemReference,
UINT32  ItemRefIndex,
void(*  MsgHandler)(ITEM::MSG *),
int  position,
FLAGS  flags = FirstAtTop
) 
 

Add item to GRAPHICTREE as child of specified item.

Returns:
Pointer to ITEM added.

bool GRAPHICTREE::ItemAreChildrenVisible (  void *  ItemReference,
UINT32  ItemRefIndex
) 
 

Determine if item's children are visible.

bool GRAPHICTREE::ItemDelete (  void *  ItemReference,
UINT32  ItemRefIndex,
bool  redraw = true
) 
 

Delete item and all children.

bool GRAPHICTREE::ItemExists (  void *  ItemReference,
UINT32  ItemRefIndex
)  [inline]
 

Determine if specified item exists.

Definition at line 514 of file grtree.h.

int GRAPHICTREE::ItemGetPosition (  void *  ItemReference,
UINT32  ItemRefIndex
) 
 

Get position of item in parent's list of children.

void* GRAPHICTREE::ItemGetPrivPtr (  void *  ItemReference,
UINT32  ItemRefIndex
)  [inline]
 

Get private pointer for item.

Definition at line 528 of file grtree.h.

bool GRAPHICTREE::ItemIsVisible (  void *  ItemReference,
UINT32  ItemRefIndex
) 
 

Determine visibility for item.

void GRAPHICTREE::ItemNotifyChanged (  void *  ItemReference,
UINT32  ItemRefIndex,
bool  redraw = true
) 
 

Notify GRAPHICTREE that item has changed so will update size.

void GRAPHICTREE::ItemRedraw (  void *  ItemReference,
UINT32  ItemRefIndex
) 
 

Redraw specified item.

void GRAPHICTREE::ItemSetChildMarginBottom (  void *  ItemReference,
UINT32  ItemRefIndex,
UINT8  Margin
)  [inline]
 

Set bottom margin for child list.

Definition at line 556 of file grtree.h.

void GRAPHICTREE::ItemSetChildMarginLeft (  void *  ItemReference,
UINT32  ItemRefIndex,
UINT8  Margin
)  [inline]
 

Set left margin for child list.

Definition at line 569 of file grtree.h.

void GRAPHICTREE::ItemSetChildMarginRight (  void *  ItemReference,
UINT32  ItemRefIndex,
UINT8  Margin
)  [inline]
 

Set right margin for child list.

Definition at line 582 of file grtree.h.

void GRAPHICTREE::ItemSetChildMarginTop (  void *  ItemReference,
UINT32  ItemRefIndex,
UINT8  Margin
)  [inline]
 

Set top margin for child list.

Definition at line 595 of file grtree.h.

void GRAPHICTREE::ItemSetChildrenVisible (  void *  ItemReference,
UINT32  ItemRefIndex,
bool  visible,
bool  redraw = true
) 
 

Set visibility for children of item.

void GRAPHICTREE::ItemSetChildSpacing (  void *  ItemReference,
UINT32  ItemRefIndex,
UINT8  Spacing
)  [inline]
 

Set spacing between children.

Definition at line 608 of file grtree.h.

void GRAPHICTREE::ItemSetPosition (  void *  ItemReference,
UINT32  ItemRefIndex,
int  position,
bool  redraw = true
) 
 

Set item position in list.

void GRAPHICTREE::ItemSetPrivPtr (  void *  ItemReference,
UINT32  ItemRefIndex,
void *  PrivPtr
)  [inline]
 

Set private pointer for item.

Definition at line 636 of file grtree.h.

void GRAPHICTREE::ItemSetVisible (  void *  ItemReference,
UINT32  ItemRefIndex,
bool  visible,
bool  redraw = true
) 
 

Set visiblity for item.

void GRAPHICTREE::NotifyChanged (  bool  redraw = true  )  [inline]
 

Notify GraphicTree that item has changed so can recompute size/position.

Definition at line 651 of file grtree.h.

void GRAPHICTREE::Redraw (  LRECT2D *  rect = 0  ) 
 

Redraw GRAPHICTREE.

void GRAPHICTREE::RedrawDisable (   )  [inline]
 

Disable redraw.

Definition at line 661 of file grtree.h.

void GRAPHICTREE::RedrawEnable (  bool  redraw = true  )  [inline]
 

Enable redraw.

Definition at line 665 of file grtree.h.

void GRAPHICTREE::ScrollToItem (  ITEM *  item  ) 
 

Scroll to make specified item visible.

Parameters:
item  Item to make visible

void GRAPHICTREE::SetActiveChild (  void *  ParentReference,
void *  ItemReference
)  [inline]
 

Set active child item.

Definition at line 683 of file grtree.h.

void GRAPHICTREE::SetActiveChild (  void *  ParentReference,
UINT32  ParentRefIndex,
void *  ItemReference,
UINT32  ItemRefIndex
) 
 

Set active child item.

Parameters:
ItemReference  Pass NULL to set to have no active item

void GRAPHICTREE::SetActiveItem (  ITEM *  item  ) 
 

Set active item in single-selection mode.

void GRAPHICTREE::SetPrivData (  void *  data  )  [inline]
 

Definition at line 696 of file grtree.h.

The documentation for this class was generated from the following file:
Generated on Tue Dec 14 13:19:47 2004 for TNTsdk by  doxygen 1.3.8-20040913