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

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

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

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Activate
 Called when a dialog user clicks on the push button or presses the spacebar when the push button has keyboard focus. 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::PushButton::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
bool Sensitivity ()
 Returns the senstivity of dialog. 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 SetDefaultAction ()
 Sets default action
Created in NX5.0.0. More...
 
void SetFocus ()
 Indicates that this dialog item is receiving keyboard focus. 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 senstivity of dialog. More...
 
void SetVisibility (bool type)
 Sets the visibility of dialog. More...
 
bool Visibility ()
 Returns the visibility of dialog. 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 PushButton for UI Styler
Created in NX5.0.0.


Member Typedef Documentation

Called when a dialog user clicks on the push button or presses the spacebar when the push button has keyboard focus.


Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::PushButton::AddActivateHandler ( const NXOpen::UIStyler::PushButton::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
bool NXOpen::UIStyler::PushButton::Sensitivity ( )

Returns the senstivity of dialog.


Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::PushButton::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 a popup hint when a user places the mouse cursor over the bitmap.
Created in NX5.0.0.

License requirements : None

Parameters
bitmapthe bitmap extension
void NXOpen::UIStyler::PushButton::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 a popup hint when a user places the mouse cursor over the bitmap.
Created in NX5.0.0.

License requirements : None

Parameters
bitmapthe bitmap extension
void NXOpen::UIStyler::PushButton::SetDefaultAction ( )

Sets default action
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::PushButton::SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.


Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::PushButton::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
strLabelthe label string
void NXOpen::UIStyler::PushButton::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
strLabelthe label string
void NXOpen::UIStyler::PushButton::SetSensitivity ( bool  type)

Sets the senstivity of dialog.


Created in NX5.0.0.

License requirements : None

Parameters
typeto set senstivity of dialog
void NXOpen::UIStyler::PushButton::SetVisibility ( bool  type)

Sets the visibility of dialog.


Created in NX5.0.0.

License requirements : None

Parameters
typeto set visibility of dialog
bool NXOpen::UIStyler::PushButton::Visibility ( )

Returns the visibility of dialog.


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.