NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::UIStyler::MultiSelectList Class Reference

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

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

List of all members.

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 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< NXStringGetAllNameSelected ()
 Gets the names of all selected list entries.
std::vector< NXStringGetListItems ()
 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.

Detailed Description

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



Member Typedef Documentation


Created in NX5.0.0.



License requirements : None

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:
activateeventactivateevent
isDialogLaunchingEventis 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:
doubleclickeventdoubleclickevent
isDialogLaunchingEventis 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:
multiEntriesAn 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.

Deletes sub item
Created in NX5.0.0.



License requirements : None

Parameters:
subItemIndexZero-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:
subItemIndexIndex of the list entry to be deselected.

Indicates that this dialog item is receiving keyboard focus.


Created in NX5.0.0.

License requirements : None

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

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

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:
subitemIndexSub item index
multiEntriesAn array of items to be inserted
NOTE: The full Unicode character set is not supported for this parameter.

Returns the senstivity
Created in NX5.0.0.



License requirements : None

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:
itemValarray of character strings for item names
NOTE: The full Unicode character set is not supported for this parameter.

Specifies particular list items to be selected.


Created in NX5.0.0.

License requirements : None

Parameters:
subIndexAn index of particular list items to be selected

Sets the senstivity
Created in NX5.0.0.



License requirements : None

Parameters:
typetype

Sets the visibility
Created in NX5.0.0.



License requirements : None

Parameters:
typetype

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



License requirements : None

Parameters:
subItemIndexZero-based index of a list entry to be scrolled up to the first line of the list.

Returns the visibility
Created in NX5.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.