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

Represents a ColorTool for UI Styler. More...

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

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
ValueChanged
 Called when a dialog user enters a valid color value. 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 AddValueChangedHandler (const NXOpen::UIStyler::ColorTool::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
 Registers value change callback. More...
 
int ItemValue ()
 Returns the item value
Created in NX5.0.0. More...
 
bool Sensitivity ()
 Returns the sensitivity
Created in NX5.0.0. More...
 
void SetItemValue (int itemVal)
 Sets the item value
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 ColorTool for UI Styler.


Created in NX5.0.0.

Member Typedef Documentation

Called when a dialog user enters a valid color value.


Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::ColorTool::AddValueChangedHandler ( const NXOpen::UIStyler::ColorTool::ValueChanged valuechangedevent,
bool  isDialogLaunchingEvent 
)

Registers value change callback.

This method should be called before calling UIStyler::Dialog::Show or UIStyler::Dialog::RegisterWithUiMenu
Created in NX5.0.0.

License requirements : None

Parameters
valuechangedeventCallback for value changed event
isDialogLaunchingEventTRUE if dialog is going to launch, FALSE if not
int NXOpen::UIStyler::ColorTool::ItemValue ( )

Returns the item value
Created in NX5.0.0.



License requirements : None

bool NXOpen::UIStyler::ColorTool::Sensitivity ( )

Returns the sensitivity
Created in NX5.0.0.



License requirements : None

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

Sets the item value
Created in NX5.0.0.



License requirements : None

Parameters
itemValInteger value to display in the text field
void NXOpen::UIStyler::ColorTool::SetSensitivity ( bool  type)

Sets the sensitivity
Created in NX5.0.0.



License requirements : None

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

Sets the visibility
Created in NX5.0.0.



License requirements : None

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