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

Represents a Toggle for UI Styler. More...

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

List of all members.

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

Detailed Description

Represents a Toggle for UI Styler.


Created in NX5.0.0.


Member Typedef Documentation

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:
valuechangedeventValue changed event
isDialogLaunchingEventTrue if launch any dialog else False

Gets the sensitivity.

Returns:

Created in NX5.0.0.

License requirements : None

Returns an item value
Created in NX5.0.0.



License requirements : None

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

Indicates that this dialog item is receiving keyboard focus.


Created in NX5.0.0.

License requirements : None

Sets an item value
Created in NX5.0.0.



License requirements : None

Parameters:
itemValitem 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::SetSensitivity ( int  subitemIndex,
bool  type 
)

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



License requirements : None

Parameters:
subitemIndexsubitem index
typetype

Sets the visibility of the toggle
Created in NX5.0.0.



License requirements : None

Parameters:
typetype

Returns the visibility of the toggle
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.