NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::UIStyler::IntegerItem Class Reference

Represents a Integer for UI Styler. More...

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

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Activate
 Called when a dialog user enters a valid integer value and presses Return
Created in NX5.0.0. 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 AddActivateHandler (const NXOpen::UIStyler::IntegerItem::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
int ItemValue ()
 Returns the value obtained from the text field. More...
 
bool Sensitivity ()
 Returns the sensitivity of Integer item
Created in NX5.0.0. More...
 
void SetBitmap (const NXString &bitmap)
 Specifies a filename that contains a bitmap definition. More...
 
void SetBitmap (const char *bitmap)
 Specifies a filename that contains a bitmap definition. More...
 
void SetFocus ()
 Sets focus
Created in NX5.0.0. More...
 
void SetItemValue (int itemVal)
 Sets the value obtained from the text field. More...
 
void SetLabel (const NXString &strLabel)
 Specifies descriptive text to display for the dialog item. More...
 
void SetLabel (const char *strLabel)
 Specifies descriptive text to display for the dialog item. More...
 
void SetSensitivity (bool type)
 Sets the sensitivity of Integer item
Created in NX5.0.0. 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 Integer for UI Styler.


Created in NX5.0.0.

Member Typedef Documentation

Called when a dialog user enters a valid integer value and presses Return
Created in NX5.0.0.



License requirements : None

Member Function Documentation

void NXOpen::UIStyler::IntegerItem::AddActivateHandler ( const NXOpen::UIStyler::IntegerItem::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
activateeventactivateevent
isDialogLaunchingEventis dialog launching event
int NXOpen::UIStyler::IntegerItem::ItemValue ( )

Returns the value obtained from the text field.


Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::IntegerItem::Sensitivity ( )

Returns the sensitivity of Integer item
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::IntegerItem::SetBitmap ( const NXString bitmap)

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
bitmapFilename with .ubm, .xpm, or .bmp extension that contains bitmap definition
void NXOpen::UIStyler::IntegerItem::SetBitmap ( const char *  bitmap)

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
bitmapFilename with .ubm, .xpm, or .bmp extension that contains bitmap definition
void NXOpen::UIStyler::IntegerItem::SetFocus ( )

Sets focus
Created in NX5.0.0.



License requirements : None

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

Sets the value obtained from the text field.


Created in NX5.0.0.

License requirements : None

Parameters
itemValitem val
void NXOpen::UIStyler::IntegerItem::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
strLabelString to display on the left side of the text field.
void NXOpen::UIStyler::IntegerItem::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
strLabelString to display on the left side of the text field.
void NXOpen::UIStyler::IntegerItem::SetSensitivity ( bool  type)

Sets the sensitivity of Integer item
Created in NX5.0.0.



License requirements : None

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

Sets the visibility of the dialog item.


Created in NX5.0.0.

License requirements : None

Parameters
typeTRUE if the dialog item is sensitive; FALSE if insensitive
bool NXOpen::UIStyler::IntegerItem::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.