NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
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

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. More...
 
typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
ValueChanged
 Called when a dialog user moves the slider to a new position. More...
 
- 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 AddDragHandler (const NXOpen::UIStyler::IntegerScale::Drag &dragevent, bool isDialogLaunchingEvent)
 Registers drag callback. More...
 
void AddValueChangedHandler (const NXOpen::UIStyler::IntegerScale::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
 Registers value change callback. More...
 
int ItemValue ()
 Returns
Created in NX5.0.0. More...
 
bool Sensitivity ()
 Returns the sensitivity of the dialog item. More...
 
void SetItemValue (int itemVal)
 Sets
Created in NX5.0.0. More...
 
void SetLabels (const NXString &minimumLabel, const NXString &maximumLabel)
 Specifies the text for the minimum and maximum label. More...
 
void SetLabels (const char *minimumLabel, const char *maximumLabel)
 Specifies the text for the minimum and maximum label. More...
 
void SetLimits (int minimumValue, int maximumValue)
 Specifies the scale's maximum and minimum value. More...
 
void SetSensitivity (bool type)
 Sets the sensitivity of the dialog item. More...
 
void SetVisibility (bool type)
 Sets the visibility of the dialog item. More...
 
bool Visibility ()
 Returns the visibility of the dialog item. More...
 
- Public Member Functions inherited from NXOpen::UIStyler::StylerItem
NXOpen::UIStyler::StylerItem::ItemType GetItemType ()
 Gets the dialog item type. More...
 
NXOpen::UIStyler::AttachmentInitializeAttachment ()
 Returns initialized dialog item attachment information. More...
 
bool IsEqualTo (NXOpen::UIStyler::StylerItem *itemToCompare)
 Equates two styler items. More...
 
void SetAttachment (NXOpen::UIStyler::Attachment *attachment)
 Specifies the updated dialog item attachment information
Created in NX5.0.0. More...
 
virtual ~StylerItem ()
 Free resources associated with the instance. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

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
int NXOpen::UIStyler::IntegerScale::ItemValue ( )

Returns
Created in NX5.0.0.



License requirements : None

bool NXOpen::UIStyler::IntegerScale::Sensitivity ( )

Returns the sensitivity of the dialog item.


Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::IntegerScale::SetItemValue ( int  itemVal)

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
maximumLabelmaximum limit for label
void NXOpen::UIStyler::IntegerScale::SetLabels ( const char *  minimumLabel,
const char *  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
maximumLabelmaximum limit for label
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
void NXOpen::UIStyler::IntegerScale::SetSensitivity ( bool  type)

Sets the sensitivity of the dialog item.


Created in NX5.0.0.

License requirements : None

Parameters
typeTRUE if sensitive, FALSE if insensitive
void NXOpen::UIStyler::IntegerScale::SetVisibility ( bool  type)

Sets the visibility of the dialog item.


Created in NX5.0.0.

License requirements : None

Parameters
typeTRUE if visible, FALSE if invisible
bool NXOpen::UIStyler::IntegerScale::Visibility ( )

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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.