NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::UIStyler::OptionMenu Class Reference

Represents a OptionMenu for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::OptionMenu:
NXOpen::UIStyler::StylerItem NXOpen::TransientObject

List of all members.

Public Types

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

Public Member Functions

void AddActivateHandler (const NXOpen::UIStyler::OptionMenu::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback.
std::vector< NXStringGetBitmap ()
 Returns an array of bitmaps.
std::vector< NXStringGetItems ()
 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 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.

Detailed Description

Represents a OptionMenu for UI Styler.


Created in NX5.0.0.


Member Typedef Documentation

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:
activateeventCallback for activate event
isDialogLaunchingEventTRUE if dialog is going to launch, FALSE if not

Returns an array of bitmaps.

Returns:

Created in NX5.0.0.

License requirements : None

Returns an array if items.

Returns:

Created in NX5.0.0.

License requirements : None

Gets the sensitivity.

Returns:

Created in NX5.0.0.

License requirements : None

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:
bitmapsAn 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:
strListArrayAn 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:
subitemIndexZero-based index indicating the choice to be selected. It must be in the range of existing choices.

Sets label
Created in NX5.0.0.



License requirements : None

Parameters:
strLabelText 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:
subitemIndexIf 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.
typeTRUE if sensitive, FALSE if insensitive

Sets the visibility
Created in NX5.0.0.



License requirements : None

Parameters:
typeTRUE if visible, FALSE if invisible

Returns the visibility
Created in NX5.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.