Represents a Toggle for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::Toggle:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	ValueChanged
	Called when a dialog user clicks on the button or presses the spacebar when the button has keyboard focus.

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	AddValueChangedHandler (const NXOpen::UIStyler::Toggle::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
	Registers value change callback.

bool	GetSensitivity ()
	Gets the sensitivity.

bool	ItemValue ()
	Returns an item value Created in NX5.0.0.

void	SetDefaultAction ()
	Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.

void	SetFocus ()
	Indicates that this dialog item is receiving keyboard focus.

void	SetItemValue (bool itemVal)
	Sets an item value Created in NX5.0.0.

void	SetLabel (const NXString &strLabel)
	Sets the label to display on the right side of the toggle button.

void	SetLabel (const char *strLabel)
	Sets the label to display on the right side of the toggle button.

void	SetSensitivity (int subitemIndex, bool type)
	Sets the sensitivity of the toggle button Created in NX5.0.0.

void	SetVisibility (bool type)
	Sets the visibility of the toggle Created in NX5.0.0.

bool	Visibility ()
	Returns the visibility of the toggle Created in NX5.0.0.

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

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

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

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

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

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

Detailed Description

Represents a Toggle for UI Styler.

Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::Toggle::ValueChanged

Called when a dialog user clicks on the button or presses the spacebar when the button has keyboard focus.

   Do not terminate the dialog with a value-changed callback. The dialog should always return UF_UI_CB_CONTINUE_DIALOG

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::Toggle::AddValueChangedHandler	(	const NXOpen::UIStyler::Toggle::ValueChanged &	valuechangedevent,
		bool	isDialogLaunchingEvent
	)

Registers value change callback.

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

License requirements : None

Parameters

valuechangedevent	Value changed event
isDialogLaunchingEvent	True if launch any dialog else False

bool NXOpen::UIStyler::Toggle::GetSensitivity ( )

Gets the sensitivity.

Returns: Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::Toggle::ItemValue ( )

Returns an item value
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::Toggle::SetDefaultAction ( )

Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.

When you set this attribute, a click on the second mouse button triggers this dialog item's ON/OFF state and calls the Value Changed callback instead of the action of the OK button.
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::Toggle::SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::Toggle::SetItemValue ( bool itemVal )

Sets an item value
Created in NX5.0.0.

License requirements : None

Parameters

itemVal item val

void NXOpen::UIStyler::Toggle::SetLabel ( const NXString & strLabel )

Sets the label to display on the right side of the toggle button.

If the toggle button displays a bitmap, then this text label is used as a popup hint instead
Created in NX5.0.0.

License requirements : None

Parameters

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

void NXOpen::UIStyler::Toggle::SetLabel ( const char * strLabel )

Sets the label to display on the right side of the toggle button.

If the toggle button displays a bitmap, then this text label is used as a popup hint instead
Created in NX5.0.0.

License requirements : None

Parameters

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

void NXOpen::UIStyler::Toggle::SetSensitivity	(	int	subitemIndex,
		bool	type
	)

Sets the sensitivity of the toggle button
Created in NX5.0.0.

License requirements : None

Parameters

subitemIndex	subitem index
type	type

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation