Represents an Explorer block. More...

Inheritance diagram for NXOpen::BlockStyler::Explorer:

Public Types
typedef NXOpen::Callback2 < void, NXOpen::BlockStyler::Explorer *, int >	NotifyNodeSelectedPostCallback
	The NotifyNodeSelectedPost callback notifies a client after navigating to the next node in the Explorer. More...

typedef NXOpen::Callback2< int, NXOpen::BlockStyler::Explorer *, int >	NotifyNodeSelectedPreCallback
	The NotifyNodeSelectedPre callback notifies a client before navigating to the next node in the Explorer. More...

Public Member Functions
int	CurrentNode ()
	Returns the CurrentNode selected in the Navigation Tree. More...

bool	Localize ()
	Returns the localization of the block label. More...

NXOpen::BlockStyler::PropertyList *	Members ()
	Returns the members. More...

void	SetChildMembers (NXOpen::BlockStyler::UIBlock parentMember, const std::vector< NXOpen::BlockStyler::UIBlock > &childMembers)
	Sets the parent member for the child members in the Explorer Navigation Tree. More...

void	SetCurrentNode (int currentNode)
	Sets the CurrentNode selected in the Navigation Tree. More...

void	SetLocalize (bool localize)
	Sets the localization of the block label. More...

void	SetNotifyNodeSelectedPostHandler (const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPostCallback &cb)
	Sets the NotifyNodeSelectedPost handler. More...

void	SetNotifyNodeSelectedPreHandler (const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPreCallback &cb)
	Sets the NotifyNodeSelectedPre handler. More...

void	SetTreeWidth (int treeWidth)
	Sets the TreeWidth for the Navigation Tree. More...

int	TreeWidth ()
	Returns the TreeWidth for the Navigation Tree. More...

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

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

void	Focus ()
	Focuses on the block. More...

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

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

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

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

void	SetEnable (bool enable)
	Sets the Enable. More...

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

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

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

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

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

bool	Show ()
	Returns the Visibility of block. More...

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

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents an Explorer block.

The Explorer block allows for collecting a large number of inputs into a single dialog. The inputs are organized into nodes and sub-nodes on a tree to allow for quick and easy navigation. The Explorer block provides the ability to have up to 3 levels of nodes in the Navigation Tree. Each node contains groups and individual inputs that are laid out like standard NX dialogs. When selecting level 1 and level 2 nodes that do not contain any groups and only contain sub-nodes the first sub-node containing groups is highlighted and its content shown.

Created in NX9.0.0.

Member Typedef Documentation

typedef NXOpen::Callback2<void, NXOpen::BlockStyler::Explorer *, int> NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPostCallback

The NotifyNodeSelectedPost callback notifies a client after navigating to the next node in the Explorer.

The nextNode parameter for the callback is zero based and represents the nodes in the Explorer.
Created in NX9.0.0.

License requirements : None

typedef NXOpen::Callback2<int, NXOpen::BlockStyler::Explorer *, int> NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPreCallback

The NotifyNodeSelectedPre callback notifies a client before navigating to the next node in the Explorer.

The nextNode parameter for the callback is zero based and represents the nodes in the Explorer.
Created in NX9.0.0.

License requirements : None

Member Function Documentation

int NXOpen::BlockStyler::Explorer::CurrentNode ( )

Returns the CurrentNode selected in the Navigation Tree.

Created in NX9.0.0.

License requirements : None

bool NXOpen::BlockStyler::Explorer::Localize ( )

Returns the localization of the block label.

If the label matches an English string in the NX string localization databse and the Localize property is set to true, then the Label is translated to the current locale language.
Created in NX9.0.0.

License requirements : None

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

Returns the members.

Created in NX9.0.0.

License requirements : None

void NXOpen::BlockStyler::Explorer::SetChildMembers	(	NXOpen::BlockStyler::UIBlock *	parentMember,
		const std::vector< NXOpen::BlockStyler::UIBlock * > &	childMembers
	)

Sets the parent member for the child members in the Explorer Navigation Tree.

The maximum Navigation Tree depth is 3 levels. An exception is thrown if the parent member depth is already at the maximum allowed depth.
Created in NX9.0.0.

License requirements : None

Parameters

parentMember	Parent member for the child members.
childMembers	Child members for the parent member.

void NXOpen::BlockStyler::Explorer::SetCurrentNode ( int currentNode )

Sets the CurrentNode selected in the Navigation Tree.

Created in NX9.0.0.

License requirements : None

Parameters

currentNode currentnode

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

Sets the localization of the block label.

If the label matches an English string in the NX string localization databse and the Localize property is set to true, then the Label is translated to the current locale language.
Created in NX9.0.0.

License requirements : None

Parameters

localize localize

void NXOpen::BlockStyler::Explorer::SetNotifyNodeSelectedPostHandler ( const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPostCallback & cb )

Sets the NotifyNodeSelectedPost handler.

Created in NX9.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::Explorer::SetNotifyNodeSelectedPreHandler ( const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPreCallback & cb )

Sets the NotifyNodeSelectedPre handler.

Created in NX9.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::Explorer::SetTreeWidth ( int treeWidth )

Sets the TreeWidth for the Navigation Tree.

Created in NX11.0.0.

License requirements : None

Parameters

treeWidth treewidth

int NXOpen::BlockStyler::Explorer::TreeWidth ( )

Returns the TreeWidth for the Navigation Tree.

Created in NX11.0.0.

License requirements : None

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

BlockStyler_Explorer.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation