NX Open C++ Reference Guide
|
Represents an Explorer block. More...
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. | |
typedef NXOpen::Callback2< int, NXOpen::BlockStyler::Explorer *, int > | NotifyNodeSelectedPreCallback |
The NotifyNodeSelectedPre callback notifies a client before navigating to the next node in the Explorer. | |
Public Member Functions | |
int | CurrentNode () |
Returns the CurrentNode selected in the Navigation Tree. | |
bool | Localize () |
Returns the localization of the block label. | |
NXOpen::BlockStyler::PropertyList * | Members () |
Returns the members Created in NX9.0.0. | |
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. | |
void | SetCurrentNode (int currentNode) |
Sets the CurrentNode selected in the Navigation Tree. | |
void | SetLocalize (bool localize) |
Sets the localization of the block label. | |
void | SetNotifyNodeSelectedPostHandler (const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPostCallback &cb) |
Sets the NotifyNodeSelectedPost handler. | |
void | SetNotifyNodeSelectedPreHandler (const NXOpen::BlockStyler::Explorer::NotifyNodeSelectedPreCallback &cb) |
Sets the NotifyNodeSelectedPre handler. | |
![]() | |
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. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
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.
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
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
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
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
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
cb | cb |