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

Represents a Wizard block
Created in NX7.5.0. More...

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

List of all members.

Public Types

typedef NXOpen::Callback2
< bool,
NXOpen::BlockStyler::Wizard
*, int > 
IsStepOkayCallback
 The IsStepOkay callback allows the client to notify the Wizard that the step is okay or not.
typedef NXOpen::Callback4
< void,
NXOpen::BlockStyler::Wizard
*, NXOpen::BlockStyler::Wizard::TaskNavigatorItem,
int, int > 
OnMenuCallback
 The OnMenu callback notifies a client prior to creating the popup menu in the Task Navigator.
typedef NXOpen::Callback5
< void,
NXOpen::BlockStyler::Wizard
*, NXOpen::BlockStyler::Wizard::TaskNavigatorItem,
int, int, int > 
OnMenuSelectionCallback
 The OnMenuSelection callback notifies a client of the menu item selection on the popup menu in the Task Navigator.
typedef NXOpen::Callback4
< void,
NXOpen::BlockStyler::Wizard
*, int, int,
NXOpen::BlockStyler::Wizard::SubNodeAction
OnSubNodeCallback
 The OnSubNode callback notifies a client of an action performed on a sub-node in the Wizard Task Navigator.
typedef NXOpen::Callback2
< void,
NXOpen::BlockStyler::Wizard
*, int > 
StepNotifyPostCallback
 The StepNotifyPost callback notifies a client after navigating to the next step in the Wizard.
typedef NXOpen::Callback2< int,
NXOpen::BlockStyler::Wizard
*, int > 
StepNotifyPreCallback
 The StepNotifyPre callback notifies a client before navigating to the next step in the Wizard.
enum  SubNodeAction { SubNodeActionSelect, SubNodeActionDeselect, SubNodeActionCheck, SubNodeActionUncheck }
 Specifies the type of action performed on a sub-node in the Wizard Task Navigator. More...
enum  TaskNavigatorItem { TaskNavigatorItemStep, TaskNavigatorItemSubNode, TaskNavigatorItemBackground }
 Specifies an item in the Task Navigator. More...

Public Member Functions

NXOpen::BlockStyler::TreeListMenuCreateMenu ()
 Creates a popup menu.
int CreateStepSubNode (int step, const NXString &text, const NXString &bitmap, bool showCheckBox, bool checkBoxChecked)
 Create a sub-node for a step in the Task Navigator.
void RemoveStepSubNode (int subNodeId)
 Remove a sub-node in the Task Navigator.
void SetIsStepOkayHandler (const NXOpen::BlockStyler::Wizard::IsStepOkayCallback &cb)
 Sets the IsStepOkay handler.
void SetMenu (NXOpen::BlockStyler::TreeListMenu *menu)
 Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator.
void SetOnMenuHandler (const NXOpen::BlockStyler::Wizard::OnMenuCallback &cb)
 Sets the OnMenu handler.
void SetOnMenuSelectionHandler (const NXOpen::BlockStyler::Wizard::OnMenuSelectionCallback &cb)
 Sets the OnMenuSelection handler.
void SetOnSubNodeHandler (const NXOpen::BlockStyler::Wizard::OnSubNodeCallback &cb)
 Sets the OnSubNode handler.
void SetStepNotifyPostHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback &cb)
 Sets the StepNotifyPost handler.
void SetStepNotifyPreHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPreCallback &cb)
 Sets the StepNotifyPre handler.

Detailed Description

Represents a Wizard block
Created in NX7.5.0.



Member Typedef Documentation

The IsStepOkay callback allows the client to notify the Wizard that the step is okay or not.

Returns true if the step is okay and false otherwise. The step parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0.

License requirements : None

The OnMenu callback notifies a client prior to creating the popup menu in the Task Navigator.

The item parameter specifies the popup menu was activated on a step, sub-node or the background. The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler::Wizard::CreateStepSubNode . If the popup menu is invoked on the background of the Task Navigator the step and subNodeId parameters will be -1.
Created in NX7.5.0.

License requirements : None

The OnMenuSelection callback notifies a client of the menu item selection on the popup menu in the Task Navigator.

The item parameter specifies the popup menu was activated on a step, sub-node or the background. The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler::Wizard::CreateStepSubNode . The menuItemIndex parameter will be the unique id specified when creating menu items for the BlockStyler.TreeListMenu. If the popup menu is invoked on the background of the Task Navigator the step and subNodeId parameters will be -1.
Created in NX7.5.0.

License requirements : None

The OnSubNode callback notifies a client of an action performed on a sub-node in the Wizard Task Navigator.

The step parameter for the callback is zero based and represents the steps in the Wizard. The subNodeId parameter is the unique id returned by BlockStyler::Wizard::CreateStepSubNode .
Created in NX7.5.0.

License requirements : None

The StepNotifyPost callback notifies a client after navigating to the next step in the Wizard.

The nextStep parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0.

License requirements : None

The StepNotifyPre callback notifies a client before navigating to the next step in the Wizard.

The nextStep parameter for the callback is zero based and represents the steps in the Wizard.
Created in NX7.5.0.

License requirements : None


Member Enumeration Documentation

Specifies the type of action performed on a sub-node in the Wizard Task Navigator.

The action is passed into the callback BlockStyler.Wizard.OnSubNodeCallback.

Enumerator:
SubNodeActionSelect 

Sub-node has been selected.

SubNodeActionDeselect 

Sub-node has been deselected.

SubNodeActionCheck 

Sub-node has been checked if a checkbox was specified.

SubNodeActionUncheck 

Sub-node has been unchecked if a checkbox was specified.

Specifies an item in the Task Navigator.

Enumerator:
TaskNavigatorItemStep 

step

TaskNavigatorItemSubNode 

sub node

TaskNavigatorItemBackground 

background


Member Function Documentation

Creates a popup menu.

Use BlockStyler::Wizard::SetMenu to set the created menu. See the BlockStyler::TreeListMenu for information on creating a menu.

Returns:

Created in NX7.5.0.

License requirements : None
int NXOpen::BlockStyler::Wizard::CreateStepSubNode ( int  step,
const NXString text,
const NXString bitmap,
bool  showCheckBox,
bool  checkBoxChecked 
)

Create a sub-node for a step in the Task Navigator.

Returns:
Unique id for the sub-node.
Created in NX7.5.0.

License requirements : None
Parameters:
stepThe step to add a sub-node.
textText for the sub-node.
bitmapOptional bitmap for the sub-node.
NOTE: The full Unicode character set is not supported for this parameter.
showCheckBoxAssociate an optional check box with the sub-node
checkBoxCheckedThe initial state of the check box.

Remove a sub-node in the Task Navigator.


Created in NX7.5.0.

License requirements : None

Parameters:
subNodeIdThe sub-node id.

Sets the IsStepOkay handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator.

See the BlockStyler::TreeListMenu for information on creating a menu.
Created in NX7.5.0.

License requirements : None

Parameters:
menumenu

Sets the OnMenu handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Sets the OnMenuSelection handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Sets the OnSubNode handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Sets the StepNotifyPost handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Sets the StepNotifyPre handler.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

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