Represents a DialogItem for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::DialogItem:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Apply
	Called when a dialog user clicks Apply or <Ctrl>MB2 anywhere in NX or presses the Apply's keyboard accelerator as defined in the resource file. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Back
	Called when a dialog user clicks Back <Shift>MB2 anywhere in NX or presses Back's keyboard accelerator as defined in the resource file. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Cancel
	Called when a dialog user clicks Cancel or <Alt>MB2 anywhere in NX or presses Cancel's keyboard accelerator as defined in the resource file.Cancel callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Construct
	Called when the dialog displays. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Destruct
	Called when the dialog closes. More...

enum	DialogItemIndex { DialogItemIndexOk, DialogItemIndexApply, DialogItemIndexBack, DialogItemIndexCancel }
	Describes dialog item index. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	FileOperation
	Called just before a dialog user selects a file operation, such as in File?New, and again after a file operation completes. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Okay
	Called when a dialog user clicks OK or MB2 anywhere in NX or presses the OK's keyboard accelerator as defined in the resource file. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	PageSwitch
	Called when a user switches tabs. More...

Public Types inherited from NXOpen::UIStyler::StylerItem
enum	ItemType { ItemTypeInvalidType = -1, ItemTypeActionButton, ItemTypeDialog, ItemTypeRadioBox, ItemTypeReal, ItemTypeScaleReal, ItemTypeBitmap, ItemTypeRowColumn, ItemTypeButtonLayout, ItemTypeScrolledWindow, ItemTypeColorTool, ItemTypeSelectionBox, ItemTypeSeparator, ItemTypeSingleSelectionList, ItemTypeString, ItemTypeBeginGroup, ItemTypeInteger, ItemTypeScaleInteger, ItemTypeMultiList, ItemTypeLabel, ItemTypeMultiLineText, ItemTypeTabControl, ItemTypeOptionMenu, ItemTypeToggle, ItemTypeOptionToggle, ItemTypeToolPalette, ItemTypeWideString, ItemTypePropertyPage, ItemTypeCollapsibleGroup }
	Describes kind of action to be taken from callbac. More...

Public Member Functions
void	AddApplyHandler (const NXOpen::UIStyler::DialogItem::Apply &applyevent, bool isDialogLaunchingEvent)
	Registers apply callback. More...

void	AddBackHandler (const NXOpen::UIStyler::DialogItem::Back &backevent, bool isDialogLaunchingEvent)
	Registers back callback. More...

void	AddCancelHandler (const NXOpen::UIStyler::DialogItem::Cancel &cancelevent, bool isDialogLaunchingEvent)
	Registers cancel callback. More...

void	AddConstructHandler (const NXOpen::UIStyler::DialogItem::Construct &constructevent, bool isDialogLaunchingEvent)
	Registers construct callback. More...

void	AddDestructHandler (const NXOpen::UIStyler::DialogItem::Destruct &destructevent, bool isDialogLaunchingEvent)
	Registers destruct callback. More...

void	AddFileOperationHandler (const NXOpen::UIStyler::DialogItem::FileOperation &fileoperationevent, bool isDialogLaunchingEvent)
	Registers file operation callback. More...

void	AddOkayHandler (const NXOpen::UIStyler::DialogItem::Okay &okayevent, bool isDialogLaunchingEvent)
	Registers ok callback. More...

void	AddPageSwitchHandler (const NXOpen::UIStyler::DialogItem::PageSwitch &switchevent, bool isDialogLaunchingEvent)
	Registers switch callback. More...

NXOpen::UIStyler::FileOperationData *	FileOperationData ()
	Returns the file operation data Created in NX5.0.0. More...

NXOpen::SelectionHandle *	GetSelectionHandle ()
	Gets the selection handle for a given dialog item. More...

void	SetNavigationSensitivity (NXOpen::UIStyler::DialogItem::DialogItemIndex subItemIndex, bool type)
	Specifies the sensitivity of the navigation buttons at the bottom of the dialog. More...

void	SetResize (bool type)
	Specifies wether dialog is allowed to resize Created in NX5.0.0. More...

void	SetSensitivity (bool type)
	Specifies the sensitivity of the dialog. More...

void	SetTitle (const NXString &strLabel)
	Specifies a string to display on the top border of the dialog Created in NX5.0.0. More...

void	SetTitle (const char *strLabel)
	Specifies a string to display on the top border of the dialog Created in NX5.0.0. More...

void	SetWidth (int width)
	Specifies the pixel width for the dialog. More...

Public Member Functions inherited from NXOpen::UIStyler::StylerItem
NXOpen::UIStyler::StylerItem::ItemType	GetItemType ()
	Gets the dialog item type. More...

NXOpen::UIStyler::Attachment *	InitializeAttachment ()
	Returns initialized dialog item attachment information. More...

bool	IsEqualTo (NXOpen::UIStyler::StylerItem *itemToCompare)
	Equates two styler items. More...

void	SetAttachment (NXOpen::UIStyler::Attachment *attachment)
	Specifies the updated dialog item attachment information Created in NX5.0.0. More...

virtual	~StylerItem ()
	Free resources associated with the instance. More...

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

Detailed Description

Represents a DialogItem for UI Styler.

Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Apply

Called when a dialog user clicks Apply or <Ctrl>MB2 anywhere in NX or presses the Apply's keyboard accelerator as defined in the resource file.

Apply callbacks should not terminate the dialog and always return UF_UI_CB_CONTINUE_DIALOG.
Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Back

Called when a dialog user clicks Back <Shift>MB2 anywhere in NX or presses Back's keyboard accelerator as defined in the resource file.

Back callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.
Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Cancel

Called when a dialog user clicks Cancel or <Alt>MB2 anywhere in NX or presses Cancel's keyboard accelerator as defined in the resource file.Cancel callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.

Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Construct

Called when the dialog displays.

You can use the Constructor callback to set up dialog item attributes such as populating a list or setting the sensitivity of a dialog item.
Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Destruct

Called when the dialog closes.

Use the Destructor callback to perform cleanup.
Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::FileOperation

Called just before a dialog user selects a file operation, such as in File?New, and again after a file operation completes.

A typical use for a file operation callback would be to make sure that the system updates cached part data in a part before a dialog user executes a File?Save. The callback can determine from the callback data structure whether the file operation is about to begin or has just completed. It can also determine which operation is being executed. This callback is only used on DA1 dialogs because the DA2 dialogs are usually cancelled (automatically through the quick access menus) when a dialog user selects any of the File menu options.
Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::Okay

Called when a dialog user clicks OK or MB2 anywhere in NX or presses the OK's keyboard accelerator as defined in the resource file.

OK callbacks should terminate the dialog and always return UF_UI_CB_EXIT_DIALOG.

Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::DialogItem::PageSwitch

Called when a user switches tabs.

Created in NX8.5.3.

License requirements : None

Member Enumeration Documentation

enum NXOpen::UIStyler::DialogItem::DialogItemIndex

Describes dialog item index.

Enumerator
DialogItemIndexOk	Ok index.
DialogItemIndexApply	Apply index.
DialogItemIndexBack	Back index.
DialogItemIndexCancel	Cancel index.

Member Function Documentation

void NXOpen::UIStyler::DialogItem::AddApplyHandler	(	const NXOpen::UIStyler::DialogItem::Apply &	applyevent,
		bool	isDialogLaunchingEvent
	)

Registers apply callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

applyevent	applyevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddBackHandler	(	const NXOpen::UIStyler::DialogItem::Back &	backevent,
		bool	isDialogLaunchingEvent
	)

Registers back callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

backevent	backevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddCancelHandler	(	const NXOpen::UIStyler::DialogItem::Cancel &	cancelevent,
		bool	isDialogLaunchingEvent
	)

Registers cancel callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

cancelevent	cancelevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddConstructHandler	(	const NXOpen::UIStyler::DialogItem::Construct &	constructevent,
		bool	isDialogLaunchingEvent
	)

Registers construct callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

constructevent	constructevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddDestructHandler	(	const NXOpen::UIStyler::DialogItem::Destruct &	destructevent,
		bool	isDialogLaunchingEvent
	)

Registers destruct callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

destructevent	destructevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddFileOperationHandler	(	const NXOpen::UIStyler::DialogItem::FileOperation &	fileoperationevent,
		bool	isDialogLaunchingEvent
	)

Registers file operation callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

fileoperationevent	fileoperationevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddOkayHandler	(	const NXOpen::UIStyler::DialogItem::Okay &	okayevent,
		bool	isDialogLaunchingEvent
	)

Registers ok callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters

okayevent	okayevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::DialogItem::AddPageSwitchHandler	(	const NXOpen::UIStyler::DialogItem::PageSwitch &	switchevent,
		bool	isDialogLaunchingEvent
	)

Registers switch callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX8.5.3.

License requirements : None

Parameters

switchevent	switchevent
isDialogLaunchingEvent	is dialog launching event

NXOpen::UIStyler::FileOperationData* NXOpen::UIStyler::DialogItem::FileOperationData ( )

Returns the file operation data
Created in NX5.0.0.

License requirements : None

NXOpen::SelectionHandle* NXOpen::UIStyler::DialogItem::GetSelectionHandle ( )

Gets the selection handle for a given dialog item.

Returns: Selection handle
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::DialogItem::SetNavigationSensitivity	(	NXOpen::UIStyler::DialogItem::DialogItemIndex	subItemIndex,
		bool	type
	)

Specifies the sensitivity of the navigation buttons at the bottom of the dialog.

If you set the UF_STYLER_BACK_INDEX button to insensitive at creation time, the system does not show the BACK button; Changing the button's sensitivity while the dialog displays does not show the Back button.

Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex	Sub item index
type	TRUE if sensitive, FALSE if insensitive

void NXOpen::UIStyler::DialogItem::SetResize ( bool type )

Specifies wether dialog is allowed to resize
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE to allow dialog to resize; FALSE to freeze the dialog size

void NXOpen::UIStyler::DialogItem::SetSensitivity ( bool type )

Specifies the sensitivity of the dialog.

Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if sensitive, FALSE if insensitive

void NXOpen::UIStyler::DialogItem::SetTitle ( const NXString & strLabel )

Specifies a string to display on the top border of the dialog
Created in NX5.0.0.

License requirements : None

Parameters

strLabel str label

void NXOpen::UIStyler::DialogItem::SetTitle ( const char * strLabel )

Specifies a string to display on the top border of the dialog
Created in NX5.0.0.

License requirements : None

Parameters

strLabel str label

void NXOpen::UIStyler::DialogItem::SetWidth ( int width )

Specifies the pixel width for the dialog.

You can only set this attribute when the Dialog Resize attribute is set to TRUE. You cannot enter a negative number.
Created in NX5.0.0.

License requirements : None

Parameters

width width

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

UIStyler_DialogItem.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation