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

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

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

Public Types

typedef NXOpen::Callback1
< NXOpen::UIStyler::DialogState,
NXOpen::UIStyler::StylerEvent * > 
ValueChanged
 Called when a dialog user click on a button in the radio box. 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::RadioBox::ValueChanged &valuechangedevent, bool isDialogLaunchingEvent)
 Registers value change callback. More...
 
bool GetSensitivity ()
 Gets the sensitivity. More...
 
int ItemValue ()
 Returns the item value
Created in NX5.0.0. More...
 
void SetDefaultAction ()
 Set default action
Created in NX5.0.0. More...
 
void SetItemValue (int itemVal)
 Sets the item value
Created in NX5.0.0. More...
 
void SetLabel (const NXString &strLabel)
 Sets label
Created in NX5.0.0. More...
 
void SetLabel (const char *strLabel)
 Sets label
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 RadioBox for UI Styler
Created in NX5.0.0.


Member Typedef Documentation

Called when a dialog user click on a button in the radio box.

Do not terminate the dialog with a value-changed callback. The dialog should always return UF_UI_CB_CONTINUE_DIALOG.
Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::RadioBox::AddValueChangedHandler ( const NXOpen::UIStyler::RadioBox::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
bool NXOpen::UIStyler::RadioBox::GetSensitivity ( )

Gets the sensitivity.

Returns

Created in NX5.0.0.

License requirements : None
int NXOpen::UIStyler::RadioBox::ItemValue ( )

Returns the item value
Created in NX5.0.0.



License requirements : None

void NXOpen::UIStyler::RadioBox::SetDefaultAction ( )

Set default action
Created in NX5.0.0.



License requirements : None

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

Sets the item value
Created in NX5.0.0.



License requirements : None

Parameters
itemValZero-based index indicating the choice to be selected. It must be in the range of existing choices.
void NXOpen::UIStyler::RadioBox::SetLabel ( const NXString strLabel)

Sets label
Created in NX5.0.0.



License requirements : None

Parameters
strLabelText to be set for the descriptive label
void NXOpen::UIStyler::RadioBox::SetLabel ( const char *  strLabel)

Sets label
Created in NX5.0.0.



License requirements : None

Parameters
strLabelText to be set for the descriptive label
void NXOpen::UIStyler::RadioBox::SetSensitivity ( int  subitemIndex,
bool  type 
)

Sets the sensitivity
Created in NX5.0.0.



License requirements : None

Parameters
subitemIndexsubitem index
typeTRUE if visible, FALSE if invisible
void NXOpen::UIStyler::RadioBox::SetVisibility ( bool  type)

Sets the visibility
Created in NX5.0.0.



License requirements : None

Parameters
typeTRUE if sensitive, FALSE if insensitive
bool NXOpen::UIStyler::RadioBox::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.