NX Open C++ Reference Guide
|
Represents a Wizard block
Created in NX7.5.0.
More...
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::TreeListMenu * | CreateMenu () |
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. |
Represents a Wizard block
Created in NX7.5.0.
typedef NXOpen::Callback2<bool, NXOpen::BlockStyler::Wizard *, int> NXOpen::BlockStyler::Wizard::IsStepOkayCallback |
typedef NXOpen::Callback4<void, NXOpen::BlockStyler::Wizard *, NXOpen::BlockStyler::Wizard::TaskNavigatorItem, int, int> NXOpen::BlockStyler::Wizard::OnMenuCallback |
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
typedef NXOpen::Callback5<void, NXOpen::BlockStyler::Wizard *, NXOpen::BlockStyler::Wizard::TaskNavigatorItem, int, int, int> NXOpen::BlockStyler::Wizard::OnMenuSelectionCallback |
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
typedef NXOpen::Callback4<void, NXOpen::BlockStyler::Wizard *, int, int, NXOpen::BlockStyler::Wizard::SubNodeAction> NXOpen::BlockStyler::Wizard::OnSubNodeCallback |
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
typedef NXOpen::Callback2<void, NXOpen::BlockStyler::Wizard *, int> NXOpen::BlockStyler::Wizard::StepNotifyPostCallback |
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.
Creates a popup menu.
Use BlockStyler::Wizard::SetMenu to set the created menu. See the BlockStyler::TreeListMenu for information on creating a menu.
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.
step | The step to add a sub-node. |
text | Text for the sub-node. |
bitmap | Optional bitmap for the sub-node. NOTE: The full Unicode character set is not supported for this parameter. |
showCheckBox | Associate an optional check box with the sub-node |
checkBoxChecked | The initial state of the check box. |
void NXOpen::BlockStyler::Wizard::RemoveStepSubNode | ( | int | subNodeId | ) |
Remove a sub-node in the Task Navigator.
Created in NX7.5.0.
License requirements : None
subNodeId | The sub-node id. |
void NXOpen::BlockStyler::Wizard::SetIsStepOkayHandler | ( | const NXOpen::BlockStyler::Wizard::IsStepOkayCallback & | cb | ) |
Sets the IsStepOkay handler.
Created in NX7.5.0.
License requirements : None
cb | cb |
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
menu | menu |
void NXOpen::BlockStyler::Wizard::SetOnMenuHandler | ( | const NXOpen::BlockStyler::Wizard::OnMenuCallback & | cb | ) |
Sets the OnMenu handler.
Created in NX7.5.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::Wizard::SetOnMenuSelectionHandler | ( | const NXOpen::BlockStyler::Wizard::OnMenuSelectionCallback & | cb | ) |
Sets the OnMenuSelection handler.
Created in NX7.5.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::Wizard::SetOnSubNodeHandler | ( | const NXOpen::BlockStyler::Wizard::OnSubNodeCallback & | cb | ) |
Sets the OnSubNode handler.
Created in NX7.5.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::Wizard::SetStepNotifyPostHandler | ( | const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback & | cb | ) |
Sets the StepNotifyPost handler.
Created in NX7.5.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::Wizard::SetStepNotifyPreHandler | ( | const NXOpen::BlockStyler::Wizard::StepNotifyPreCallback & | cb | ) |
Sets the StepNotifyPre handler.
Created in NX7.5.0.
License requirements : None
cb | cb |