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

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

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

List of all members.

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 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< NXStringGetListItems ()
 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.

Detailed Description

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



Member Typedef Documentation

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

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

Requests a list entry to be deleted.


Created in NX5.0.0.

License requirements : None

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

Requests a list entry to be deselected.


Created in NX5.0.0.

License requirements : None

Parameters:
subItemIndexsubitemindex

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

Gets selected index.

Returns:

Created in NX5.0.0.

License requirements : None

Gets selected string.

Returns:

Created in NX5.0.0.

License requirements : None

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:
subitemIndexPosition 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.
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.

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



License requirements : None

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:
itemValAn array of string items
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:
subIndexInndex of particular list items to be selected

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



License requirements : None

Parameters:
typetype

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



License requirements : None

Parameters:
typetype

Requests that a list entry 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 of the single select list
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.