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

Represents the Tree block in block styler automation. More...

Inheritance diagram for NXOpen::BlockStyler::Tree:
NXOpen::BlockStyler::UIBlock NXOpen::TaggedObject

List of all members.

Public Types

typedef NXOpen::Callback3
< NXOpen::BlockStyler::Tree::ControlType,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
AskEditControlCallback
 Represents the callback which gets called when edit is attempted on any cell.
enum  BeginLabelEditState { BeginLabelEditStateAllow, BeginLabelEditStateDisallow }
 Represents the state to allow/disallow the node label edit. More...
enum  ColumnDisplay { ColumnDisplayText, ColumnDisplayIcon }
 Represents the column display type. More...
enum  ColumnResizePolicy { ColumnResizePolicyConstantWidth, ColumnResizePolicyResizeWithContents, ColumnResizePolicyResizeWithTree }
 Represents column resize policy. More...
typedef NXOpen::Callback4< int,
NXOpen::BlockStyler::Tree
*, int,
NXOpen::BlockStyler::Node
*, NXOpen::BlockStyler::Node * > 
ColumnSortCallback
 Represents the callback which gets called when column sort is attempted.
enum  ColumnSortOption { ColumnSortOptionUnsorted, ColumnSortOptionAscending, ColumnSortOptionDescending }
 Represents the column sort option. More...
enum  ControlType { ControlTypeNone, ControlTypeComboBox, ControlTypeListBox }
 Represents the type of edit options. More...
enum  EditControlOption { EditControlOptionAccept, EditControlOptionReject }
 Represents the options to accept or reject the changed value. More...
enum  EndLabelEditState { EndLabelEditStateAcceptText, EndLabelEditStateRejectText }
 Represents the state to accept/reject the edited label of node. More...
typedef NXOpen::Callback3
< NXOpen::BlockStyler::Node::DragType,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
IsDragAllowedCallback
 Represents the callback which gets called when node is dragged.
typedef NXOpen::Callback5
< NXOpen::BlockStyler::Node::DropType,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int,
NXOpen::BlockStyler::Node
*, int > 
IsDropAllowedCallback
 Represents the callback which gets called when an attempt is made to drop the node on any target node.
enum  NodeInsertOption {
  NodeInsertOptionFirst, NodeInsertOptionLast, NodeInsertOptionSort, NodeInsertOptionAlwaysFirst,
  NodeInsertOptionAlwaysLast
}
 Represents the node insert option which is used while inserting the node in tree. More...
typedef NXOpen::Callback3
< NXOpen::BlockStyler::Tree::BeginLabelEditState,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnBeginLabelEditCallback
 Represents the callback which gets called when label edit is attempted on any column.
typedef NXOpen::Callback3
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnDefaultActionCallback
 Represents the callback which gets called when double clicked is performed on the node.
typedef NXOpen::Callback2
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node * > 
OnDeleteNodeCallback
 Represents the callback which gets called when the node is deleted from tree.
typedef NXOpen::Callback7
< bool,
NXOpen::BlockStyler::Tree
*, std::vector
< NXOpen::BlockStyler::Node * >
, int,
NXOpen::BlockStyler::Node
*, int,
NXOpen::BlockStyler::Node::DropType,
int > 
OnDropCallback
 Represents the callback which gets called when nodes are dropped on any target node.
typedef NXOpen::Callback5
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int,
NXOpen::BlockStyler::Node
*, int > 
OnDropMenuCallback
 Represents the callback to show the menu when nodes are dragged using MB3 or right mouse click, and dropped on any target node.
typedef NXOpen::Callback6
< NXOpen::BlockStyler::Tree::EditControlOption,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int, int, NXString,
NXOpen::BlockStyler::Tree::ControlType
OnEditOptionSelectedCallback
 Represents the callback which gets called when user selects an option in edit-control set by BlockStyler.Tree.AskEditControlCallback.
typedef NXOpen::Callback4
< NXOpen::BlockStyler::Tree::EndLabelEditState,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int, NXString
OnEndLabelEditCallback
 Represents the callback which gets called when label edit is completed on any column.
typedef NXOpen::Callback2
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node * > 
OnExpandCallback
 Represents the callback which gets called when the node is expanded.
typedef NXOpen::Callback3
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnInsertColumnCallback
 Represents the callback which gets called for each node when the column is inserted using BlockStyler::Tree::InsertColumn .
typedef NXOpen::Callback2
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node * > 
OnInsertNodeCallback
 Represents the callback which gets called when the node is inserted.
typedef NXOpen::Callback3
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnMenuCallback
 Represents the callback which gets called when MB3 or right click is attempted on node or tree.
typedef NXOpen::Callback3
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnMenuSelectionCallback
 Represents the callback which gets called when one of the menu option is selected.
typedef NXOpen::Callback4
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int, bool > 
OnPreSelectCallback
 Represents the callback which gets called when pre selection is attempted on node.
typedef NXOpen::Callback4
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int, bool > 
OnSelectCallback
 Represents the callback which gets called when the node is selected.
typedef NXOpen::Callback3
< void,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
OnStateChangeCallback
 Represents the callback which gets called when the state icon is clicked.
typedef NXOpen::Callback3
< NXString,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
StateIconNameCallback
 Represents the callback which gets called when the node state is set by BlockStyler::Node::SetState and the corresponding state icon of node state is not known.
typedef NXOpen::Callback3
< NXString,
NXOpen::BlockStyler::Tree
*, NXOpen::BlockStyler::Node
*, int > 
ToolTipTextCallback
 Represents the callback which gets called when tree seeks the tooltip.

Public Member Functions

NXOpen::BlockStyler::NodeCopyNode (NXOpen::BlockStyler::Node *sourceNode)
 Copies the existing BlockStyler::Node .
NXOpen::BlockStyler::TreeListMenuCreateMenu ()
 Creates the menu.
NXOpen::BlockStyler::NodeCreateNode (const NXString &displayText)
 Creates the node but does not insert it.
void DeleteNode (NXOpen::BlockStyler::Node *node)
 Deletes the node from tree.
NXOpen::BlockStyler::NodeFirstSelectedNode ()
 Returns the first selected node among the available selected nodes.
NXOpen::BlockStyler::Tree::ColumnDisplay GetColumnDisplayType (int columnID)
 Gets the display type of the column.
int GetColumnId (int columnPosition)
 Gets the column Id for the provided column position.
int GetColumnPosition (int columnID)
 Gets column position.
NXOpen::BlockStyler::Tree::ColumnResizePolicy GetColumnResizePolicy (int columnID)
 Gets the column resize policy.
bool GetColumnSortable (int columnID)
 Gets the flag indicating whether the column is sortable.
NXOpen::BlockStyler::Tree::ColumnSortOption GetColumnSortOption (int columnID)
 Gets the column sort option.
NXString GetColumnTitle (int columnID)
 Gets the column title.
bool GetColumnVisible (int columnID)
 Gets the flag indicating whether the column is visible.
int GetColumnWidth (int columnID)
 Gets column width.
std::vector
< NXOpen::BlockStyler::Node * > 
GetSelectedNodes ()
 Gets the selected nodes.
int InsertColumn (int columnID, const NXString &columnTitle, int columnWidth)
 Inserts column with following defaults:

void InsertNode (NXOpen::BlockStyler::Node *newNode, NXOpen::BlockStyler::Node *parentNode, NXOpen::BlockStyler::Node *afterNode, NXOpen::BlockStyler::Tree::NodeInsertOption nodeInsertOption)
 Inserts the node.
int NumberOfColumns ()
 Returns the number of column inserted in the tree.
void Redraw (bool redraw)
 Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point.
NXOpen::BlockStyler::NodeRootNode ()
 Returns the root node.
void SelectNode (NXOpen::BlockStyler::Node *node, bool isSelect, bool isOtherNodeAffected)
 Selects the provided node.
void SelectNodes (const std::vector< NXOpen::BlockStyler::Node * > &node, bool isSelect, bool isOtherNodeAffected)
 Selects the provided nodes.
void SetAskEditControlHandler (const NXOpen::BlockStyler::Tree::AskEditControlCallback &cb)
 Sets the node-edit-control callback
Created in NX7.5.0.
void SetColumnDisplayType (int columnID, NXOpen::BlockStyler::Tree::ColumnDisplay displayType)
 Sets the display type of the column.
void SetColumnResizePolicy (int columnID, NXOpen::BlockStyler::Tree::ColumnResizePolicy resizePolicy)
 Sets the column resize policy.
void SetColumnSortable (int columnID, bool isSortable)
 Sets the flag indicating whether the column is sortable.
void SetColumnSortHandler (const NXOpen::BlockStyler::Tree::ColumnSortCallback &cb)
 Sets the column sort callback.
void SetColumnSortOption (int columnID, NXOpen::BlockStyler::Tree::ColumnSortOption sortOption)
 Sets the column sort option.
void SetColumnTitle (int columnID, const NXString &columnHeaderTitle)
 Sets the column title.
void SetColumnVisible (int columnID, bool isVisible)
 Sets the flag indicating whether the column is visible
Created in NX7.5.0.
void SetColumnWidth (int columnID, int columnWidth)
 Sets the column width
Created in NX7.5.0.
void SetEditOptions (std::vector< NXString > &stringArray, int defaultIndex)
 Sets the options in edit-control.
void SetIsDragAllowedHandler (const NXOpen::BlockStyler::Tree::IsDragAllowedCallback &cb)
 Sets the callback handler for node drag
Created in NX7.5.0.
void SetIsDropAllowedHandler (const NXOpen::BlockStyler::Tree::IsDropAllowedCallback &cb)
 Sets the callback handler for node drop
Created in NX7.5.0.
void SetMenu (NXOpen::BlockStyler::TreeListMenu *menu)
 Sets the menu, resulting the menu to appear on the screen.
void SetOnBeginLabelEditHandler (const NXOpen::BlockStyler::Tree::OnBeginLabelEditCallback &cb)
 Sets the on-begin-label-edit callback
Created in NX7.5.0.
void SetOnDefaultActionHandler (const NXOpen::BlockStyler::Tree::OnDefaultActionCallback &cb)
 Sets the on select node callback
Created in NX7.5.2.
void SetOnDeleteNodeHandler (const NXOpen::BlockStyler::Tree::OnDeleteNodeCallback &cb)
 Sets on delete node callback
Created in NX6.0.0.
void SetOnDropHandler (const NXOpen::BlockStyler::Tree::OnDropCallback &cb)
 Sets the callback handler for node drop
Created in NX7.5.0.
void SetOnDropMenuHandler (const NXOpen::BlockStyler::Tree::OnDropMenuCallback &cb)
 Sets the callback handler for on drop menu.
void SetOnEditOptionSelectedHandler (const NXOpen::BlockStyler::Tree::OnEditOptionSelectedCallback &cb)
 Sets the on-end-label-edit callback
Created in NX7.5.0.
void SetOnEndLabelEditHandler (const NXOpen::BlockStyler::Tree::OnEndLabelEditCallback &cb)
 Sets the on-end-label-edit callback
Created in NX7.5.0.
void SetOnExpandHandler (const NXOpen::BlockStyler::Tree::OnExpandCallback &cb)
 Sets the on expand callback to the tree.
void SetOnInsertColumnHandler (const NXOpen::BlockStyler::Tree::OnInsertColumnCallback &cb)
 Sets the on insert column callback to the tree.
void SetOnInsertNodeHandler (const NXOpen::BlockStyler::Tree::OnInsertNodeCallback &cb)
 Sets the on insert node callback.
void SetOnMenuHandler (const NXOpen::BlockStyler::Tree::OnMenuCallback &cb)
 Sets the on menu callback
Created in NX7.5.0.
void SetOnMenuSelectionHandler (const NXOpen::BlockStyler::Tree::OnMenuSelectionCallback &cb)
 Sets the on menu selection callback
Created in NX7.5.0.
void SetOnPreSelectHandler (const NXOpen::BlockStyler::Tree::OnPreSelectCallback &cb)
 Sets on pre select callback
Created in NX7.5.0.
void SetOnSelectHandler (const NXOpen::BlockStyler::Tree::OnSelectCallback &cb)
 Sets the on select node callback
Created in NX7.5.0.
void SetOnStateChangeHandler (const NXOpen::BlockStyler::Tree::OnStateChangeCallback &cb)
 Sets the on state change callback.
void SetPreSelectionTimeOut (double timeOut)
 Sets the pre selection time out.
void SetStateIconNameHandler (const NXOpen::BlockStyler::Tree::StateIconNameCallback &cb)
 Sets the state icon name callback.
void SetToolTipTextHandler (const NXOpen::BlockStyler::Tree::ToolTipTextCallback &cb)
 Sets the tool tip callback.

Detailed Description

Represents the Tree block in block styler automation.

To start utilizing the tree use methods such as BlockStyler::Tree::InsertColumn , BlockStyler::Tree::CreateNode , BlockStyler::Tree::InsertNode etc. It is must to insert the column on the tree before inserting any node. Node can be created but cannot be inserted without the column available on the tree. Note that some of the methods of this class such as BlockStyler::Tree::InsertColumn must be used in or after the BlockStyler.BlockDialog.DialogShown callback after which tree is fully constructed and ready for use.
Created in NX7.5.0.


Member Typedef Documentation

Represents the callback which gets called when edit is attempted on any cell.

Edit-control is made available on the cell based on control type returned by this callback.

Use BlockStyler::Tree::SetEditOptions in this callback to show the options in the edit-control. Further BlockStyler.Tree.OnEditOptionSelectedCallback is called when option is selected.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when column sort is attempted.

The possible return values are 0, positive and negative value, suggesting respectively that both nodes are same, first node greater than second, and first node smaller than second.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when node is dragged.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when an attempt is made to drop the node on any target node.

If multiple nodes are selected and dragged then this callback is invoked for each of the selected nodes.

If node is dragged using MB3 then the callback BlockStyler.Tree.OnDropMenuCallback is invoked which is expected to provide and show the menu. Subsequently, BlockStyler.Tree.OnDropCallback might get invoked.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when label edit is attempted on any column.

The label edit is allowed/disallowed based on return value of this callback.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when double clicked is performed on the node.


Created in NX7.5.2.

License requirements : None

Represents the callback which gets called when the node is deleted from tree.

It is expected to perform only clean-up operation related to the deleted node such as clean-up of Node Data.

Avoid operations such as node insert, node delete etc, and avoid calling any methods of tree. This is particularly severe when dialog is closed (through Ok, dialog-reset etc) because by then tree is unavailable and any usage of tree method would raise exception. As the callback is called for each node, the exception would be raised number of times equaling number of nodes available on tree.


Created in NX6.0.0.

License requirements : None

Represents the callback which gets called when nodes are dropped on any target node.

This callback is invoked irrespective of case whether nodes are dragged using MB1 or MB3. If nodes are dragged using MB3 then BlockStyler.Tree.OnDropMenuCallback is called prior to the invocation of this callback.
Created in NX7.5.0.

License requirements : None

Represents the callback to show the menu when nodes are dragged using MB3 or right mouse click, and dropped on any target node.


The menu can be made available using two methods BlockStyler::Tree::CreateMenu and BlockStyler::Tree::SetMenu . Subsequently, menu is shown and selected menu option is passed as paremeter in the callback BlockStyler.Tree.OnDropCallback


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when user selects an option in edit-control set by BlockStyler.Tree.AskEditControlCallback.

If returned BlockStyler::Tree::EditControlOptionAccept then the edited option/text is accepted else it is rejected and old option/text remains.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when label edit is completed on any column.

The edited label is accepted/rejected based on return value of this callback.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when the node is expanded.

This is called only once.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called for each node when the column is inserted using BlockStyler::Tree::InsertColumn .

This callback in not invoked if no node is available on the tree.

In this callback it is expected to provide column text for individual node.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when the node is inserted.


Created in NX6.0.0.

License requirements : None

Represents the callback which gets called when MB3 or right click is attempted on node or tree.

Value of Node parameter is NULL if MB3 is attempted on area other than node. This distinction allows to have separate menu for node and tree.
The menu can be made available using two methods BlockStyler::Tree::CreateMenu and BlockStyler::Tree::SetMenu . Subsequently BlockStyler.Tree.OnMenuSelectionCallback is invoked after the menu item is selected.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when one of the menu option is selected.

Refer to callback BlockStyler.Tree.OnMenuCallback to make available the menu.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when pre selection is attempted on node.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when the node is selected.


Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when the state icon is clicked.

This callback does not get called when state is changed using the method BlockStyler::Node::SetState . The node state can be changed in this callback using BlockStyler::Node::SetState , e.g., node can be changed from checked state to unchecked state and vice-versa.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when the node state is set by BlockStyler::Node::SetState and the corresponding state icon of node state is not known.

This callback is expected to provide the icon name for the node state used in the application. This callback is called only once for any given node state.
Created in NX7.5.0.

License requirements : None

Represents the callback which gets called when tree seeks the tooltip.


Created in NX7.5.0.

License requirements : None


Member Enumeration Documentation

Represents the state to allow/disallow the node label edit.

Use these options in callback BlockStyler.Tree.OnBeginLabelEditCallback.

Enumerator:
BeginLabelEditStateAllow 

Use this option to allow label edit.

BeginLabelEditStateDisallow 

Use this option to disallow label edit.

Represents the column display type.

If the type is BlockStyler::Tree::ColumnDisplayIcon then the provided text is interpreted as icon.

Enumerator:
ColumnDisplayText 

Text.

ColumnDisplayIcon 

Icon.

Represents column resize policy.

Enumerator:
ColumnResizePolicyConstantWidth 

Constant width.

ColumnResizePolicyResizeWithContents 

Width resized with contents.

ColumnResizePolicyResizeWithTree 

Width resize with tree window resize.

Represents the column sort option.

Enumerator:
ColumnSortOptionUnsorted 

Unsorted.

ColumnSortOptionAscending 

Ascending.

ColumnSortOptionDescending 

Descending.

Represents the type of edit options.

Use these options in edit control callback

Enumerator:
ControlTypeNone 

None.

ControlTypeComboBox 

Combo box.

ControlTypeListBox 

List box.

Represents the options to accept or reject the changed value.

Enumerator:
EditControlOptionAccept 

Use this option to allow edit.

EditControlOptionReject 

Use this option to disallow edit.

Represents the state to accept/reject the edited label of node.

Use these options in callback BlockStyler.Tree.OnEndLabelEditCallback.

Enumerator:
EndLabelEditStateAcceptText 

Use this option to accept the edited text.

EndLabelEditStateRejectText 

Use this option to reject the edited text and retain the previous one.

Represents the node insert option which is used while inserting the node in tree.

Enumerator:
NodeInsertOptionFirst 

Node is placed first in the hierarchy in which it is inserted.

NodeInsertOptionLast 

Node is placed last in the hierarchy in which it is inserted.

NodeInsertOptionSort 

Node is sorted according to display text and placed accordingly in the hierarchy in which it is inserted.

NodeInsertOptionAlwaysFirst 

Node is placed first in the hierarchy in which it is inserted.

This is same as BlockStyler::Tree::NodeInsertOptionFirst , except that it remains first after a column sort. If there is more than one node beneath a single parent with this option then they remain in the order they are put in the tree.

NodeInsertOptionAlwaysLast 

Node is placed last in the hierarchy in which it is inserted.

This is same as BlockStyler::Tree::NodeInsertOptionLast , except that it remains last after a column sort. If there is more than one node beneath a single parent with this option then they remain in the order they are put in the tree


Member Function Documentation

Copies the existing BlockStyler::Node .

The tree can copy either its own node or the node of another tree. The copied node can only be inserted into the tree which has copied that node. The column texts are not passed to the copied node.

Returns:
Copied node.
Created in NX7.5.0.

License requirements : None
Parameters:
sourceNodeSource node. Can be node of other tree.

Creates the menu.

Use BlockStyler::Tree::SetMenu to set the created menu.

Returns:

Created in NX7.5.0.

License requirements : None

Creates the node but does not insert it.

Use BlockStyler::Tree::InsertNode to insert the node.

Returns:
Node
Created in NX7.5.0.

License requirements : None
Parameters:
displayTextSpecifies the display text of the node.

Deletes the node from tree.

Further usage of deleted node is illegal. The last place where node can be used is in BlockStyler.Tree.OnDeleteNodeCallaback callback which gets called when node is deleted.
Created in NX7.5.0.

License requirements : None

Parameters:
nodeNode to delete

Returns the first selected node among the available selected nodes.

Returns NULL if no node is selected.
Created in NX7.5.0.

License requirements : None

Gets the display type of the column.

Returns:
Display type.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.
int NXOpen::BlockStyler::Tree::GetColumnId ( int  columnPosition)

Gets the column Id for the provided column position.

Returns:
Unique column Id associated with the column.
Created in NX7.5.0.

License requirements : None
Parameters:
columnPositionColumn position.

Gets column position.

Returns -1 if no column is associated with the provided column Id.

Returns:
Column position.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the column resize policy.

Returns:
Resize policy.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the flag indicating whether the column is sortable.

Returns:
Flag indicating whether the column is sortable.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the column sort option.

Returns:
Column sort option.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the column title.

Returns:
Column header title.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the flag indicating whether the column is visible.

Returns:
Flag indicating whether the column is visible.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets column width.

Returns:
Column width.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column.

Gets the selected nodes.

Returns:
Selected nodes.
Created in NX7.5.0.

License requirements : None
int NXOpen::BlockStyler::Tree::InsertColumn ( int  columnID,
const NXString columnTitle,
int  columnWidth 
)

Inserts column with following defaults:

The new column is placed after the last available column. If no column is available then the inserted one becomes the first column of the tree.

Returns:
Absolute column position.
Created in NX7.5.0.

License requirements : None
Parameters:
columnIDUnique column Id associated with the column. Any further interaction with the column is done with this column Id.
columnTitleColumn header title.
columnWidthColumn width. Provide -1 for default width.

Inserts the node.

Subsequently BlockStyler.Tree.OnInsertNodeCallback is called. Reinserting the node in same or different tree is not allowed.
Created in NX7.5.0.

License requirements : None

Parameters:
newNodeNew Node.
parentNodeParent node under which new node is supposed to be placed.
afterNodeNew node placed after this node. If there is mismatch between parent-node and after-node then former is honoured.
nodeInsertOptionNode insert option. Provide the value if after node is NULL. This value is not considered if a valid after-node is supplied.

Returns the number of column inserted in the tree.


Created in NX7.5.0.

License requirements : None

void NXOpen::BlockStyler::Tree::Redraw ( bool  redraw)

Freezes the tree if the value is set to False which implies that no changes would occur in the tree after this point.

The tree remains in that state until the value is set to True, after which the tree completely updates itself with the changes performed on it in between the two calls. Use this method to efficiently utilize the tree when it is subjected to enourmous changes.
Created in NX7.5.0.

License requirements : None

Parameters:
redrawFlag corresponds to freeze/unfreeze of tree changes.

Returns the root node.

If more than one root node is available in top hierarchy then the first root node is returned.
Created in NX7.5.0.

License requirements : None

void NXOpen::BlockStyler::Tree::SelectNode ( NXOpen::BlockStyler::Node node,
bool  isSelect,
bool  isOtherNodeAffected 
)

Selects the provided node.


Created in NX7.5.0.

License requirements : None

Parameters:
nodeNode to be selected
isSelectSelect/Deselect flag. If true, the provided node is selected, else deselected.
isOtherNodeAffectedFlag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else unaffected.
void NXOpen::BlockStyler::Tree::SelectNodes ( const std::vector< NXOpen::BlockStyler::Node * > &  node,
bool  isSelect,
bool  isOtherNodeAffected 
)

Selects the provided nodes.


Created in NX7.5.0.

License requirements : None

Parameters:
nodeNodes to be selected
isSelectSelect/Deselect flag. If true, the provided nodes are selected, else deselected.
isOtherNodeAffectedFlag indicating whether selection of other nodes is affected. If true, all the previous selected nodes are deselected, else remain so.

Sets the node-edit-control callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the display type of the column.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique column Id associated with the column.
displayTypeDisplay type.

Sets the column resize policy.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique column Id associated with the column
resizePolicyResize policy
void NXOpen::BlockStyler::Tree::SetColumnSortable ( int  columnID,
bool  isSortable 
)

Sets the flag indicating whether the column is sortable.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique column Id associated with the column.
isSortableFlag indicating whether the column is sortable.

Sets the column sort callback.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback

Sets the column sort option.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique column Id associated with the column.
sortOptionColumn sort option.
void NXOpen::BlockStyler::Tree::SetColumnTitle ( int  columnID,
const NXString columnHeaderTitle 
)

Sets the column title.


Created in NX7.5.0.

License requirements : None

Parameters:
columnIDUnique column Id associated with the column.
columnHeaderTitleColumn header title.
void NXOpen::BlockStyler::Tree::SetColumnVisible ( int  columnID,
bool  isVisible 
)

Sets the flag indicating whether the column is visible
Created in NX7.5.0.



License requirements : None

Parameters:
columnIDUnique column Id associated with the column
isVisibleFlag indicating whether the column is visible
void NXOpen::BlockStyler::Tree::SetColumnWidth ( int  columnID,
int  columnWidth 
)

Sets the column width
Created in NX7.5.0.



License requirements : None

Parameters:
columnIDUnique column Id associated with the column.
columnWidthColumn width.
void NXOpen::BlockStyler::Tree::SetEditOptions ( std::vector< NXString > &  stringArray,
int  defaultIndex 
)

Sets the options in edit-control.

This method must be used in BlockStyler.Tree.AskEditControlCallback to make available the options in edit-control.


Created in NX7.5.0.

License requirements : None

Parameters:
stringArrayOptions to be made availabe in edit-control
defaultIndexIndex for default selection. This is zero based, for instance if it is set to 1 then 2nd option is selected by default during edit operation.

Sets the callback handler for node drag
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the callback handler for node drop
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the menu, resulting the menu to appear on the screen.

This method must be used in callback which is intended to create menu, such as BlockStyler.Tree.OnMenuCallback
Created in NX7.5.0.

License requirements : None

Parameters:
menuMenu.

Sets the on-begin-label-edit callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the on select node callback
Created in NX7.5.2.



License requirements : None

Parameters:
cbCallback.

Sets on delete node callback
Created in NX6.0.0.



License requirements : None

Parameters:
cbCallback.

Sets the callback handler for node drop
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the callback handler for on drop menu.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback

Sets the on-end-label-edit callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the on-end-label-edit callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the on expand callback to the tree.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback

Sets the on insert column callback to the tree.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback.

Sets the on insert node callback.


Created in NX6.0.0.

License requirements : None

Parameters:
cbCallback

Sets the on menu callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback.

Sets the on menu selection callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback.

Sets on pre select callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback

Sets the on select node callback
Created in NX7.5.0.



License requirements : None

Parameters:
cbCallback.

Sets the on state change callback.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback

Sets the pre selection time out.

BlockStyler.Tree.OnPreSelectCallback is called based on this value.
Created in NX7.5.0.

License requirements : None

Parameters:
timeOutTime in millisecond

Sets the state icon name callback.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback.

Sets the tool tip callback.


Created in NX7.5.0.

License requirements : None

Parameters:
cbCallback.

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