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

Represents a Button Layout for UI Styler. More...

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

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Activate
 Called when a dialog user clicks on a push button or presses the spacebar when a 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::ButtonLayout::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback. More...
 
int GetSelectedIndexValue ()
 Gets selected index. More...
 
bool GetSensitivity ()
 Gets the sensitivity. More...
 
void SetDefaultAction ()
 Sets default action
Created in NX5.0.0. More...
 
void SetSensitivity (int subitemIndex, 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 Button Layout for UI Styler.


Created in NX5.0.0.

Member Typedef Documentation

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


Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::ButtonLayout::AddActivateHandler ( const NXOpen::UIStyler::ButtonLayout::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
int NXOpen::UIStyler::ButtonLayout::GetSelectedIndexValue ( )

Gets selected index.

Returns

Created in NX5.0.0.

License requirements : None
bool NXOpen::UIStyler::ButtonLayout::GetSensitivity ( )

Gets the sensitivity.

Returns

Created in NX5.0.0.

License requirements : None
void NXOpen::UIStyler::ButtonLayout::SetDefaultAction ( )

Sets default action
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::ButtonLayout::SetSensitivity ( int  subitemIndex,
bool  type 
)

Sets the sensitivity
Created in NX5.0.0.



License requirements : None

Parameters
subitemIndexIf the entire dialog item should change to the new sensitivity state, set this field to UF_STYLER_NO_SUB_INDEX. If only one subitem should change to the new sensitivity state, set this field to its zero-based index.
typeTRUE if sensitive, FALSE if insensitive
void NXOpen::UIStyler::ButtonLayout::SetVisibility ( bool  type)

Sets the visibility
Created in NX5.0.0.



License requirements : None

Parameters
typeTRUE if visible, FALSE if invisible
bool NXOpen::UIStyler::ButtonLayout::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.