Represents a StringItem for UI Styler. More...

Inheritance diagram for NXOpen::UIStyler::StringItem:

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::StringItem::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback.

bool	GetSensitivity ()
	To get senstivity of string control.

NXString	ItemValue ()
	Returns the string value for this dialog item.

void	SetBitmap (const NXString &strBitmap)
	Specifies a filename that contains a bitmap definition.

void	SetBitmap (const char *strBitmap)
	Specifies a filename that contains a bitmap definition.

void	SetFocus ()
	Indicates that this dialog item is receiving keyboard focus Created in NX5.0.0.

void	SetItemValue (const NXString &itemVal)
	Sets the string value for this dialog item.

void	SetItemValue (const char *itemVal)
	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)
	Specifies the sensitivity of the dialog item.

void	SetVisibility (bool type)
	Sets the visibility of the dialog item Created in NX5.0.0.

bool	Visibility ()
	Returns the visibility of the dialog item 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 StringItem for UI Styler.

Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::StringItem::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::StringItem::AddActivateHandler	(	const NXOpen::UIStyler::StringItem::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

bool NXOpen::UIStyler::StringItem::GetSensitivity ( )

To get senstivity of string control.

Returns: TRUE if sensitive, FALSE if insensitive
Created in NX5.0.0.

License requirements : None

NXString NXOpen::UIStyler::StringItem::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

void NXOpen::UIStyler::StringItem::SetBitmap ( const NXString & strBitmap )

Specifies a filename that contains a bitmap definition.

The filename must contain a UBM, XPM, or BMP extension. When you use this field, the system displays a bitmap for this dialog item instead of a text label. When a bitmap is present, the system uses the text label as tooltip text when a user places the mouse cursor over the bitmap. We recommend that you use a 16x16 bitmap for this dialog item.
Created in NX5.0.0.

License requirements : None

Parameters

strBitmap Filename with .ubm, .xpm, or .bmp extension that contains bitmap definition
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::StringItem::SetBitmap ( const char * strBitmap )

Specifies a filename that contains a bitmap definition.

The filename must contain a UBM, XPM, or BMP extension. When you use this field, the system displays a bitmap for this dialog item instead of a text label. When a bitmap is present, the system uses the text label as tooltip text when a user places the mouse cursor over the bitmap. We recommend that you use a 16x16 bitmap for this dialog item.
Created in NX5.0.0.

License requirements : None

Parameters

strBitmap Filename with .ubm, .xpm, or .bmp extension that contains bitmap definition
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::StringItem::SetFocus ( )

Indicates that this dialog item is receiving keyboard focus
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::StringItem::SetItemValue ( const NXString & itemVal )

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

itemVal String value

void NXOpen::UIStyler::StringItem::SetItemValue ( const char * itemVal )

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

itemVal String value

void NXOpen::UIStyler::StringItem::SetLabel ( const NXString & strLabel )

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use. If you specify a bitmap for this dialog item, it uses this text as tooltip text.

Created in NX5.0.0.

License requirements : None

Parameters

strLabel String label to display on the left side of the text field
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::StringItem::SetLabel ( const char * strLabel )

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use. If you specify a bitmap for this dialog item, it uses this text as tooltip text.

Created in NX5.0.0.

License requirements : None

Parameters

strLabel String label to display on the left side of the text field
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::StringItem::SetSensitivity ( bool type )

Specifies the sensitivity of the dialog item.

When you set sensitivity to False, it grays out the dialog item. This indicates that the dialog item exists but is not active.
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if sensitive, FALSE if insensitive

void NXOpen::UIStyler::StringItem::SetVisibility ( bool type )

Sets the visibility of the dialog item
Created in NX5.0.0.

License requirements : None

Parameters

type	TRUE if visible, FALSE if invisible

bool NXOpen::UIStyler::StringItem::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:

UIStyler_StringItem.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation