NXOpen::UI Class Reference

This class contains the various elements that represent the NX User Interface. More...

Inheritance diagram for NXOpen::UI:

Public Types
enum	Status { StatusLock, StatusUnlock }
	Indicates the Lock, Unlock status of NX functions. More...
typedef NXOpen::Callback1 < void, bool >	UtilityFunctionVisibilityHandler
	User defined method is called whenever an NX utility function state changes.

Public Member Functions
int	AddUtilityFunctionVisibilityHandler (const NXOpen::UI::UtilityFunctionVisibilityHandler &utilityFunctionVisibilityHandler)
	Registers a user defined method that is called whenever an utility function state changes.
NXOpen::UI::Status	AskLockStatus ()
	Query NX lock status.
bool	CanOpenPart ()
	Returns a flag indicating whether the NX user interface is in a state where opening a part and making it the display part is supported.
NXOpen::CustomPopupMenuHandler *	CreateCustomPopupMenuHandler ()
	Create a custom menu.
NXOpen::BlockStyler::BlockDialog *	CreateDialog (const NXString &dialogName)
	Create a block dialog.
NXOpen::BlockStyler::BlockDialog *	CreateDialog (const char *dialogName)
	Create a block dialog.
void	JournalPause ()
	Pauses execution of a journal.
void	LockAccess ()
	Locks access to the NX User Interface.
NXOpen::MenuBar::MenuBarManager *	MenuBarManager ()
	Returns the MenuBar::MenuBarManager belonging to the current session Created in NX3.0.0.
NXOpen::MovieManager *	MovieManager ()
	the Movie Manager class.
NXOpen::NXMessageBox *	NXMessageBox ()
	the Uistyler for the current session.
NXOpen::Preferences::ObjectPreferences *	ObjectPreferences ()
	the UI based Object Preferences in the current session.
void	RemoveUtilityFunctionVisibilityHandler (int id)
	Unregisters a user defined method that is called whenever an utility function state changes.
NXOpen::Selection *	SelectionManager ()
	the SelectionManager for the current session.
NXOpen::UIStyler::Styler *	Styler ()
	the Uistyler for the current session.
void	UnlockAccess ()
	Unlocks access for a UI that has been locked by a call to LockAccess .
NXOpen::Preferences::SessionUserInterfaceUI *	UserInterfacePreferences ()
	the UI based User Interface Preferences in the current session Created in NX3.0.0.
NXOpen::Preferences::VisualizationLine *	VisualizationLinePreferences ()
	the UI based Visualization Preferences under Line Tab in the current session Created in NX3.0.0.
NXOpen::Preferences::SessionVisualizationShade *	VisualizationShadingPreferences ()
	the UI based Visualization Preferences under Shading Tab in the current session Created in NX3.0.0.
NXOpen::Preferences::SessionVisualizationVisual *	VisualizationVisualPreferences ()
	the UI based Visualization Preferences under Visual Tab in the current session Created in NX3.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.

Static Public Member Functions
static UI *	GetUI ()

Detailed Description

This class contains the various elements that represent the NX User Interface.

There is a single instance of this class per session. To obtain a reference to the current UI, call the static method UI::GetUI .
Use the static method in this class to obtain an instance.

Created in NX3.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<void, bool> NXOpen::UI::UtilityFunctionVisibilityHandler

User defined method is called whenever an NX utility function state changes.

An example of a NX utility function is the Preferences - User Interface dialog.

The input parameter, visible is true when the function becomes visible and false when the function is no longer visible.

NX utility functions can be nested. The following scenario describes when this method is called for a function call in the middle of another function and then exiting both functions:

First utility function call
UtilityFunctionVisibilityHandler - visible == true

  Second utility function call while the first utility function is still visible
  UtilityFunctionVisibilityHandler - visible == true
  
  Second utility function exit
  UtilityFunctionVisibilityHandler - visible == false
  
First utility function exit
UtilityFunctionVisibilityHandler - visible == false

Created in NX5.0.5.

License requirements : None

Member Enumeration Documentation

enum NXOpen::UI::Status

Indicates the Lock, Unlock status of NX functions.

Enumerator:

StatusLock	Lock status.
StatusUnlock	Unlock status.

Member Function Documentation

int NXOpen::UI::AddUtilityFunctionVisibilityHandler

(

const NXOpen::UI::UtilityFunctionVisibilityHandler &

utilityFunctionVisibilityHandler

)

Registers a user defined method that is called whenever an utility function state changes.

Returns

identifier of registered method (used to unregister the method)
Created in NX5.0.5.

License requirements : None

Parameters

utilityFunctionVisibilityHandler

utilityfunctionvisibilityhandler

NXOpen::UI::Status NXOpen::UI::AskLockStatus

(

)

Query NX lock status.

This function is useful when dismissing a custom dialog and you want to determine whether or not a lock has been set. Returns UI::StatusLock , when NX is in lock status. Returns UI::StatusUnlock , when NX is in unlock status.

Returns

Created in NX5.0.0.

License requirements : None

bool NXOpen::UI::CanOpenPart

(

)

Returns a flag indicating whether the NX user interface is in a state where opening a part and making it the display part is supported.

For example if certain dialogs are displayed or the system is in a task environment it is not supported

Returns

Created in NX8.5.0.

License requirements : None

NXOpen::CustomPopupMenuHandler* NXOpen::UI::CreateCustomPopupMenuHandler

(

)

Create a custom menu.

Returns

Created in NX6.0.4.

License requirements : None

NXOpen::BlockStyler::BlockDialog* NXOpen::UI::CreateDialog

(

const NXString &

dialogName

)

Create a block dialog.

Returns

Created in NX6.0.0.

License requirements : None

Parameters

dialogName

Dialog name NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::BlockStyler::BlockDialog* NXOpen::UI::CreateDialog

(

const char *

dialogName

)

Create a block dialog.

Returns

Created in NX6.0.0.

License requirements : None

Parameters

dialogName

Dialog name NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UI::JournalPause

(

)

Pauses execution of a journal.

Created in NX4.0.0.

License requirements : None

void NXOpen::UI::LockAccess

(

)

Locks access to the NX User Interface.

This method may be used for a custom dialog that requires the session to remain in a known state. When this method is called, all menu items that would allow the user to edit the model are grayed out.
Note that until UnlockAccess is called, the user will not be able to interact with the session. You must ensure that the UI is unlocked when the custom dialog terminates.

This method will throw an exception if the UI cannot be locked. Note that if the UI has already been locked, then it is safe to call this method again.

Created in NX3.0.0.

License requirements : None

NXOpen::MenuBar::MenuBarManager* NXOpen::UI::MenuBarManager

(

)

Returns the MenuBar::MenuBarManager belonging to the current session
Created in NX3.0.0.

NXOpen::MovieManager* NXOpen::UI::MovieManager

(

)

the Movie Manager class.

Created in NX3.0.0.

NXOpen::NXMessageBox* NXOpen::UI::NXMessageBox

(

)

the Uistyler for the current session.

Created in NX3.0.0.

NXOpen::Preferences::ObjectPreferences* NXOpen::UI::ObjectPreferences

(

)

the UI based Object Preferences in the current session.

Created in NX3.0.0.

void NXOpen::UI::RemoveUtilityFunctionVisibilityHandler

(

int

id

)

Unregisters a user defined method that is called whenever an utility function state changes.

Created in NX5.0.5.

License requirements : None

Parameters

id	identifier for method to unregister

NXOpen::Selection* NXOpen::UI::SelectionManager

(

)

the SelectionManager for the current session.

Created in NX3.0.0.

NXOpen::UIStyler::Styler* NXOpen::UI::Styler

(

)

the Uistyler for the current session.

Created in NX3.0.0.

void NXOpen::UI::UnlockAccess

(

)

Unlocks access for a UI that has been locked by a call to LockAccess .

If the UI is already unlocked, this method has no effect.

Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::SessionUserInterfaceUI* NXOpen::UI::UserInterfacePreferences

(

)

the UI based User Interface Preferences in the current session
Created in NX3.0.0.

NXOpen::Preferences::VisualizationLine* NXOpen::UI::VisualizationLinePreferences

(

)

the UI based Visualization Preferences under Line Tab in the current session
Created in NX3.0.0.

NXOpen::Preferences::SessionVisualizationShade* NXOpen::UI::VisualizationShadingPreferences

(

)

the UI based Visualization Preferences under Shading Tab in the current session
Created in NX3.0.0.

NXOpen::Preferences::SessionVisualizationVisual* NXOpen::UI::VisualizationVisualPreferences

(

)

the UI based Visualization Preferences under Visual Tab in the current session
Created in NX3.0.0.

---

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

• UI.hxx