XmHierarchy - Man Page

Hierarchy inherits behaviour, resources, and traits from Core, Composite, Composite, Constraint, and XmManager classes.

The class pointer is xmHierarchyWidgetClass.

The class name is XmHierarchy.

XmNautoClose

This resource determines if the hierarchy should automatically restore a parent  node's children when the parent node is reopened. If autoClose is False, and the  hierarchy is fully expanded when the root node is closed, then the entire hierarchy  will be displayed as expanded when the root node is reopened. If autoClose is  True, then the root node's children are closed when the root node is reopened.

XmNcloseFolderPixmap

This resource defines a pixmap for the closed representation of the folder pixmap to be used throughout the tree. It can be a color pixmap or bitmap. If the user does not specify a pixmap the default bitmap will be used.

XmNhorizontalMargin

XmNverticalMargin

The exact definition of these resources are left to the subclass of the hierarchy  widget that does the geometry layout. They are intended to be used as the amount  of space between the object and the edges of the window it is displayed in. They  are included here for consistency.

XmNopenFolderPixmap

This resource defines a pixmap for the open representation of the folder pixmap to be used throughout the tree . It can be a color pixmap or bitmap. If the user does not specify a pixmap the default opened folder bitmap.

XmNnodeStateCallback

The list of callback routines called when a folder button is clicked. See "Callback Routine" for more details.

XmNrefigureMode

This resource determines whether the Hierarchy should adjust the sizes of the  children after a geometry or resize request, or simply ignore the request. This  resource is very useful in improving the performance of an application that is  making a large number of geometry changes all at once.

XmHierarchy Constraint Resource Set
Name	Class	Type	Default	Access
XmNinsertBefore	XmCInsertbefore	Widget	NULL	CSG
XmNnodeState	XmCNodeState	XMHierarchyNodeState	XmOpen	CSG
XmNparentNode	XmCParentNode	Widget	NULL	CSG

XmNinsertBefore

Specifies another node that has the same parentNode. This node will then be  placed immediately before that node in the hierarchy. If this value is NULL then  the node will be inserted at the end of the list. This resource allows the hierarchy's  children to be reordered.

XmNnodeState

The state of this node. Acceptable values are: XmOpen, XmClosed, XmAlwaysOpen,  and XmHidden. A type converter has been registered that can convert the  following strings: "open", "close", "alwaysOpen", and "hidden".

XmNparentNode

The hierarchy parent of this node. The parent node MUST be a widget sibling of  the current node.

Hierarchy inherits behavior and resources from the superclasses described in the following tables. For a complete description of each resource, refer to the reference page for that superclass.

When a folder is clicked, the routines registered on the XmNnodeStateCallback list are passed a pointer to the following structure as client data:

typedef struct _XmHierarchyNodeStateData {
	Widget widget;
	XmHierarchyNodeState state;
} XmHierarchyNodeStateData;
widget
    the child node of Hierarchy being opened or closed.
    state
    the current XmNnodeState (after the click) of the 
    node. Legal values are XmOpen, XmClosed, XmAlwaysOpen, 
    and XmHidden.

The hierarchy maintains IconButtons for each node in the hierarchy. Setting openFolderPixmap or closeFolderPixmap is done through XtSetValues. IconButtons may only be manipulated by the Hierarchy.