Represents a OptionToggle for UI Styler
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::UIStyler::OptionToggle:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Activate
	Called when a dialog user selects an option from the menu Created in NX5.0.0.

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	AddActivateHandler (const NXOpen::UIStyler::OptionToggle::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback.

void	AddValueChangedHandler (const NXOpen::UIStyler::OptionToggle::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
	Registers value change callback.

std::vector< NXString >	GetItems ()
	Returns the items.

int	GetItemValue (bool *setCheck)
	Returns item value.

bool	GetSensitivity ()
	Returns the sesitivity.

void	SetBitmaps (std::vector< NXString > &bitmaps)
	Set bitmaps Created in NX5.0.0.

void	SetDefaultAction ()
	Sets default action Created in NX5.0.0.

void	SetItems (std::vector< NXString > &strListArray)
	Sets items in the array Created in NX5.0.0.

void	SetItemValue (int subitemIndex, bool setCheck)
	Sets item value Created in NX5.0.0.

void	SetLabel (const NXString &strLabel)
	Sets label Created in NX5.0.0.

void	SetLabel (const char *strLabel)
	Sets label Created in NX5.0.0.

void	SetSensitivity (int subitemIndex, bool type)
	Set the sesitivity Created in NX5.0.0.

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

bool	Visibility ()
	Returns the visibility 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 OptionToggle for UI Styler
Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::OptionToggle::Activate

       Called when a dialog user selects an option from the menu

Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::OptionToggle::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::OptionToggle::AddActivateHandler	(	const NXOpen::UIStyler::OptionToggle::Activate &	activateevent,
		bool	isDialogLaunchingEvent
	)

Registers activate callback.

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

License requirements : None

Parameters

activateevent	Callback for activate event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

void NXOpen::UIStyler::OptionToggle::AddValueChangedHandler	(	const NXOpen::UIStyler::OptionToggle::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	Callback for value changed event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

std::vector<NXString> NXOpen::UIStyler::OptionToggle::GetItems ( )

Returns the items.

Returns: An array of items
Created in NX5.0.0.

License requirements : None

int NXOpen::UIStyler::OptionToggle::GetItemValue ( bool * setCheck )

Returns item value.

Returns: Item value
Created in NX5.0.0.

License requirements : None

Parameters

setCheck set check

bool NXOpen::UIStyler::OptionToggle::GetSensitivity ( )

Returns the sesitivity.

Returns: Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::OptionToggle::SetBitmaps ( std::vector< NXString > & bitmaps )

Set bitmaps
Created in NX5.0.0.

License requirements : None

Parameters

bitmaps An array of one or more bitmap filenames. If all bitmaps for the option menu reside in the same file, specify an array of just one entry, which contains the bitmap filename for this attribute. All existing choices for the option menu remain intact when this attribute is set. Only the bitmaps are changed. Note that the number of bitmaps must match the number of existing choices.
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::OptionToggle::SetDefaultAction ( )

Sets default action
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::OptionToggle::SetItems ( std::vector< NXString > & strListArray )

Sets items in the array
Created in NX5.0.0.

License requirements : None

Parameters

strListArray An array of new choices to be used for the dialog item. Note that this removes all existing choices (both text and bitmaps).
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::OptionToggle::SetItemValue	(	int	subitemIndex,
		bool	setCheck
	)

Sets item value
Created in NX5.0.0.

License requirements : None

Parameters

subitemIndex	Zero-based index indicating the choice to be selected. It must be in the range of existing choices.
setCheck	TRUE if set, FALSE if unset.

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

Sets label
Created in NX5.0.0.

License requirements : None

Parameters

strLabel Text to be set for the tool tip.
NOTE: The full Unicode character set is not supported for this parameter.

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

Sets label
Created in NX5.0.0.

License requirements : None

Parameters

strLabel Text to be set for the tool tip.
NOTE: The full Unicode character set is not supported for this parameter.

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

Set the sesitivity
Created in NX5.0.0.

License requirements : None

Parameters

subitemIndex	If the entire dialog item should change to the new Sensitivity state, set this field to UF_STYLER_NO_SUB_INDEX. If only one sub-item should change to the new sensitivity state, set this field to its zero-based index.
type	TRUE if sensitive, FALSE if insensitive

void NXOpen::UIStyler::OptionToggle::SetVisibility ( bool type )

Sets the visibility
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if visible, FALSE if invisible

bool NXOpen::UIStyler::OptionToggle::Visibility ( )

Returns the visibility
Created in NX5.0.0.

License requirements : None

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

UIStyler_OptionToggle.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation