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

Inheritance diagram for NXOpen::UIStyler::SingleSelectList:

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

typedef NXOpen::Callback1 < NXOpen::UIStyler::DialogState, NXOpen::UIStyler::StylerEvent * >	DoubleClick
	Called when a dialog user double-clicks on an option or presses Return when an item is already selected.

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::SingleSelectList::Activate &activateevent, bool isDialogLaunchingEvent)
	Registers activate callback.

void	AddDoubleClickHandler (const NXOpen::UIStyler::SingleSelectList::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)
	Requests a list entry to be deleted.

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

std::vector< NXString >	GetListItems ()
	Gets an array of character strings that are used as entries in the list.

int	GetSelectedIndexValue ()
	Gets selected index.

NXString	GetSelectedString ()
	Gets selected string.

bool	HasSelected ()
	Returns whether or not an item has been selected.

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

bool	Sensitivity ()
	Returns the sensitivity of the single select list Created in NX5.0.0.

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

void	SetListItems (std::vector< NXString > &itemVal)
	Specifies an array of character strings that are used as entries in the list Created in NX5.0.0.

void	SetSelected (int subIndex)
	Specifies particular list items to be selected Created in NX5.0.0.

void	SetSensitivity (bool type)
	Sets the sensitivity of the single select list Created in NX5.0.0.

void	SetVisibility (bool type)
	Sets the visibility of the single select list Created in NX5.0.0.

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

bool	Visibility ()
	Returns the visibility of the single select list 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 SingleSelectList for UI Styler
Created in NX5.0.0.

Member Typedef Documentation

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

Called when a dialog user selects an entry with a single mouse click

or presses the spacebar on an already selected item.

Created in NX5.0.0.

License requirements : None

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

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

Created in NX5.0.0.

License requirements : None

Member Function Documentation

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

void NXOpen::UIStyler::SingleSelectList::AddDoubleClickHandler	(	const NXOpen::UIStyler::SingleSelectList::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::SingleSelectList::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::SingleSelectList::DeleteSubItem ( int subItemIndex )

Requests a list entry to be deleted.

Created in NX5.0.0.

License requirements : None

Parameters

subItemIndex Zero-based index of a list entry to be deleted. If subitem_index equals UF_STYLER_NO_SUB_INDEX, then all list entries are deleted.

void NXOpen::UIStyler::SingleSelectList::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::SingleSelectList::GetListItems ( )

Gets an array of character strings that are used as entries in the list.

Returns: An array of string items
Created in NX5.0.0.

License requirements : None

int NXOpen::UIStyler::SingleSelectList::GetSelectedIndexValue ( )

Gets selected index.

Returns: Created in NX5.0.0.

License requirements : None

NXString NXOpen::UIStyler::SingleSelectList::GetSelectedString ( )

Gets selected string.

Returns: Created in NX5.0.0.

License requirements : None

bool NXOpen::UIStyler::SingleSelectList::HasSelected ( )

Returns whether or not an item has been selected.

Returns: Created in NX7.5.1.

License requirements : None

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

Requests one or more entries to 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	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.

bool NXOpen::UIStyler::SingleSelectList::Sensitivity ( )

Returns the sensitivity of the single select list
Created in NX5.0.0.

License requirements : None

void NXOpen::UIStyler::SingleSelectList::SetFocus ( )

Indicates that this dialog item is receiving keyboard focus.

Created in NX5.0.0.

License requirements : None

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

Specifies an array of character strings that are used as entries in the list
Created in NX5.0.0.

License requirements : None

Parameters

itemVal An array of string items
NOTE: The full Unicode character set is not supported for this parameter.

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

Specifies particular list items to be selected
Created in NX5.0.0.

License requirements : None

Parameters

subIndex Inndex of particular list items to be selected

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

Sets the sensitivity of the single select list
Created in NX5.0.0.

License requirements : None

Parameters

type type

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

Sets the visibility of the single select list
Created in NX5.0.0.

License requirements : None

Parameters

type type

void NXOpen::UIStyler::SingleSelectList::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 Zero-based index of a list entry to be scrolled up to the first line of the list.

bool NXOpen::UIStyler::SingleSelectList::Visibility ( )

Returns the visibility of the single select list
Created in NX5.0.0.

License requirements : None

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

UIStyler_SingleSelectList.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation