NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::BlockStyler::Node Class Reference

Represents the node created and utilized by BlockStyler::Tree . More...

Inheritance diagram for NXOpen::BlockStyler::Node:
NXOpen::TaggedObject

List of all members.

Public Types

enum  DragType { DragTypeNone, DragTypeAll }
 Represents the drag type. More...
enum  DropType {
  DropTypeNone, DropTypeOn, DropTypeBefore, DropTypeAfter,
  DropTypeBeforeAndAfter
}
 Represents the drop type. More...
enum  ExpandOption { ExpandOptionCollapse, ExpandOptionExpand, ExpandOptionToggle }
 Represents the Expand/Collapse option. More...
enum  Scroll { ScrollCenter, ScrollLeastScroll, ScrollMostScroll }
 Represents the scroll position to be applied on node. More...

Public Member Functions

bool CrossSelection ()
 Returns the flag indicating whether cross section is allowed.
NXString DisplayIcon ()
 Returns the display icon.
NXString DisplayText ()
 Returns the display text of node.
void Expand (NXOpen::BlockStyler::Node::ExpandOption expandOption)
 Expands/collapses the node
Created in NX7.5.0.
NXOpen::BlockStyler::NodeFirstChildNode ()
 Returns the first child node.
int ForegroundColor ()
 Returns the text color of the node.
NXString GetColumnDisplayText (int columnID)
 Gets the column text for the given columnId.
NXOpen::DataContainerGetNodeData ()
 Gets node data which contains the data in the form of unique name-value pairs.
int GetState ()
 Gets the node state associated with node state icon.
bool IsExpanded ()
 Returns the flag indicating whether the node is in expanded state
Created in NX7.5.3.
bool IsInserted ()
 Returns the flag indicating whether the node is inserted in BlockStyler::Tree
Created in NX7.5.0.
bool IsSelected ()
 Returns the flag indicating whether the node is in selected state
Created in NX7.5.3.
NXOpen::BlockStyler::NodeNextNode ()
 Returns the next node which might not belong to the same hierarchy.
NXOpen::BlockStyler::NodeNextSelectedNode ()
 Returns the next selected node in the whole tree hierarchy.
NXOpen::BlockStyler::NodeNextSiblingNode ()
 Returns the next node which belongs to the same hierarchy.
NXOpen::BlockStyler::NodeParentNode ()
 Returns the parent node.
NXOpen::BlockStyler::NodePreviousNode ()
 Returns the previous node which might not belong to the same hierarchy.
NXOpen::BlockStyler::NodePreviousSelectedNode ()
 Returns the previous selected node in the whole tree hierarchy.
NXOpen::BlockStyler::NodePreviousSiblingNode ()
 Returns the previous node which belongs to the same hierarchy.
void ScrollTo (int columnID, NXOpen::BlockStyler::Node::Scroll visibleOption)
 Scrolls horizontally and vertically to make the specific column of node appear on the tree window.
NXString SelectedIcon ()
 Returns the selected icon.
void SetColumnDisplayText (int columnID, const NXString &columnDisplayText)
 Sets the text in the column which corresponds to given columnId.
void SetCrossSelection (bool crossSelection)
 Sets the flag indicating whether cross section is allowed.
void SetDisplayIcon (const NXString &icon)
 Sets the display icon.
void SetDisplayText (const NXString &displayTest)
 Sets the display text of node.
void SetForegroundColor (int nodeForgroundColor)
 Sets the text color of the node.
void SetSelectedIcon (const NXString &icon)
 Sets the selected icon.
void SetState (int state)
 Sets the node state which is associated with node state icon.

Detailed Description

Represents the node created and utilized by BlockStyler::Tree .

The node represents the single row of the tree.
Created in NX7.5.0.


Member Enumeration Documentation

Represents the drag type.

Enumerator:
DragTypeNone 

No drag.

DragTypeAll 

Drag allowed to any level in the same tree.

Represents the drop type.

Enumerator:
DropTypeNone 

Drop not permitted.

DropTypeOn 

Drop permitted on the target node.

DropTypeBefore 

Drop permitted before the target node.

DropTypeAfter 

Drop permitted after the target node.

DropTypeBeforeAndAfter 

Drop permitted before and after the target node.

Represents the Expand/Collapse option.

Enumerator:
ExpandOptionCollapse 

Use this option to collapse the node.

ExpandOptionExpand 

Use this option to expand the node.

The child node state is unaltered.

ExpandOptionToggle 

Use this option to collapse the expanded node or expand the collapsed node.

Represents the scroll position to be applied on node.

Use one of these options to make the node appear in tree window.

Enumerator:
ScrollCenter 

Scrolls the tree to bring the node at the center of the tree window.

ScrollLeastScroll 

Scrolls the tree to minimal to make the node appear in tree window.

ScrollMostScroll 

Scrolls the tree to maximum to make the node appear in tree window.


Member Function Documentation

Returns the flag indicating whether cross section is allowed.

It is useful when the node contains DisplayableObject as data. If the flag is true then the DisplayableObject is highlighted, else not. The default value is True
Created in NX7.5.0.

License requirements : None

Returns the display icon.

This is normal icon positioned before the node text and is displayed when the node is in unselected state.
Created in NX7.5.0.

License requirements : None

Returns the display text of node.

This is same as 0th column text of this node. Use BlockStyler::Node::SetColumnDisplayText to fetch the text of other column of the same node.
Created in NX7.5.0.

License requirements : None

Expands/collapses the node
Created in NX7.5.0.



License requirements : None

Parameters:
expandOptionExpand option

Returns the first child node.

Returns NULL if child node is not present.
Created in NX7.5.0.

License requirements : None

Returns the text color of the node.

The color is applicable for whole row.
Created in NX7.5.0.

License requirements : None

Gets the column text for the given columnId.

The text is interpreted as icon if the column display type is BlockStyler::Tree::ColumnDisplayIcon .

Returns:
Text associated with column.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column id of the column.

Gets node data which contains the data in the form of unique name-value pairs.

In this context unique name is termed as property name. There could me more than one such property name - value pair, but the property name of the primary data should be named "Data" (case-sensitive). For instance, if a BlockStyler::Node represents a feature object then property name should be "Data" and the value should be feature object. The primary data is used by NX for some operations such cross selection.


Initialy the container or list is empty and it is expected that data would be added to it. Additional property name - value pair can be added to the container or list, but it should be made sure that there is no dublicate property name exists in the container or list. The additional data can be seen as book keeping information for node. At any point the node data can be fetched and value can be extracted using the corresponding property name. Refer to DataContainer on how property name-value pair is added to the container or list.

Returns:
Node data which is list of property name - value pair. New property name - value pair can be added to it and existing value can be fetched using corresponding property name.
Created in NX7.5.0.

License requirements : None

Gets the node state associated with node state icon.

Node state is an iconic representation, e.g., checked/unchecked icons for corresponding state. Node state value 1 and 2 represents the standard checked and unchecked state respectively.

Returns:
Node state
Created in NX7.5.0.

License requirements : None

Returns the flag indicating whether the node is in expanded state
Created in NX7.5.3.



License requirements : None

Returns the flag indicating whether the node is inserted in BlockStyler::Tree
Created in NX7.5.0.



License requirements : None

Returns the flag indicating whether the node is in selected state
Created in NX7.5.3.



License requirements : None

Returns the next node which might not belong to the same hierarchy.

The next node either is a sibling node or belongs to other root node. Returns NULL if next node is not present
Created in NX7.5.0.

License requirements : None

Returns the next selected node in the whole tree hierarchy.

The node on which this method is called does not have to be selected. Returns NULL if none of the next nodes are selected.
Created in NX7.5.0.

License requirements : None

Returns the next node which belongs to the same hierarchy.

Returns NULL null if next sibling node is not present.
Created in NX7.5.0.

License requirements : None

Returns the parent node.

Returns NULL if parent node is not present
Created in NX7.5.0.

License requirements : None

Returns the previous node which might not belong to the same hierarchy.

Returns NULL null if previous node is not present
Created in NX7.5.0.

License requirements : None

Returns the previous selected node in the whole tree hierarchy.

The node on which this method is called does not have to be selected. Returns NULL if none of the previous nodes are selected.
Created in NX7.5.0.

License requirements : None

Returns the previous node which belongs to the same hierarchy.

Returns NULL if previous sibling node is not present.
Created in NX7.5.0.

License requirements : None

void NXOpen::BlockStyler::Node::ScrollTo ( int  columnID,
NXOpen::BlockStyler::Node::Scroll  visibleOption 
)

Scrolls horizontally and vertically to make the specific column of node appear on the tree window.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDColumnId of the column to which tree window scrolls horizontally.
visibleOptionOption to scroll the tree window vertically.

Returns the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler::Node::DisplayIcon and BlockStyler::Node::SetDisplayIcon .
Created in NX7.5.0.

License requirements : None

void NXOpen::BlockStyler::Node::SetColumnDisplayText ( int  columnID,
const NXString columnDisplayText 
)

Sets the text in the column which corresponds to given columnId.

The text is interpreted as icon if the column display type is BlockStyler::Tree::ColumnDisplayIcon .
Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique coulmn id of the column.
columnDisplayTextText associated with column
void NXOpen::BlockStyler::Node::SetCrossSelection ( bool  crossSelection)

Sets the flag indicating whether cross section is allowed.

It is useful when the node contains DisplayableObject as data. If the flag is true then the DisplayableObject is highlighted, else not. The default value is True
Created in NX7.5.0.

License requirements : None

Parameters:
crossSelectionFlag indicating whether cross selection is allowed.

Sets the display icon.

This is normal icon positioned before the node text and is displayed when the node is in unselected state.
Created in NX7.5.0.

License requirements : None

Parameters:
iconIcon.
void NXOpen::BlockStyler::Node::SetDisplayText ( const NXString displayTest)

Sets the display text of node.

This is same as 0th column text of this node. Use BlockStyler::Node::SetColumnDisplayText to fetch the text of other column of the same node.
Created in NX7.5.0.

License requirements : None

Parameters:
displayTestDisplay text
void NXOpen::BlockStyler::Node::SetForegroundColor ( int  nodeForgroundColor)

Sets the text color of the node.

The color is applicable for whole row.
Created in NX7.5.0.

License requirements : None

Parameters:
nodeForgroundColorForeground color.

Sets the selected icon.

This icon appears on node selection and is positioned before the node text replacing the BlockStyler::Node::DisplayIcon and BlockStyler::Node::SetDisplayIcon .
Created in NX7.5.0.

License requirements : None

Parameters:
iconIcon.

Sets the node state which is associated with node state icon.

Node state is an iconic representation, e.g., checked/unchecked state. Setting node state to value other than 1 and 2 calls BlockStyler.Tree.StateIconName callback to fetch the icon name.
Created in NX7.5.0.

License requirements : None

Parameters:
stateNode state

The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.