NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::BlockStyler::BlockDialog Class Reference

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

Inheritance diagram for NXOpen::BlockStyler::BlockDialog:
NXOpen::TransientObject NXOpen::BlockStyler::SnapBlockDialog

List of all members.

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.
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 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.
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.
NXOpen::Selection::Response Show ()
 Shows the dialog.
NXOpen::Selection::Response Show (NXOpen::BlockStyler::BlockDialog::DialogMode dialogMode)
 Shows the dialog.
NXOpen::BlockStyler::CompositeBlockTopBlock ()
 Returns a composite block that contains all the blocks in the dialog
Created in NX6.0.0.
virtual ~BlockDialog ()
 Frees the object from memory.

Detailed Description

Represents a Dialog
Created in NX6.0.0.



Member Typedef Documentation

Apply callback
Created in NX6.0.0.



License requirements : None

Cancel callback
Created in NX6.0.0.



License requirements : None

Dialog Shown callback
Created in NX6.0.0.



License requirements : None

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

Filter callback
Created in NX6.0.0.



License requirements : None

Focus notify callback.

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


Created in NX6.0.2.

License requirements : None

Initialize callback
Created in NX6.0.0.



License requirements : None

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

Ok callback
Created in NX6.0.0.



License requirements : None

Update callback
Created in NX6.0.0.



License requirements : None


Member Enumeration Documentation

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

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

Adds Apply callback handler to the dialog.


Created in NX6.0.0.

License requirements : None

Parameters:
applyCbapply cb

Adds Cancel callback handler to the dialog.


Created in NX6.0.0.

License requirements : None

Parameters:
cancelCbcancel 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:
cbcb

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


Created in NX7.5.3.

License requirements : None

Parameters:
cbcb

Adds Filter callback handler to the dialog.


Created in NX6.0.0.

License requirements : None

Parameters:
cbcb

Adds focus notify callback handler to the dialog.


Created in NX6.0.2.

License requirements : None

Parameters:
cbcb

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:
cbcb

Adds keyboard focus notify callback handler to the dialog.


Created in NX7.5.0.

License requirements : None

Parameters:
cbcb

Adds Ok callback handler to the dialog.


Created in NX6.0.0.

License requirements : None

Parameters:
okCbok cb

Adds Update callback handler to the dialog.


Created in NX6.0.0.

License requirements : None

Parameters:
cbcb

Performs an Apply and restarts the dialog.

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

License requirements : None

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



License requirements : None

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

Shows the dialog.

Returns:

Created in NX6.0.0.

License requirements : None

Shows the dialog.

Returns:

Created in NX6.0.0.

License requirements : None
Parameters:
dialogModedialogmode

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.