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

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

Inheritance diagram for NXOpen::UIStyler::OptionToggle:
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
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 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< NXStringGetItems ()
 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 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.

Detailed Description

Represents a OptionToggle 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

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

Returns the items.

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

License requirements : None

Returns item value.

Returns:
Item value
Created in NX5.0.0.

License requirements : None
Parameters:
setCheckset check

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:
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 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.

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:
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::OptionToggle::SetItemValue ( int  subitemIndex,
bool  setCheck 
)

Sets 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.
setCheckTRUE if set, FALSE if unset.

Sets label
Created in NX5.0.0.



License requirements : None

Parameters:
strLabelText 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:
subitemIndexIf 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.
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.