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

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

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

List of all members.

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Drag
 Called when a dialog user moves the slider up and down the scale.
typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
ValueChanged
 Called when a dialog user moves the slider to a new position.

Public Member Functions

void AddDragHandler (const NXOpen::UIStyler::IntegerScale::Drag &dragevent, bool isDialogLaunchingEvent)
 Registers drag callback.
void AddValueChangedHandler (const NXOpen::UIStyler::IntegerScale::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
 Registers value change callback.
int ItemValue ()
 Returns
Created in NX5.0.0.
bool Sensitivity ()
 Returns the sensitivity of the dialog item.
void SetItemValue (int itemVal)
 Sets
Created in NX5.0.0.
void SetLabels (const NXString &minimumLabel, const NXString &maximumLabel)
 Specifies the text for the minimum and maximum label.
void SetLimits (int minimumValue, int maximumValue)
 Specifies the scale's maximum and minimum value.
void SetSensitivity (bool type)
 Sets the sensitivity of the dialog item.
void SetVisibility (bool type)
 Sets the visibility of the dialog item.
bool Visibility ()
 Returns the visibility of the dialog item.

Detailed Description

Represents a IntegerScale for UI Styler
Created in NX5.0.0.



Member Typedef Documentation

Called when a dialog user moves the slider up and down the scale.

For example, if a user moves the slider from 0 to 100, the dialog calls the drag callback 100 times, one for each value that the slider moves across. Do not terminate the dialog with a drag callback. The dialog should always return UF_UI_CB_CONTINUE_DIALOG.
Created in NX5.0.0.

License requirements : None

Called when a dialog user moves the slider to a new position.

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::IntegerScale::AddDragHandler ( const NXOpen::UIStyler::IntegerScale::Drag dragevent,
bool  isDialogLaunchingEvent 
)

Registers drag callback.

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

License requirements : None

Parameters:
drageventdragevent
isDialogLaunchingEventis dialog launching event
void NXOpen::UIStyler::IntegerScale::AddValueChangedHandler ( const NXOpen::UIStyler::IntegerScale::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

Returns
Created in NX5.0.0.



License requirements : None

Returns the sensitivity of the dialog item.


Created in NX5.0.0.

License requirements : None

Sets
Created in NX5.0.0.



License requirements : None

Parameters:
itemValitem val
void NXOpen::UIStyler::IntegerScale::SetLabels ( const NXString minimumLabel,
const NXString maximumLabel 
)

Specifies the text for the minimum and maximum label.

By default, the system uses the maximum/minimum value as a text label.
Created in NX5.0.0.

License requirements : None

Parameters:
minimumLabelminimum limit for label
NOTE: The full Unicode character set is not supported for this parameter.
maximumLabelmaximum limit for label
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::UIStyler::IntegerScale::SetLimits ( int  minimumValue,
int  maximumValue 
)

Specifies the scale's maximum and minimum value.


Created in NX5.0.0.

License requirements : None

Parameters:
minimumValueto set minimum
maximumValueto set maximum

Sets the sensitivity of the dialog item.


Created in NX5.0.0.

License requirements : None

Parameters:
typeTRUE if sensitive, FALSE if insensitive

Sets the visibility of the dialog item.


Created in NX5.0.0.

License requirements : None

Parameters:
typeTRUE if visible, FALSE if invisible

Returns the visibility of the dialog item.


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.