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

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

Inheritance diagram for NXOpen::UIStyler::RealItem:
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 real value and presses Return. 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::RealItem::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
double ItemValue ()
 Returns the item value
Created in NX5.0.0. More...
 
bool Sensitivity ()
 Returns the sensitivity
Created in NX5.0.0. More...
 
void SetBitmap (const NXString &strBitmap)
 
Created in NX5.0.0. More...
 
void SetBitmap (const char *strBitmap)
 
Created in NX5.0.0. More...
 
void SetFocus ()
 Sets focus
Created in NX5.0.0. More...
 
void SetItemValue (double itemVal)
 Sets the item value
Created in NX5.0.0. More...
 
void SetLabel (const NXString &strLabel)
 Set the label
Created in NX5.0.0. More...
 
void SetLabel (const char *strLabel)
 Set the label
Created in NX5.0.0. More...
 
void SetSensitivity (bool type)
 Sets the sensitivity
Created in NX5.0.0. More...
 
void SetVisibility (bool type)
 Sets the visibility
Created in NX5.0.0. More...
 
bool Visibility ()
 Returns the visibility
Created in NX5.0.0. 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 Real for UI Styler
Created in NX5.0.0.


Member Typedef Documentation

Called when a dialog user enters a valid real value and presses Return.


Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::RealItem::AddActivateHandler ( const NXOpen::UIStyler::RealItem::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
activateeventCallback for activate event
isDialogLaunchingEventTRUE if dialog is going to launch, FALSE if not
double NXOpen::UIStyler::RealItem::ItemValue ( )

Returns the item value
Created in NX5.0.0.



License requirements : None

bool NXOpen::UIStyler::RealItem::Sensitivity ( )

Returns the sensitivity
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::RealItem::SetBitmap ( const NXString strBitmap)


Created in NX5.0.0.



License requirements : None

Parameters
strBitmapFilename with .ubm, .xpm, or .bmp extension that contains a bitmap definition
void NXOpen::UIStyler::RealItem::SetBitmap ( const char *  strBitmap)


Created in NX5.0.0.



License requirements : None

Parameters
strBitmapFilename with .ubm, .xpm, or .bmp extension that contains a bitmap definition
void NXOpen::UIStyler::RealItem::SetFocus ( )

Sets focus
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::RealItem::SetItemValue ( double  itemVal)

Sets the item value
Created in NX5.0.0.



License requirements : None

Parameters
itemValReal value to display in the text field
void NXOpen::UIStyler::RealItem::SetLabel ( const NXString strLabel)

Set the label
Created in NX5.0.0.



License requirements : None

Parameters
strLabelText label to display on the left side of the text field.
void NXOpen::UIStyler::RealItem::SetLabel ( const char *  strLabel)

Set the label
Created in NX5.0.0.



License requirements : None

Parameters
strLabelText label to display on the left side of the text field.
void NXOpen::UIStyler::RealItem::SetSensitivity ( bool  type)

Sets the sensitivity
Created in NX5.0.0.



License requirements : None

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

Sets the visibility
Created in NX5.0.0.



License requirements : None

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

Returns the visibility
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.