Represents a Dialog
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::BlockStyler::BlockDialog:

Public Types
typedef NXOpen::Callback0< int >	Apply
	Apply callback Created in NX6.0.0.

typedef NXOpen::Callback0< int >	Cancel
	Cancel callback Created in NX6.0.0.

typedef NXOpen::Callback0< int >	Close
	Close callback Created in NX8.5.0.

enum	DialogMode { DialogModeCreate, DialogModeEdit }
	Datatype containing options for showing the dialog. More...

typedef NXOpen::Callback0< void >	DialogShown
	Dialog Shown callback Created in NX6.0.0.

typedef NXOpen::Callback0< bool >	EnableOKButton
	Callback to enable OK and Apply buttons of the dialog.

typedef NXOpen::Callback2< int, NXOpen::BlockStyler::UIBlock , NXOpen::TaggedObject >	Filter
	Filter callback Created in NX6.0.0.

typedef NXOpen::Callback2 < void, NXOpen::BlockStyler::UIBlock *, bool >	FocusNotify
	Focus notify callback.

typedef NXOpen::Callback0< void >	Initialize
	Initialize callback Created in NX6.0.0.

typedef NXOpen::Callback2 < void, NXOpen::BlockStyler::UIBlock *, bool >	KeyboardFocusNotify
	Keyboard focus notify callback.

typedef NXOpen::Callback0< int >	Ok
	Ok callback Created in NX6.0.0.

typedef NXOpen::Callback1< int, NXOpen::BlockStyler::UIBlock * >	Update
	Update callback Created in NX6.0.0.

Public Member Functions
void	AddApplyHandler (const NXOpen::BlockStyler::BlockDialog::Apply &applyCb)
	Adds Apply callback handler to the dialog.

void	AddCancelHandler (const NXOpen::BlockStyler::BlockDialog::Cancel &cancelCb)
	Adds Cancel callback handler to the dialog.

void	AddCloseHandler (const NXOpen::BlockStyler::BlockDialog::Close &closeCb)
	Adds Close callback handler to the dialog.

void	AddDialogShownHandler (const NXOpen::BlockStyler::BlockDialog::DialogShown &cb)
	Adds Dialog Shown callback handler to the dialog.

void	AddEnableOKButtonHandler (const NXOpen::BlockStyler::BlockDialog::EnableOKButton &cb)
	Adds enable-ok-button callback handler to the dialog.

void	AddFilterHandler (const NXOpen::BlockStyler::BlockDialog::Filter &cb)
	Adds Filter callback handler to the dialog.

void	AddFocusNotifyHandler (const NXOpen::BlockStyler::BlockDialog::FocusNotify &cb)
	Adds focus notify callback handler to the dialog.

void	AddInitializeHandler (const NXOpen::BlockStyler::BlockDialog::Initialize &cb)
	Adds Initialize callback handler to the dialog.

void	AddKeyboardFocusNotifyHandler (const NXOpen::BlockStyler::BlockDialog::KeyboardFocusNotify &cb)
	Adds keyboard focus notify callback handler to the dialog.

void	AddOkHandler (const NXOpen::BlockStyler::BlockDialog::Ok &okCb)
	Adds Ok callback handler to the dialog.

void	AddUpdateHandler (const NXOpen::BlockStyler::BlockDialog::Update &cb)
	Adds Update callback handler to the dialog.

NXOpen::BlockStyler::PropertyList *	GetBlockProperties (const NXString &blockName)
	Gets the properties of a block.

NXOpen::BlockStyler::PropertyList *	GetBlockProperties (const char *blockName)
	Gets the properties of a block.

void	PerformApply ()
	Performs an Apply and restarts the dialog.

void	RegisterUserDefinedUIBlock (NXOpen::BlockStyler::BlockDialog *blockDialog, const NXString &blockId)
	Registers the reusable block with the dialog Created in NX8.0.0.

void	RegisterUserDefinedUIBlock (NXOpen::BlockStyler::BlockDialog blockDialog, const char blockId)
	Registers the reusable block with the dialog Created in NX8.0.0.

NXOpen::Selection::Response	Show ()
	Shows the dialog in BlockStyler::BlockDialog::DialogModeCreate mode.

NXOpen::Selection::Response	Show (NXOpen::BlockStyler::BlockDialog::DialogMode dialogMode)
	Shows the dialog in BlockStyler::BlockDialog::DialogModeCreate OR BlockStyler::BlockDialog::DialogModeEdit mode based on input.

NXOpen::BlockStyler::CompositeBlock *	TopBlock ()
	Returns a composite block that contains all the blocks in the dialog Created in NX6.0.0.

virtual	~BlockDialog ()
	Frees the object from memory.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

Represents a Dialog
Created in NX6.0.0.

Member Typedef Documentation

typedef NXOpen::Callback0<int> NXOpen::BlockStyler::BlockDialog::Apply

      Apply callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback0<int> NXOpen::BlockStyler::BlockDialog::Cancel

       Cancel callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback0<int> NXOpen::BlockStyler::BlockDialog::Close

       Close callback

Created in NX8.5.0.

License requirements : None

typedef NXOpen::Callback0<void> NXOpen::BlockStyler::BlockDialog::DialogShown

       Dialog Shown callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback0<bool> NXOpen::BlockStyler::BlockDialog::EnableOKButton

Callback to enable OK and Apply buttons of the dialog.

   Return True or False to enable or disable the buttons respectively.

Created in NX7.5.3.

License requirements : None

typedef NXOpen::Callback2<int, NXOpen::BlockStyler::UIBlock *, NXOpen::TaggedObject *> NXOpen::BlockStyler::BlockDialog::Filter

      Filter callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback2<void, NXOpen::BlockStyler::UIBlock *, bool> NXOpen::BlockStyler::BlockDialog::FocusNotify

Focus notify callback.

This is invoked when any selection block on the dialog receives focus.

Created in NX6.0.2.

License requirements : None

typedef NXOpen::Callback0<void> NXOpen::BlockStyler::BlockDialog::Initialize

       Initialize callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback2<void, NXOpen::BlockStyler::UIBlock *, bool> NXOpen::BlockStyler::BlockDialog::KeyboardFocusNotify

Keyboard focus notify callback.

This is invoked when any block having keyboard input such as Integer block receives focus.

Created in NX7.5.0.

License requirements : None

typedef NXOpen::Callback0<int> NXOpen::BlockStyler::BlockDialog::Ok

       Ok callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<int, NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::BlockDialog::Update

       Update callback

Created in NX6.0.0.

License requirements : None

Member Enumeration Documentation

enum NXOpen::BlockStyler::BlockDialog::DialogMode

Datatype containing options for showing the dialog.

Enumerator:

DialogModeCreate

When the user presses Ok or Apply on the dialog, the user's inputs are saved in dialog memory and the next time that the dialog is shown in Create mode, the dialog is initialized using the user's previous inputs.

DialogModeEdit

The Apply button is not shown.

The user's inputs are not saved in dialog memory and the dialog is not initialized with the user's previous inputs.

Constructor & Destructor Documentation

virtual NXOpen::BlockStyler::BlockDialog::~BlockDialog ( )

virtual

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Created in NX6.0.0.

License requirements : None

Member Function Documentation

void NXOpen::BlockStyler::BlockDialog::AddApplyHandler ( const NXOpen::BlockStyler::BlockDialog::Apply & applyCb )

Adds Apply callback handler to the dialog.

Created in NX6.0.0.

License requirements : None

Parameters

applyCb apply cb

void NXOpen::BlockStyler::BlockDialog::AddCancelHandler ( const NXOpen::BlockStyler::BlockDialog::Cancel & cancelCb )

Adds Cancel callback handler to the dialog.

Created in NX6.0.0.

License requirements : None

Parameters

cancelCb cancel cb

void NXOpen::BlockStyler::BlockDialog::AddCloseHandler ( const NXOpen::BlockStyler::BlockDialog::Close & closeCb )

Adds Close callback handler to the dialog.

Created in NX8.5.0.

License requirements : None

Parameters

closeCb close cb

void NXOpen::BlockStyler::BlockDialog::AddDialogShownHandler ( const NXOpen::BlockStyler::BlockDialog::DialogShown & cb )

Adds Dialog Shown callback handler to the dialog.

The callback function is called before the dialog is shown. The callback can be used to overwrite changes that are made during dialog initialization when user inputs saved in dialog memory are applied to the dialog.
Created in NX6.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddEnableOKButtonHandler ( const NXOpen::BlockStyler::BlockDialog::EnableOKButton & cb )

Adds enable-ok-button callback handler to the dialog.

Created in NX7.5.3.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddFilterHandler ( const NXOpen::BlockStyler::BlockDialog::Filter & cb )

Adds Filter callback handler to the dialog.

Created in NX6.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddFocusNotifyHandler ( const NXOpen::BlockStyler::BlockDialog::FocusNotify & cb )

Adds focus notify callback handler to the dialog.

Created in NX6.0.2.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddInitializeHandler ( const NXOpen::BlockStyler::BlockDialog::Initialize & cb )

Adds Initialize callback handler to the dialog.

The callback function is called while the dialog is being initialized. The callback is called before applying any user inputs saved in dialog memory.
Created in NX6.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddKeyboardFocusNotifyHandler ( const NXOpen::BlockStyler::BlockDialog::KeyboardFocusNotify & cb )

Adds keyboard focus notify callback handler to the dialog.

Created in NX7.5.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::BlockDialog::AddOkHandler ( const NXOpen::BlockStyler::BlockDialog::Ok & okCb )

Adds Ok callback handler to the dialog.

Created in NX6.0.0.

License requirements : None

Parameters

okCb ok cb

void NXOpen::BlockStyler::BlockDialog::AddUpdateHandler ( const NXOpen::BlockStyler::BlockDialog::Update & cb )

Adds Update callback handler to the dialog.

Created in NX6.0.0.

License requirements : None

Parameters

cb cb

NXOpen::BlockStyler::PropertyList* NXOpen::BlockStyler::BlockDialog::GetBlockProperties ( const NXString & blockName )

Gets the properties of a block.

Returns: Created in NX8.5.0.

License requirements : None

Parameters

blockName BlockID of the block
NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::BlockStyler::PropertyList* NXOpen::BlockStyler::BlockDialog::GetBlockProperties ( const char * blockName )

Gets the properties of a block.

Returns: Created in NX8.5.0.

License requirements : None

Parameters

blockName BlockID of the block
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::BlockStyler::BlockDialog::PerformApply ( )

Performs an Apply and restarts the dialog.

This invokes apply callback on the dialog.
Created in NX6.0.0.

License requirements : None

void NXOpen::BlockStyler::BlockDialog::RegisterUserDefinedUIBlock	(	NXOpen::BlockStyler::BlockDialog *	blockDialog,
		const NXString &	blockId
	)

Registers the reusable block with the dialog
Created in NX8.0.0.

License requirements : None

Parameters

blockDialog	Dialog which contains the reusable block
blockId	"Block ID" of reusable block NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::BlockStyler::BlockDialog::RegisterUserDefinedUIBlock	(	NXOpen::BlockStyler::BlockDialog *	blockDialog,
		const char *	blockId
	)

Registers the reusable block with the dialog
Created in NX8.0.0.

License requirements : None

Parameters

blockDialog	Dialog which contains the reusable block
blockId	"Block ID" of reusable block NOTE: The full Unicode character set is not supported for this parameter.

NXOpen::Selection::Response NXOpen::BlockStyler::BlockDialog::Show ( )

Shows the dialog in BlockStyler::BlockDialog::DialogModeCreate mode.

Returns: Created in NX6.0.0.

License requirements : None

NXOpen::Selection::Response NXOpen::BlockStyler::BlockDialog::Show ( NXOpen::BlockStyler::BlockDialog::DialogMode dialogMode )

Shows the dialog in BlockStyler::BlockDialog::DialogModeCreate OR BlockStyler::BlockDialog::DialogModeEdit mode based on input.

Returns: Created in NX6.0.0.

License requirements : None

Parameters

dialogMode Dialog mode as Create or Edit. BlockStyler::BlockDialog::DialogMode

NXOpen::BlockStyler::CompositeBlock* NXOpen::BlockStyler::BlockDialog::TopBlock ( )

Returns a composite block that contains all the blocks in the dialog
Created in NX6.0.0.

License requirements : None

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

BlockStyler_BlockDialog.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation