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

Inheritance diagram for NXOpen::UIStyler::SelectionBox:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Activate
	Called when a dialog user selects a list entry with a single mouse click, presses the spacebar on a selected list entry, or presses Return when the cursor is in the text field. More...

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	DoubleClick
	Called when a dialog user double-clicks on an option in the selection box or presses Return when an item is already selected. 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::SelectionBox::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback. More...

void	AddDoubleClickHandler (const NXOpen::UIStyler::SelectionBox::DoubleClick &doubleclickevent, bool isDialogLaunchingEvent)
	Registers double click callback. More...

void	Append (std::vector< NXString > &multiEntries)
	Appends one or more entries to be inserted into the list Created in NX5.0.0. More...

void	DeleteSubItem (int subItemIndex)
	Deletes sub item Created in NX5.0.0. More...

void	DeselectSubItem (int subItemIndex)
	Requests a list entry to be deselected. More...

std::vector< NXString >	GetListItems ()
	Gets an array of character strings for item names that are used as selectable choices for this dialog item. More...

int	GetSelectedIndexValue ()
	Gets selected index value. More...

NXString	GetSelectedString ()
	Gets selected string. More...

void	InsertSubItem (int subitemIndex, std::vector< NXString > &multiEntries)
	Requests that one or more entries be inserted into the list. More...

bool	Sensitivity ()
	Returns the sensitivity of the selection box Created in NX5.0.0. More...

void	SetFocus ()
	Indicates that this dialog item is receiving keyboard focus. More...

void	SetLabel (const NXString &strLabel)
	Specifies the descriptive text string to display below the scrolled list and above the text field. More...

void	SetLabel (const char *strLabel)
	Specifies the descriptive text string to display below the scrolled list and above the text field. More...

void	SetListItems (std::vector< NXString > &values)
	Specifies an array of character strings for item names that are used as selectable choices for this dialog item. More...

void	SetSensitivity (bool type)
	Sets the sensitivity of the selection box Created in NX5.0.0. More...

void	SetValue (int value)
	Sets the value Created in NX5.0.0. More...

void	SetVisibility (bool type)
	Sets the visibility of the selection box Created in NX5.0.0. More...

void	ShowSubItem (int subItemIndex)
	Requests that a list entry be scrolled up to the first line in the list. More...

bool	Visibility ()
	Returns the visibility of the selection box 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 SelectionBox for UI Styler
Created in NX5.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::SelectionBox::Activate

Called when a dialog user selects a list entry with a single mouse click, presses the spacebar on a selected list entry, or presses Return when the cursor is in the text field.

Created in NX5.0.0.

License requirements : None

typedef NXOpen::Callback1<NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent *> NXOpen::UIStyler::SelectionBox::DoubleClick

Called when a dialog user double-clicks on an option in the selection box or presses Return when an item is already selected.

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::SelectionBox::AddActivateHandler	(	const NXOpen::UIStyler::SelectionBox::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	Activate event
isDialogLaunchingEvent	TRUE if launch new dialog, FALSE if not

void NXOpen::UIStyler::SelectionBox::AddDoubleClickHandler	(	const NXOpen::UIStyler::SelectionBox::DoubleClick &	doubleclickevent,
		bool	isDialogLaunchingEvent
	)

Registers double click callback.

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

License requirements : None

Parameters

doubleclickevent	Double click event
isDialogLaunchingEvent	TRUE if launch new dialog, FALSE if not

void NXOpen::UIStyler::SelectionBox::Append ( std::vector< NXString > & multiEntries )

Appends one or more entries to be inserted into the list
Created in NX5.0.0.

License requirements : None

Parameters

multiEntries An array of entry names to be inserted into the list. This field is used only when more than one entry are to be inserted into the list.

void NXOpen::UIStyler::SelectionBox::DeleteSubItem ( int subItemIndex )

Deletes sub item
Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex subitemindex

void NXOpen::UIStyler::SelectionBox::DeselectSubItem ( int subItemIndex )

Requests a list entry to be deselected.

Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex subitemindex

std::vector<NXString> NXOpen::UIStyler::SelectionBox::GetListItems ( )

Gets an array of character strings for item names that are used as selectable choices for this dialog item.

Returns: List of items
Created in NX5.0.0.

License requirements : None

int NXOpen::UIStyler::SelectionBox::GetSelectedIndexValue ( )

Gets selected index value.

Returns: Created in NX5.0.0.

License requirements : None

NXString NXOpen::UIStyler::SelectionBox::GetSelectedString ( )

Gets selected string.

Returns: Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::SelectionBox::InsertSubItem	(	int	subitemIndex,
		std::vector< NXString > &	multiEntries
	)

Requests that one or more entries be inserted into the list.

You can insert entries at the bottom of the list or at any position within the list.
Created in NX5.0.0.

License requirements : None

Parameters

subitemIndex	Position index where the insertion should be made. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then the new list entries are added to the bottom of the list.
multiEntries	multi entries

bool NXOpen::UIStyler::SelectionBox::Sensitivity ( )

Returns the sensitivity of the selection box
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::SelectionBox::SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::SelectionBox::SetLabel ( const NXString & strLabel )

Specifies the descriptive text string to display below the scrolled list and above the text field.

It describes the dialog item's usage.
Created in NX5.0.0.

License requirements : None

Parameters

strLabel Label string

void NXOpen::UIStyler::SelectionBox::SetLabel ( const char * strLabel )

Specifies the descriptive text string to display below the scrolled list and above the text field.

It describes the dialog item's usage.
Created in NX5.0.0.

License requirements : None

Parameters

strLabel Label string

void NXOpen::UIStyler::SelectionBox::SetListItems ( std::vector< NXString > & values )

Specifies an array of character strings for item names that are used as selectable choices for this dialog item.

Created in NX5.0.0.

License requirements : None

Parameters

values List of items

void NXOpen::UIStyler::SelectionBox::SetSensitivity ( bool type )

Sets the sensitivity of the selection box
Created in NX5.0.0.

License requirements : None

Parameters

type type

void NXOpen::UIStyler::SelectionBox::SetValue ( int value )

Sets the value
Created in NX5.0.0.

License requirements : None

Parameters

value value

void NXOpen::UIStyler::SelectionBox::SetVisibility ( bool type )

Sets the visibility of the selection box
Created in NX5.0.0.

License requirements : None

Parameters

type type

void NXOpen::UIStyler::SelectionBox::ShowSubItem ( int subItemIndex )

Requests that a list entry be scrolled up to the first line in the list.

Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex subitemindex

bool NXOpen::UIStyler::SelectionBox::Visibility ( )

Returns the visibility of the selection box
Created in NX5.0.0.

License requirements : None

The documentation for this class was generated from the following file:

UIStyler_SelectionBox.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation