NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::UIStyler::ToolPalette Class Reference

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

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

List of all members.

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
Activate
 Called when a dialog user selects a button in the tool palette.

Public Member Functions

void AddActivateHandler (const NXOpen::UIStyler::ToolPalette::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback.
bool GetSensitivity ()
 Gets the sensitivity of the dialog item.
int ItemValue ()
 Returns the currently selected choice for this dialog item.
void SetDefault (int dialogId)
 Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.
void SetItemValue (int itemVal)
 Sets the currently selected choice for this dialog item.
void SetLabel (const NXString &strLabel)
 Specifies descriptive text to display for the dialog item.
void SetSensitivity (int subitemIndex, bool type)
 
Created in NX5.0.0.
void SetVisibility (bool type)
 Sets the visibility of the dialog item
Created in NX5.0.0.
bool Visibility ()
 Returns the visibility of the dialog item
Created in NX5.0.0.

Detailed Description

Represents a ToolPalette for UI Styler
Created in NX5.0.0.



Member Typedef Documentation

Called when a dialog user selects a button in the tool palette.


Created in NX5.0.0.

License requirements : None


Member Function Documentation

void NXOpen::UIStyler::ToolPalette::AddActivateHandler ( const NXOpen::UIStyler::ToolPalette::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

Gets the sensitivity of the dialog item.

Returns:
True if sensitivity is set otherwise False
Created in NX5.0.0.

License requirements : None

Returns the currently selected choice for this dialog item.


Created in NX5.0.0.

License requirements : None

Indicates that this dialog item should override the accelerator on the second mouse button, which normally accelerates to the OK button.

When you set this attribute, a click on the second mouse button triggers this dialog item's Activate callback instead of the action of the OK button.
Created in NX5.0.0.

License requirements : None

Parameters:
dialogIddialog id

Sets the currently selected choice for this dialog item.


Created in NX5.0.0.

License requirements : None

Parameters:
itemValItem value

Specifies descriptive text to display for the dialog item.

It should describe the dialog item's intended use.
Created in NX5.0.0.

License requirements : None

Parameters:
strLabelString label
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::UIStyler::ToolPalette::SetSensitivity ( int  subitemIndex,
bool  type 
)


Created in NX5.0.0.



License requirements : None

Parameters:
subitemIndexSub item index
typeTrue if sentivity is set otherwise False

Sets the visibility of the dialog item
Created in NX5.0.0.



License requirements : None

Parameters:
typetype

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.