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

Inheritance diagram for NXOpen::BlockStyler::Wizard:

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.

int	CreateStepSubNode (int step, const char text, const char bitmap, bool showCheckBox, bool checkBoxChecked)
	Create a sub-node for a step in the Task Navigator.

int	CurrentStep ()
	Returns the CurrentStep.

std::vector< NXString >	GetStepBannerBitmaps ()
	Gets the StepBannerBitmaps.

std::vector< NXString >	GetStepBitmaps ()
	Gets the StepBitmaps.

std::vector< NXString >	GetStepCues ()
	Gets the StepCues.

std::vector< NXString >	GetStepText ()
	Gets the StepText.

bool	HighQualityBitmap ()
	Returns the HighQualityBitmap.

bool	Localize ()
	Returns the Localize.

NXOpen::BlockStyler::PropertyList *	Members ()
	Returns the Members Created in NX8.5.0.

void	RemoveStepSubNode (int subNodeId)
	Remove a sub-node in the Task Navigator.

void	SetCurrentStep (int currentStep)
	Sets the CurrentStep.

void	SetHighQualityBitmap (bool highQuality)
	Sets the HighQualityBitmap.

void	SetIsStepOkayHandler (const NXOpen::BlockStyler::Wizard::IsStepOkayCallback &cb)
	Sets the IsStepOkay handler.

void	SetLocalize (bool localize)
	Sets the Localize.

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	SetShowTaskNavigator (bool show)
	Sets the ShowTaskNavigator.

void	SetStepBannerBitmaps (std::vector< NXString > &bitmaps)
	Sets the StepBannerBitmaps.

void	SetStepBitmaps (std::vector< NXString > &bitmaps)
	Sets the StepBitmaps.

void	SetStepCues (std::vector< NXString > &cues)
	Sets the StepCues.

void	SetStepNotifyPostHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback &cb)
	Sets the StepNotifyPost handler.

void	SetStepNotifyPreHandler (const NXOpen::BlockStyler::Wizard::StepNotifyPreCallback &cb)
	Sets the StepNotifyPre handler.

void	SetStepText (std::vector< NXString > &text)
	Sets the StepText.

bool	ShowTaskNavigator ()
	Returns the ShowTaskNavigator.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Wizard block
Created in NX7.5.0.

Member Typedef Documentation

typedef NXOpen::Callback2<bool, NXOpen::BlockStyler::Wizard *, int> NXOpen::BlockStyler::Wizard::IsStepOkayCallback

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

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

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

typedef NXOpen::Callback2<int, NXOpen::BlockStyler::Wizard *, int> NXOpen::BlockStyler::Wizard::StepNotifyPreCallback

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

enum NXOpen::BlockStyler::Wizard::SubNodeAction

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.

enum NXOpen::BlockStyler::Wizard::TaskNavigatorItem

Specifies an item in the Task Navigator.

Enumerator:

TaskNavigatorItemStep	step
TaskNavigatorItemSubNode	sub node
TaskNavigatorItemBackground	background

Member Function Documentation

NXOpen::BlockStyler::TreeListMenu* NXOpen::BlockStyler::Wizard::CreateMenu ( )

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

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.

int NXOpen::BlockStyler::Wizard::CreateStepSubNode	(	int	step,
		const char *	text,
		const char *	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

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.

int NXOpen::BlockStyler::Wizard::CurrentStep ( )

Returns the CurrentStep.

Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::Wizard::GetStepBannerBitmaps ( )

Gets the StepBannerBitmaps.

Gets the list of bitmaps for the step bitmaps in the banner area.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::Wizard::GetStepBitmaps ( )

Gets the StepBitmaps.

Gets the list of bitmaps for the node bitmaps in the Task Navigator.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::Wizard::GetStepCues ( )

Gets the StepCues.

Gets the list of cue lines for the wizard steps.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::Wizard::GetStepText ( )

Gets the StepText.

Gets the list of step descriptions for the banner area.

Returns: Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::Wizard::HighQualityBitmap ( )

Returns the HighQualityBitmap.

Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::Wizard::Localize ( )

Returns the Localize.

Created in NX8.5.0.

License requirements : None

NXOpen::BlockStyler::PropertyList* NXOpen::BlockStyler::Wizard::Members ( )

Returns the Members
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::Wizard::RemoveStepSubNode ( int subNodeId )

Remove a sub-node in the Task Navigator.

Created in NX7.5.0.

License requirements : None

Parameters

subNodeId The sub-node id.

void NXOpen::BlockStyler::Wizard::SetCurrentStep ( int currentStep )

Sets the CurrentStep.

Created in NX8.5.0.

License requirements : None

Parameters

currentStep currentstep

void NXOpen::BlockStyler::Wizard::SetHighQualityBitmap ( bool highQuality )

Sets the HighQualityBitmap.

Created in NX8.5.0.

License requirements : None

Parameters

highQuality highquality

void NXOpen::BlockStyler::Wizard::SetIsStepOkayHandler ( const NXOpen::BlockStyler::Wizard::IsStepOkayCallback & cb )

Sets the IsStepOkay handler.

Created in NX7.5.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::Wizard::SetLocalize ( bool localize )

Sets the Localize.

Created in NX8.5.0.

License requirements : None

Parameters

localize localize

void NXOpen::BlockStyler::Wizard::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.

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

License requirements : None

Parameters

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

Parameters

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

Parameters

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

Parameters

cb cb

void NXOpen::BlockStyler::Wizard::SetShowTaskNavigator ( bool show )

Sets the ShowTaskNavigator.

Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::Wizard::SetStepBannerBitmaps ( std::vector< NXString > & bitmaps )

Sets the StepBannerBitmaps.

Sets the list of bitmaps for the step bitmaps in the banner area.
Created in NX8.5.0.

License requirements : None

Parameters

bitmaps bitmaps

void NXOpen::BlockStyler::Wizard::SetStepBitmaps ( std::vector< NXString > & bitmaps )

Sets the StepBitmaps.

Sets the list of bitmaps for the node bitmaps in the Task Navigator.
Created in NX8.5.0.

License requirements : None

Parameters

bitmaps bitmaps

void NXOpen::BlockStyler::Wizard::SetStepCues ( std::vector< NXString > & cues )

Sets the StepCues.

Sets the list of cue lines for the wizard steps.
Created in NX8.5.0.

License requirements : None

Parameters

cues cues

void NXOpen::BlockStyler::Wizard::SetStepNotifyPostHandler ( const NXOpen::BlockStyler::Wizard::StepNotifyPostCallback & cb )

Sets the StepNotifyPost handler.

Created in NX7.5.0.

License requirements : None

Parameters

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

Parameters

cb cb

void NXOpen::BlockStyler::Wizard::SetStepText ( std::vector< NXString > & text )

Sets the StepText.

Sets the list of step descriptions for the banner area.
Created in NX8.5.0.

License requirements : None

Parameters

text text

bool NXOpen::BlockStyler::Wizard::ShowTaskNavigator ( )

Returns the ShowTaskNavigator.

Created in NX8.5.0.

License requirements : None

The documentation for this class was generated from the following file:

BlockStyler_Wizard.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation