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

Inheritance diagram for NXOpen::UIStyler::MultiSelectList:

Public Types
typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	Activate
	Created in NX5.0.0.

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	DoubleClick
	Called when a dialog user selects an entry with a single mouse click or presses the spacebar on a selected item.

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::MultiSelectList::Activate &activateevent, bool isDialogLaunchingEvent)
	Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item.

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

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

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

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

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

std::vector< int >	GetAllIndicesSelected ()
	Gets the indices of all selected list entries.

std::vector< NXString >	GetAllNameSelected ()
	Gets the names of all selected list entries.

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

void	InsertSubitems (int subitemIndex, std::vector< NXString > &multiEntries)
	Created in NX5.0.0.

bool	Sensitivity ()
	Returns the senstivity Created in NX5.0.0.

void	SetAllSelected ()
	Specifies all list entry to be selected.

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

void	SetSelected (int subIndex)
	Specifies particular list items to be selected.

void	SetSensitivity (bool type)
	Sets the senstivity Created in NX5.0.0.

void	SetVisibility (bool type)
	Sets the visibility Created in NX5.0.0.

void	ShowSubItem (int subItemIndex)
	Requests a list entry to be scrolled up to the first line in the list Created in NX5.0.0.

bool	Visibility ()
	Returns the visibility Created in NX5.0.0.

Public Member Functions inherited from NXOpen::UIStyler::StylerItem
NXOpen::UIStyler::StylerItem::ItemType	GetItemType ()
	Gets the dialog item type.

NXOpen::UIStyler::Attachment *	InitializeAttachment ()
	Returns initialized dialog item attachment information.

bool	IsEqualTo (NXOpen::UIStyler::StylerItem *itemToCompare)
	Equates two styler items.

void	SetAttachment (NXOpen::UIStyler::Attachment *attachment)
	Specifies the updated dialog item attachment information Created in NX5.0.0.

virtual	~StylerItem ()
	Free resources associated with the instance.

Public Member Functions inherited from NXOpen::TransientObject
void *	GetHandle ()
	Handle of the internal object represented by this object.

Detailed Description

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

Member Typedef Documentation

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

Created in NX5.0.0.

License requirements : None

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

   Called when a dialog user selects an entry with a single mouse click or presses the spacebar

on a selected item.

Created in NX5.0.0.

License requirements : None

Member Function Documentation

void NXOpen::UIStyler::MultiSelectList::AddActivateHandler	(	const NXOpen::UIStyler::MultiSelectList::Activate &	activateevent,
		bool	isDialogLaunchingEvent
	)

Called when a dialog user selects an entry with a double mouse click or presses Return on a selected item.

Created in NX5.0.0.

License requirements : None

Parameters

activateevent	activateevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::MultiSelectList::AddDoubleClickHandler	(	const NXOpen::UIStyler::MultiSelectList::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	doubleclickevent
isDialogLaunchingEvent	is dialog launching event

void NXOpen::UIStyler::MultiSelectList::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.
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::MultiSelectList::DeleteSubitem ( int subItemIndex )

Deletes sub item
Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex Zero-based index of a list entry to be deleted

void NXOpen::UIStyler::MultiSelectList::Deselect ( int subItemIndex )

Requests a list entry to be deselected.

Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex Index of the list entry to be deselected.

void NXOpen::UIStyler::MultiSelectList::Focus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0.

License requirements : None

std::vector<int> NXOpen::UIStyler::MultiSelectList::GetAllIndicesSelected ( )

Gets the indices of all selected list entries.

Returns: An array of integers for item indices of selected items
Created in NX5.0.0.

License requirements : None

std::vector<NXString> NXOpen::UIStyler::MultiSelectList::GetAllNameSelected ( )

Gets the names of all selected list entries.

Returns: An array of character strings of selected items
Created in NX5.0.0.

License requirements : None

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

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

Returns: An array of character strings for item names
Created in NX5.0.0.

License requirements : None

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

Created in NX5.0.0.

License requirements : None

Parameters

subitemIndex	Sub item index
multiEntries	An array of items to be inserted NOTE: The full Unicode character set is not supported for this parameter.

bool NXOpen::UIStyler::MultiSelectList::Sensitivity ( )

Returns the senstivity
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::MultiSelectList::SetAllSelected ( )

Specifies all list entry to be selected.

Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::MultiSelectList::SetListItems ( std::vector< NXString > & itemVal )

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

itemVal array of character strings for item names
NOTE: The full Unicode character set is not supported for this parameter.

void NXOpen::UIStyler::MultiSelectList::SetSelected ( int subIndex )

Specifies particular list items to be selected.

Created in NX5.0.0.

License requirements : None

Parameters

subIndex An index of particular list items to be selected

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

Sets the senstivity
Created in NX5.0.0.

License requirements : None

Parameters

type type

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

Sets the visibility
Created in NX5.0.0.

License requirements : None

Parameters

type type

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

Requests a list entry to be scrolled up to the first line in the list
Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex Zero-based index of a list entry to be scrolled up to the first line of the list.

bool NXOpen::UIStyler::MultiSelectList::Visibility ( )

Returns the visibility
Created in NX5.0.0.

License requirements : None

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

UIStyler_MultiSelectList.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation