NXOpen::UIStyler::OptionMenu Class Reference

Represents a OptionMenu for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::OptionMenu:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Activate
	Called when a dialog user selects an option from the menu.
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::OptionMenu::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback.
std::vector< NXString >	GetBitmap ()
	Returns an array of bitmaps.
std::vector< NXString >	GetItems ()
	Returns an array if items.
bool	GetSensitivity ()
	Gets the sensitivity.
int	ItemValue ()
	Returns the item value Created in NX5.0.0.
void	SetBitmap (std::vector< NXString > &bitmaps)
	Set an array of bitmap filenames Created in NX5.0.0.
void	SetItems (std::vector< NXString > &strListArray)
	Set an array of items Created in NX5.0.0.
void	SetItemValue (int subitemIndex)
	Sets the 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)
	Sets the sensitivity 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 OptionMenu for UI Styler.

Created in NX5.0.0.

Member Typedef Documentation

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

Called when a dialog user selects an option from the menu.

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::OptionMenu::AddActivateHandler	(	const NXOpen::UIStyler::OptionMenu::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

std::vector<NXString> NXOpen::UIStyler::OptionMenu::GetBitmap

(

)

Returns an array of bitmaps.

Returns

Created in NX5.0.0.

License requirements : None

std::vector<NXString> NXOpen::UIStyler::OptionMenu::GetItems

(

)

Returns an array if items.

Returns

Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::OptionMenu::GetSensitivity

(

)

Gets the sensitivity.

Returns

Created in NX5.0.0.

License requirements : None

int NXOpen::UIStyler::OptionMenu::ItemValue

(

)

Returns the item value
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::OptionMenu::SetBitmap

(

std::vector< NXString > &

bitmaps

)

Set an array of bitmap filenames
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 remains 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::OptionMenu::SetItems

(

std::vector< NXString > &

strListArray

)

Set an array of items
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::OptionMenu::SetItemValue

(

int

subitemIndex

)

Sets the 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.

void NXOpen::UIStyler::OptionMenu::SetLabel

(

const NXString &

strLabel

)

Sets label
Created in NX5.0.0.

License requirements : None

Parameters

strLabel

Text to be set for the descriptive label. NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::OptionMenu::SetLabel

(

const char *

strLabel

)

Sets label
Created in NX5.0.0.

License requirements : None

Parameters

strLabel

Text to be set for the descriptive label. NOTE: The full Unicode character set is not supported for this parameter.

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

Sets the sensitivity
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 subitem 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::OptionMenu::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::OptionMenu::Visibility

(

)

Returns the visibility
Created in NX5.0.0.

License requirements : None

---

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

• UIStyler_OptionMenu.hxx