NXOpen::UIStyler::RealScale Class Reference

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

Inheritance diagram for NXOpen::UIStyler::RealScale:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Drag
	Called when a dialog user moves the slider to a new position.
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	ValueChanged
	Created in NX5.0.0.
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::RealScale::Drag &dragevent, bool isDialogLaunchingEvent)
	Registers dtag callback.
void	AddValueChangedHandler (const NXOpen::UIStyler::RealScale::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
	Called when a dialog user moves the slider up and down the scale.
double	ItemValue ()
	Returns the item value Created in NX5.0.0.
bool	Sensitivity ()
	Returns the sensitivity Created in NX5.0.0.
void	SetDecimalPrecision (int digits)
	Sets decimal precision Created in NX5.0.0.
void	SetItemValue (double itemVal)
	Sets the item value Created in NX5.0.0.
void	SetLabels (const NXString &minimumLabel, const NXString &maximumLabel)
	Sets labels Created in NX5.0.0.
void	SetLabels (const char *minimumLabel, const char *maximumLabel)
	Sets labels Created in NX5.0.0.
void	SetLimits (double minimumValue, double maximumValue)
	Sets limits Created in NX5.0.0.
void	SetSensitivity (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.
Public Member Functions inherited from NXOpen::UIStyler::StylerItem
NXOpen::UIStyler::StylerItem::ItemType	GetItemType ()
	Gets the dialog item type.
NXOpen::UIStyler::Attachment *	InitializeAttachment ()
	Returns initialized dialog item attachment information.
bool	IsEqualTo (NXOpen::UIStyler::StylerItem *itemToCompare)
	Equates two styler items.
void	SetAttachment (NXOpen::UIStyler::Attachment *attachment)
	Specifies the updated dialog item attachment information Created in NX5.0.0.
virtual	~StylerItem ()
	Free resources associated with the instance.
Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

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

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::RealScale::Drag

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

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::RealScale::ValueChanged

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::RealScale::AddDragHandler	(	const NXOpen::UIStyler::RealScale::Drag &	dragevent,
		bool	isDialogLaunchingEvent
	)

Registers dtag callback.

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

License requirements : None

Parameters

dragevent	Callback for add drag event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

void NXOpen::UIStyler::RealScale::AddValueChangedHandler	(	const NXOpen::UIStyler::RealScale::ValueChanged &	valuechangedevent,
		bool	isDialogLaunchingEvent
	)

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

For example, if a user moves the slider from 0.0 to 10.0, 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

Parameters

valuechangedevent	Callback for value changed event
isDialogLaunchingEvent	TRUE if dialog is going to launch, FALSE if not

double NXOpen::UIStyler::RealScale::ItemValue

(

)

Returns the item value
Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::RealScale::Sensitivity

(

)

Returns the sensitivity
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::RealScale::SetDecimalPrecision

(

int

digits

)

Sets decimal precision
Created in NX5.0.0.

License requirements : None

Parameters

digits

The number significant digits

void NXOpen::UIStyler::RealScale::SetItemValue

(

double

itemVal

)

Sets the item value
Created in NX5.0.0.

License requirements : None

Parameters

itemVal

New real value for the slider. It must be within the min/max range

void NXOpen::UIStyler::RealScale::SetLabels	(	const NXString &	minimumLabel,
		const NXString &	maximumLabel
	)

Sets labels
Created in NX5.0.0.

License requirements : None

Parameters

minimumLabel	String minimum label NOTE: The full Unicode character set is not supported for this parameter.
maximumLabel	String maximum label NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::RealScale::SetLabels	(	const char *	minimumLabel,
		const char *	maximumLabel
	)

Sets labels
Created in NX5.0.0.

License requirements : None

Parameters

minimumLabel	String minimum label NOTE: The full Unicode character set is not supported for this parameter.
maximumLabel	String maximum label NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::RealScale::SetLimits	(	double	minimumValue,
		double	maximumValue
	)

Sets limits
Created in NX5.0.0.

License requirements : None

Parameters

minimumValue	Real minimum value
maximumValue	Real maximum value

void NXOpen::UIStyler::RealScale::SetSensitivity

(

bool

type

)

Sets the sensitivity
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if sensitive, FALSE if insensitive

void NXOpen::UIStyler::RealScale::SetVisibility

(

bool

type

)

Sets the visibility
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if visible, FALSE if invisible

bool NXOpen::UIStyler::RealScale::Visibility

(

)

Returns the visibility
Created in NX5.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• UIStyler_RealScale.hxx