CIP C++ documentation for class "uifcTree"

Class uifcTree

# include <uifcTree.h> class uifcTree : public virtual uifcSelection { xaideclare(uifcTree) ... };

Description

Method Summary


`void`	`AddActionListener (uifcTreeListener_ptr listener)`


`xbool`	`CanDrawContentDisabled ()`


`xbool`	`CanPopupHelpText ()`


`xbool`	`CanRedraw ()`


`void`	`CreateTimer (uifcTreeTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeleteChild (xrstring name)`


`void`	`DeleteColumnsByIndex (xintsequence_ptr columns)`


`void`	`DeleteColumnsByName (xstringsequence_ptr names)`


`void`	`DeleteItemByName (xrstring name)`


`void`	`DeleteItemsByName (xstringsequence_ptr names)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesActivateOnReturn ()`


`xbool`	`DoesAllowHover ()`


`xbool`	`DoesAutoCheck ()`


`xbool`	`DoesAutoOpenAndClose ()`


`xbool`	`DoesHighlightOnDragMove ()`


`xbool`	`DoesHorzScrollOnFocus ()`


`xbool`	`DoesItemExist (xrstring name)`


`xbool`	`DoesItemSelectOnRMB ()`


`xbool`	`DoesItemSelectWhenSelected ()`


`xbool`	`DoesScrollOnKeyboardInput ()`


`uifcColor_ptr`	`GetAlternateRowColor ()`


`xintsequence_ptr`	`GetColumnWidthArray ()`


`uifcPoint_ptr`	`GetCursorPosition ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`xstring`	`GetDropItemName ()`


`xstring`	`GetFocusItemName ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetHeight ()`


`xint`	`GetImageHeight ()`


`xint`	`GetImageWidth ()`


`xint`	`GetItemSelectionDelay ()`


`uifcSelectionPolicy`	`GetItemSelectionPolicy ()`


`xstringsequence_ptr`	`GetItemsOfType (xrstring name)`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`xstring`	`GetMixedStateImage ()`


`void`	`GetMostRecentCellName (xstringsequence_ptr node, xstringsequence_ptr column)`


`xstring`	`GetMostRecentItemName ()`


`xstringsequence_ptr`	`GetNodeTypeCloseImageArray ()`


`xstringsequence_ptr`	`GetNodeTypeHelpTextArray ()`


`xstringsequence_ptr`	`GetNodeTypeNameArray ()`


`xstringsequence_ptr`	`GetNodeTypeOpenImageArray ()`


`xstringsequence_ptr`	`GetNodeTypePrefixArray ()`


`xstringsequence_ptr`	`GetNodeTypeSuffixArray ()`


`xstring`	`GetOpenCloseItemName ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`xstring`	`GetRootItemName ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcScrollBarPosition`	`GetScrollBarPosition ()`


`xstringsequence_ptr`	`GetSelectedItemNameArray ()`


`xstring`	`GetSetStateImage ()`


`uifcTreeGravity`	`GetTreeGravity ()`


`uifcLabelAlignment`	`GetTreeHeaderTextAlignment ()`


`uifcTreeType`	`GetTreeType ()`


`xstring`	`GetUnsetStateImage ()`


`xstringsequence_ptr`	`GetViewableItemNameArray (xrstring first, xrstring last)`


`xstringsequence_ptr`	`GetViewableItemNameArray ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xbool`	`HasScrollBarsWhenNeeded ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`void`	`InsertItem (uifcTreeItem_ptr treeitem, uifcItemPositionData_ptr item_pos_data)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsRootItemVisible ()`


`xbool`	`IsSelectionVisible ()`


`xbool`	`IsValidDragSite ()`


`void`	`MoveColumnsByIndex (xint column, xintsequence_ptr columns)`


`void`	`MoveColumnsByName (xrstring column, xstringsequence_ptr names)`


`void`	`PushAction (uifcTreeAction action)`


`void`	`SetActivateOnReturn (xbool flag)`


`void`	`SetAllowHover (xbool flag)`


`void`	`SetAlternateRowColor (uifcColor_ptr color)`


`void`	`SetAutoCheck (xbool flag)`


`void`	`SetAutoOpenAndClose (xbool flag)`


`void`	`SetCanDrawContentDisabled (xbool flag)`


`void`	`SetCanPopupHelpText (xbool flag)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetColumnWidthArray (xintsequence_ptr values)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetFocusItemName (xrstring value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHasScrollBarsWhenNeeded (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetHighlightOnDragMove (xbool flag)`


`void`	`SetHorzScrollOnFocus (xbool flag)`


`void`	`SetImageHeight (xint value)`


`void`	`SetImageWidth (xint value)`


`void`	`SetItemSelectionDelay (xint value)`


`void`	`SetItemSelectionPolicy (uifcSelectionPolicy value)`


`void`	`SetItemSelectOnRMB (xbool flag)`


`void`	`SetItemSelectWhenSelected (xbool flag)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetMixedStateImage (xrstring value)`


`void`	`SetNodeTypeCloseImageArray (xstringsequence_ptr values)`


`void`	`SetNodeTypeHelpTextArray (xstringsequence_ptr values)`


`void`	`SetNodeTypeNameArray (xstringsequence_ptr values)`


`void`	`SetNodeTypeOpenImageArray (xstringsequence_ptr values)`


`void`	`SetNodeTypePrefixArray (xstringsequence_ptr values)`


`void`	`SetNodeTypeSuffixArray (xstringsequence_ptr values)`


`void`	`SetRootItemName (xrstring value)`


`void`	`SetRootItemVisible (xbool flag)`


`void`	`SetScrollBarPosition (uifcScrollBarPosition value)`


`void`	`SetScrollOnKeyboardInput (xbool flag)`


`void`	`SetSelectedItemNameArray (xstringsequence_ptr values)`


`void`	`SetSelectionVisible (xbool flag)`


`void`	`SetSetStateImage (xrstring value)`


`void`	`SetTreeGravity (uifcTreeGravity value)`


`void`	`SetTreeHeaderTextAlignment (uifcLabelAlignment value)`


`void`	`SetTreeType (uifcTreeType value)`


`void`	`SetUnsetStateImage (xrstring value)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetWidth (xint value)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Methods Inherited from Class uifcSelection:: IsInMixedState, SetInMixedState, GetTextFormat, SetTextFormat, GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetFontStyle, SetFontStyle

Method Detail

void DeleteColumnsByIndex (xintsequence_ptr columns)

Identical to DeleteColumnsByName operation but with the columns passed as indices into the ColumnNameArray attribute.

Parameters:

columns

Returns:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

void GetMostRecentCellName (xstringsequence_ptr node, xstringsequence_ptr column)

Determine the coordinates of the last entered cell of the Tree.

Parameters:

node
column

Returns:

xstringsequence_ptr GetItemsOfType (xrstring name)

Get the names of all of the nodes of the Tree which are associated with the node type of the given name.

Parameters:

name

Returns:

xstringsequence_ptr GetViewableItemNameArray (xrstring first, xrstring last)

Parameters:

first
last

Returns:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

Returns:

void DeleteColumnsByName (xstringsequence_ptr names)

Delete columns from the attribute window of the Tree. count is the number of columns to delete and names is the array of column names to delete, in any order.

Parameters:

names

Returns:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

void DeleteChild (xrstring name)

Delete a component from the parent.

Parameters:

name

Returns:

void DeleteItemByName (xrstring name)

Delete an item.

Parameters:

name

Returns:

uifcPoint_ptr GetCursorPosition ()

Get the cursor pointer position relative to the top-left corner of the node in which the cursor is contained. This should be used in response to a drag & drop callback to determine the location of the cursor within the node over which the cursor is being dragged.

Returns:

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

void InsertItem (uifcTreeItem_ptr treeitem, uifcItemPositionData_ptr item_pos_data)

Parameters:

treeitem
item_pos_data

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

void MoveColumnsByIndex (xint column, xintsequence_ptr columns)

Identical to MoveColumnsByName operation but with the columns passed as indices into the ColumnNameArray attribute, or -1 to move to the start of the array.

Parameters:

column
columns

Returns:

void DeleteItemsByName (xstringsequence_ptr names)

Delete items from the component.

Parameters:

names

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

xbool DoesItemExist (xrstring name)

Determine whether a node of the given name exists in the Tree.

Parameters:

name

Returns:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

void MoveColumnsByName (xrstring column, xstringsequence_ptr names)

Reorders the columns of the attribute window of the Tree so that the given array of columns are placed in the given order (implied by the order of names in the array) immediately after the named column. If column is given as NULL then the columns are moved to the start of the columns of the attribute window of the Tree. The list of column names can be the complete list of columns in the attribute window of the Tree. When the columns are reordered any column-related data is also reordered, i.e. the labels, widths, etc.

Parameters:

column
names

Returns:

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

xintsequence_ptr GetColumnWidthArray ()

Returns:: The widths of the columns of the attribute window of the Tree, in character widths.

void SetColumnWidthArray (xintsequence_ptr values)

Sets the widths of the columns of the attribute window of the Tree, in character widths.

Parameters:

values

Returns:

xbool DoesActivateOnReturn ()

Returns:: Flag indicating whether a RETURN key press should generate a OnItemActivate() callback (xtrue) or whether it should cause the default button in the Dialog to be pressed (xfalse).

void SetActivateOnReturn (xbool flag)

Sets flag indicating whether a RETURN key press should generate a OnItemActivate() callback (xtrue) or whether it should cause the default button in the Dialog to be pressed (xfalse).

Parameters:

flag

Returns:

xstringsequence_ptr GetSelectedItemNameArray ()

Returns:: The names of the selected items of the component.

void SetSelectedItemNameArray (xstringsequence_ptr values)

Sets the names of the selected items of the component.

Parameters:

values

Returns:

xint GetWidth ()

Returns:: The width of the Tree, in character widths.

void SetWidth (xint value)

Sets the width of the Tree, in character widths.

Parameters:

value

Returns:

xbool DoesAllowHover ()

Returns:: Flag indicating whether the attribute-window of the Tree will issue OnItemHover() callbacks.

void SetAllowHover (xbool flag)

Sets flag indicating whether the attribute-window of the Tree will issue OnItemHover() callbacks.

Parameters:

flag

Returns:

xint GetMinimumWidth ()

Returns:: The minimum width of the Tree, in character widths.

void SetMinimumWidth (xint value)

Sets the minimum width of the Tree, in character widths.

Parameters:

value

Returns:

xint GetMinimumHeight ()

Returns:: The minimum number of rows of the Tree.

void SetMinimumHeight (xint value)

Sets the minimum number of rows of the Tree.

Parameters:

value

Returns:

xstringsequence_ptr GetNodeTypeSuffixArray ()

Returns:: The text to be appended to the labels of the nodes of the node types of the Tree.

void SetNodeTypeSuffixArray (xstringsequence_ptr values)

Sets the text to be appended to the labels of the nodes of the node types of the Tree.

Parameters:

values

Returns:

xstring GetMixedStateImage ()

Returns:: The check mark image to be displayed next to a node when the state of the node is mixed.

void SetMixedStateImage (xrstring value)

Sets the check mark image to be displayed next to a node when the state of the node is mixed.

Parameters:

value

Returns:

xbool CanDrawContentDisabled ()

Returns:: Flag indicating whether the images embedded in the label of an node of the Tree should be greyed-out whenever the node is insensitive.

void SetCanDrawContentDisabled (xbool flag)

Sets flag indicating whether the images embedded in the label of an node of the Tree should be greyed-out whenever the node is insensitive.

Parameters:

flag

Returns:

xstringsequence_ptr GetNodeTypePrefixArray ()

Returns:: The text to be prepended to the labels of the nodes of the node types of the Tree.

void SetNodeTypePrefixArray (xstringsequence_ptr values)

Sets the text to be prepended to the labels of the nodes of the node types of the Tree.

Parameters:

values

Returns:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

xstring GetRootItemName ()

Returns:: The name of the root node of the Tree.

void SetRootItemName (xrstring value)

Sets the name of the root node of the Tree.

Parameters:

value

Returns:

xbool HasScrollBarsWhenNeeded ()

Returns:: Flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).

void SetHasScrollBarsWhenNeeded (xbool flag)

Sets flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).

Parameters:

flag

Returns:

xstring GetDragCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

void SetDragCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

Parameters:

value

Returns:

xstring GetFocusItemName ()

Returns:: The name of the current node of the Tree. This is the node which is drawn with a dotted focus rectangle if the Tree component has the keyboard input focus.

void SetFocusItemName (xrstring value)

Sets the name of the current node of the Tree. This is the node which is drawn with a dotted focus rectangle if the Tree component has the keyboard input focus.

Parameters:

value

Returns:

xbool DoesHorzScrollOnFocus ()

Returns:: Flag indicating whether the Tree should be automatically scrolled horizontally as well as vertically when the current node is changed.

void SetHorzScrollOnFocus (xbool flag)

Sets flag indicating whether the Tree should be automatically scrolled horizontally as well as vertically when the current node is changed.

Parameters:

flag

Returns:

xstringsequence_ptr GetViewableItemNameArray ()

Returns:

uifcTreeType GetTreeType ()

Returns:

The display type of the Tree.

TREE_TYPE_STANDARD	No check marks
TREE_TYPE_CHECKBOXES	Display check marks

void SetTreeType (uifcTreeType value)

Sets the display type of the Tree.

TREE_TYPE_STANDARD	No check marks
TREE_TYPE_CHECKBOXES	Display check marks

Parameters:

value

Returns:

xbool DoesHighlightOnDragMove ()

Returns:: Flag indicating whether the nodes of the Tree should be automatically highlighted during a drag & drop operation.

void SetHighlightOnDragMove (xbool flag)

Sets flag indicating whether the nodes of the Tree should be automatically highlighted during a drag & drop operation.

Parameters:

flag

Returns:

xstring GetDragNotValidCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

void SetDragNotValidCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over an invalid drop-site.

Parameters:

value

Returns:

uifcLabelAlignment GetTreeHeaderTextAlignment ()

Returns:

The justification of the label of the Tree if the Tree has an attribute window.

LABEL_ALIGNMENT_LEFT	Left justified
LABEL_ALIGNMENT_CENTER	Center justified
LABEL_ALIGNMENT_RIGHT	Right justified

void SetTreeHeaderTextAlignment (uifcLabelAlignment value)

Sets the justification of the label of the Tree if the Tree has an attribute window.

LABEL_ALIGNMENT_LEFT	Left justified
LABEL_ALIGNMENT_CENTER	Center justified
LABEL_ALIGNMENT_RIGHT	Right justified

Parameters:

value

Returns:

xstring GetDropItemName ()

Returns:: The name of the item beneath the pointer whilst the pointer is over the component during a drag & drop operation.

xstringsequence_ptr GetNodeTypeCloseImageArray ()

Returns:: The image to be displayed with the collapsed nodes of the node types of the Tree.

void SetNodeTypeCloseImageArray (xstringsequence_ptr values)

Sets the image to be displayed with the collapsed nodes of the node types of the Tree.

Parameters:

values

Returns:

uifcColor_ptr GetAlternateRowColor ()

Returns:: The color of alternate lines of the Tree as a uifcColor.

void SetAlternateRowColor (uifcColor_ptr color)

Sets the color of alternate lines of the Tree as a uifcColor.

Parameters:

color

Returns:

xbool CanRedraw ()

Returns:: Flag indicating whether redraws are allowed in the Tree.

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are allowed in the Tree.

Parameters:

flag

Returns:

xbool IsValidDragSite ()

Returns:: Flag indicating whether the component can be dragged to start a drag & drop operation.

void SetValidDragSite (xbool flag)

Sets flag indicating whether the component can be dragged to start a drag & drop operation.

Parameters:

flag

Returns:

xint GetImageWidth ()

Returns:: The width of the images of the Tree, in pixels

void SetImageWidth (xint value)

Sets the width of the images of the Tree, in pixels

Parameters:

value

Returns:

uifcScrollBarPosition GetScrollBarPosition ()

Returns:

The position of the scrollbars of the component.

SCROLLBAR_POSITION_CENTER	No scrollbars
SCROLLBAR_POSITION_TOP	A horizontal scrollbar at the top
SCROLLBAR_POSITION_BOTTOM	A horizontal scrollbar at the bottom
SCROLLBAR_POSITION_LEFT	A vertical scrollbar at the left
SCROLLBAR_POSITION_RIGHT	A vertical scrollbar at the right
SCROLLBAR_POSITION_TOP_LEFT	A horizontal scrollbar at the top and a vertical scrollbar at the left
SCROLLBAR_POSITION_TOP_RIGHT	A horizontal scrollbar at the top and a vertical scrollbar at the right
SCROLLBAR_POSITION_BOTTOM_LEFT	A horizontal scrollbar at the bottom and a vertical scrollbar at the left
SCROLLBAR_POSITION_BOTTOM_RIGHT	A horizontal scrollbar at the bottom and a vertical scrollbar at the right

void SetScrollBarPosition (uifcScrollBarPosition value)

Sets the position of the scrollbars of the component.

SCROLLBAR_POSITION_CENTER	No scrollbars
SCROLLBAR_POSITION_TOP	A horizontal scrollbar at the top
SCROLLBAR_POSITION_BOTTOM	A horizontal scrollbar at the bottom
SCROLLBAR_POSITION_LEFT	A vertical scrollbar at the left
SCROLLBAR_POSITION_RIGHT	A vertical scrollbar at the right
SCROLLBAR_POSITION_TOP_LEFT	A horizontal scrollbar at the top and a vertical scrollbar at the left
SCROLLBAR_POSITION_TOP_RIGHT	A horizontal scrollbar at the top and a vertical scrollbar at the right
SCROLLBAR_POSITION_BOTTOM_LEFT	A horizontal scrollbar at the bottom and a vertical scrollbar at the left
SCROLLBAR_POSITION_BOTTOM_RIGHT	A horizontal scrollbar at the bottom and a vertical scrollbar at the right

Parameters:

value

Returns:

xstringsequence_ptr GetNodeTypeHelpTextArray ()

Returns:: The help text of the nodes of the node types of the Tree.

void SetNodeTypeHelpTextArray (xstringsequence_ptr values)

Sets the help text of the nodes of the node types of the Tree.

Parameters:

values

Returns:

xbool DoesItemSelectOnRMB ()

Returns:: Flag to indicate whether the Tree should select the node over which the right mouse button is clicked.

void SetItemSelectOnRMB (xbool flag)

Sets flag to indicate whether the Tree should select the node over which the right mouse button is clicked.

Parameters:

flag

Returns:

xbool DoesAutoOpenAndClose ()

Returns:: Flag indicating whether the Tree should automatically expand or collapse nodes when their +/- control box is clicked.

void SetAutoOpenAndClose (xbool flag)

Sets flag indicating whether the Tree should automatically expand or collapse nodes when their +/- control box is clicked.

Parameters:

flag

Returns:

xbool DoesItemSelectWhenSelected ()

Returns:: Flag indicating whether the Tree should generate a OnItemSelect() callback when the currently selected item is re-selected (xtrue) or whether such a selection should be ignored as the state has not changed.

void SetItemSelectWhenSelected (xbool flag)

Sets flag indicating whether the Tree should generate a OnItemSelect() callback when the currently selected item is re-selected (xtrue) or whether such a selection should be ignored as the state has not changed.

Parameters:

flag

Returns:

xint GetItemSelectionDelay ()

Returns:: The delay time in milliseconds which the Tree should allow to elapse before issuing a OnItemSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnItemSelect() callback, but without adversely interfering with the keyboard navigation and RMB user-model.
A value < 0 signifies that the system-defined double-click time should be used, to allow the user the opportunity to perform a OnItemActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnItemSelect() callback to be processed by the application.

void SetItemSelectionDelay (xint value)

Sets the delay time in milliseconds which the Tree should allow to elapse before issuing a OnItemSelect() callback.
This is designed to allow applications to implement lengthy operations triggered from a OnItemSelect() callback, but without adversely interfering with the keyboard navigation and RMB user-model.
A value < 0 signifies that the system-defined double-click time should be used, to allow the user the opportunity to perform a OnItemActivate() via a left-mouse-button double-click, without being hindered by the length of time taken for the preceding OnItemSelect() callback to be processed by the application.

Parameters:

value

Returns:

xstringsequence_ptr GetNodeTypeOpenImageArray ()

Returns:: The image to be displayed with the expanded nodes of the node types of the Tree.

void SetNodeTypeOpenImageArray (xstringsequence_ptr values)

Sets the image to be displayed with the expanded nodes of the node types of the Tree.

Parameters:

values

Returns:

xbool CanPopupHelpText ()

Returns:: Flag indicating whether popup help text should be displayed over the Tree.

void SetCanPopupHelpText (xbool flag)

Sets flag indicating whether popup help text should be displayed over the Tree.

Parameters:

flag

Returns:

xint GetImageHeight ()

Returns:: The height of the images of the Tree, in pixels

void SetImageHeight (xint value)

Sets the height of the images of the Tree, in pixels

Parameters:

value

Returns:

xbool IsSelectionVisible ()

Returns:: Flag to indicate the color of highlighted items in a Tree that doesn't have the focus. If xtrue the highlight color is blue. If xfalse the highlight color is grey.

void SetSelectionVisible (xbool flag)

Sets flag to indicate the color of highlighted items in a Tree that doesn't have the focus. If xtrue the highlight color is blue. If xfalse the highlight color is grey.

Parameters:

flag

Returns:

xbool DoesAutoCheck ()

Returns:: Flag indicating whether the Tree should automatically keep track of the checked state of its nodes when TreeType attribute is set to LIST_TYPE_CHECKBOXES.

void SetAutoCheck (xbool flag)

Sets flag indicating whether the Tree should automatically keep track of the checked state of its nodes when TreeType attribute is set to LIST_TYPE_CHECKBOXES.

Parameters:

flag

Returns:

xstring GetUnsetStateImage ()

Returns:: The check mark image to be displayed next to a node when the state of the node is False.

void SetUnsetStateImage (xrstring value)

Sets the check mark image to be displayed next to a node when the state of the node is False.

Parameters:

value

Returns:

xstring GetMostRecentItemName ()

Returns:: The item which was beneath the pointer the last time the pointer was over the component.

xstring GetSetStateImage ()

Returns:: The check mark image to be displayed next to a node when the state of the node is True.

void SetSetStateImage (xrstring value)

Sets the check mark image to be displayed next to a node when the state of the node is True.

Parameters:

value

Returns:

xint GetHeight ()

Returns:: The number of rows of the Tree.

void SetHeight (xint value)

Sets the number of rows of the Tree.

Parameters:

value

Returns:

uifcSelectionPolicy GetItemSelectionPolicy ()

Returns:

The selection policy of the component.

NO_SELECTION_POLICY	No selected items
SELECTION_POLICY_SINGLE	1 or 0 selected items
SELECTION_POLICY_BROWSE	Always 1 selected item
SELECTION_POLICY_MULTIPLE	Any number of selected items
SELECTION_POLICY_EXTENDED	Any number of selected items, including support for range selection

void SetItemSelectionPolicy (uifcSelectionPolicy value)

Sets the selection policy of the component.

NO_SELECTION_POLICY	No selected items
SELECTION_POLICY_SINGLE	1 or 0 selected items
SELECTION_POLICY_BROWSE	Always 1 selected item
SELECTION_POLICY_MULTIPLE	Any number of selected items
SELECTION_POLICY_EXTENDED	Any number of selected items, including support for range selection

Parameters:

value

Returns:

xbool DoesScrollOnKeyboardInput ()

Returns:: Flag indicating whether the Tree should automatically scroll to the first node whose label has the initial letter keyed by the user when the user presses a printable character key.

void SetScrollOnKeyboardInput (xbool flag)

Sets flag indicating whether the Tree should automatically scroll to the first node whose label has the initial letter keyed by the user when the user presses a printable character key.

Parameters:

flag

Returns:

uifcTreeGravity GetTreeGravity ()

Returns:

The gravity of the Tree, which is used to determine where the sash divider should be placed after the Tree is resized.

TREE_GRAVITY_FIRST	The sash maintains its position relative to the tree
NO_TREE_GRAVITY	The sash maintains its percentage position between both areas
TREE_GRAVITY_SECOND	The sash maintains its position relative to the attribute window

void SetTreeGravity (uifcTreeGravity value)

Sets the gravity of the Tree, which is used to determine where the sash divider should be placed after the Tree is resized.

TREE_GRAVITY_FIRST	The sash maintains its position relative to the tree
NO_TREE_GRAVITY	The sash maintains its percentage position between both areas
TREE_GRAVITY_SECOND	The sash maintains its position relative to the attribute window

Parameters:

value

Returns:

xstringsequence_ptr GetNodeTypeNameArray ()

Returns:: The names of the node types of the Tree.

void SetNodeTypeNameArray (xstringsequence_ptr values)

Sets the names of the node types of the Tree.

Parameters:

values

Returns:

xstring GetOpenCloseItemName ()

Returns:: The name of the node of the Tree which was expanded or collapsed to generate a OnItemOpen() or a OnItemClose(), respectively.

xbool HasBorder ()

Returns:: Flag indicating whether the Tree has a decorated shadow border.

void SetHasBorder (xbool flag)

Sets flag indicating whether the Tree has a decorated shadow border.

Parameters:

flag

Returns:

xbool IsRootItemVisible ()

Returns:: Flag indicating whether the root node of the Tree should be displayed (xtrue) or whether it should be hidden from view (xfalse).

void SetRootItemVisible (xbool flag)

Sets flag indicating whether the root node of the Tree should be displayed (xtrue) or whether it should be hidden from view (xfalse).

Parameters:

flag

Returns:

void AddActionListener (uifcTreeListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcTreeAction action)

Parameters:

action

Returns:

void CreateTimer (uifcTreeTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

void StartTimer (xrstring timerName, xint duration)

Parameters:

timerName
duration

Returns:

void StopTimer (xrstring timerName)

Parameters:

timerName

Returns: