Represents a ToolPalette for UI Styler
Created in NX5.0.0.
More...
Public Types | |
| typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * > | Activate |
| Called when a dialog user selects a button in the tool palette. 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::ToolPalette::Activate &activateevent, bool isDialogLaunchingEvent) |
| Registers activate callback. More... | |
| bool | GetSensitivity () |
| Gets the sensitivity of the dialog item. More... | |
| int | ItemValue () |
| Returns the currently selected choice for this dialog item. More... | |
| 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. More... | |
| void | SetItemValue (int itemVal) |
| Sets the currently selected choice for this dialog item. 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 (int subitemIndex, bool type) |
Created in NX5.0.0. More... | |
| void | SetVisibility (bool type) |
| Sets the visibility of the dialog item Created in NX5.0.0. More... | |
| bool | Visibility () |
| Returns the visibility of the dialog item 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::Attachment * | InitializeAttachment () |
| 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 ToolPalette for UI Styler
Created in NX5.0.0.
Member Typedef Documentation
| typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::ToolPalette::Activate |
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
-
activateevent activateevent isDialogLaunchingEvent is dialog launching event
| bool NXOpen::UIStyler::ToolPalette::GetSensitivity | ( | ) |
Gets the sensitivity of the dialog item.
- Returns
- True if sensitivity is set otherwise False
Created in NX5.0.0.
License requirements : None
| int NXOpen::UIStyler::ToolPalette::ItemValue | ( | ) |
Returns the currently selected choice for this dialog item.
Created in NX5.0.0.
License requirements : None
| void NXOpen::UIStyler::ToolPalette::SetDefault | ( | int | dialogId | ) |
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
-
dialogId dialog id
| void NXOpen::UIStyler::ToolPalette::SetItemValue | ( | int | itemVal | ) |
Sets the currently selected choice for this dialog item.
Created in NX5.0.0.
License requirements : None
- Parameters
-
itemVal Item value
| void NXOpen::UIStyler::ToolPalette::SetLabel | ( | const NXString & | strLabel | ) |
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
-
strLabel String label
| void NXOpen::UIStyler::ToolPalette::SetLabel | ( | const char * | strLabel | ) |
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
-
strLabel String label
| void NXOpen::UIStyler::ToolPalette::SetSensitivity | ( | int | subitemIndex, |
| bool | type | ||
| ) |
Created in NX5.0.0.
License requirements : None
- Parameters
-
subitemIndex Sub item index type True if sentivity is set otherwise False
| void NXOpen::UIStyler::ToolPalette::SetVisibility | ( | bool | type | ) |
Sets the visibility of the dialog item
Created in NX5.0.0.
License requirements : None
- Parameters
-
type type
| bool NXOpen::UIStyler::ToolPalette::Visibility | ( | ) |
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:
- UIStyler_ToolPalette.hxx