NXOpen::UIStyler::WideString Class Reference

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

Inheritance diagram for NXOpen::UIStyler::WideString:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Activate
	Called when a dialog user enters a character string and presses Return.
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	AddActivateHandler (const NXOpen::UIStyler::WideString::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback.
NXString	ItemValue ()
	Returns the string value for this dialog item.
bool	Sensitivity ()
	Returns the sensitivity of the wide string Created in NX5.0.0.
void	SetFocus ()
	Indicates that this dialog item is receiving keyboard focus.
void	SetItemValue (const NXString &itemValue)
	Sets the string value for this dialog item.
void	SetItemValue (const char *itemValue)
	Sets the string value for this dialog item.
void	SetLabel (const NXString &strLabel)
	Specifies descriptive text to display for the dialog item.
void	SetLabel (const char *strLabel)
	Specifies descriptive text to display for the dialog item.
void	SetSensitivity (bool type)
	Sets the sensitivity of the wide string Created in NX5.0.0.
void	SetVisibility (bool type)
	Sets the visibility of the wide string Created in NX5.0.0.
bool	Visibility ()
	Returns the visibility of the wide string 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 WideString for UI Styler
Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::WideString::Activate

Called when a dialog user enters a character string and presses Return.

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::WideString::AddActivateHandler	(	const NXOpen::UIStyler::WideString::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

activateevent	activateevent
isDialogLaunchingEvent	is dialog launching event

NXString NXOpen::UIStyler::WideString::ItemValue

(

)

Returns the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user. 

Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::WideString::Sensitivity

(

)

Returns the sensitivity of the wide string
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::WideString::SetFocus

(

)

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::WideString::SetItemValue

(

const NXString &

itemValue

)

Sets the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user. 

Created in NX5.0.0.

License requirements : None

Parameters

itemValue

item value

void NXOpen::UIStyler::WideString::SetItemValue

(

const char *

itemValue

)

Sets the string value for this dialog item.

It can be the initial value that is programmatically defined, or interactively entered by the user. 

Created in NX5.0.0.

License requirements : None

Parameters

itemValue

item value

void NXOpen::UIStyler::WideString::SetLabel

(

const NXString &

strLabel

)

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use
Created in NX5.0.0.

License requirements : None

Parameters

strLabel

Label string NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::WideString::SetLabel

(

const char *

strLabel

)

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use
Created in NX5.0.0.

License requirements : None

Parameters

strLabel

Label string NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::WideString::SetSensitivity

(

bool

type

)

Sets the sensitivity of the wide string
Created in NX5.0.0.

License requirements : None

Parameters

type

type

void NXOpen::UIStyler::WideString::SetVisibility

(

bool

type

)

Sets the visibility of the wide string
Created in NX5.0.0.

License requirements : None

Parameters

type

type

bool NXOpen::UIStyler::WideString::Visibility

(

)

Returns the visibility of the wide string
Created in NX5.0.0.

License requirements : None

---

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

• UIStyler_WideString.hxx