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

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

Inheritance diagram for NXOpen::UIStyler::SelectionBox:
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 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.
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.

Public Member Functions

void AddActivateHandler (const NXOpen::UIStyler::SelectionBox::Activate &activateevent, bool isDialogLaunchingEvent)
 Registers activate callback.
void AddDoubleClickHandler (const NXOpen::UIStyler::SelectionBox::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 DeselectSubItem (int subItemIndex)
 Requests a list entry to be deselected.
std::vector< NXStringGetListItems ()
 Gets an array of character strings for item names that are used as selectable choices for this dialog item.
int GetSelectedIndexValue ()
 Gets selected index value.
NXString GetSelectedString ()
 Gets selected string.
void InsertSubItem (int subitemIndex, std::vector< NXString > &multiEntries)
 Requests that one or more entries be inserted into the list.
bool Sensitivity ()
 Returns the sensitivity of the selection box
Created in NX5.0.0.
void SetFocus ()
 Indicates that this dialog item is receiving keyboard focus.
void SetLabel (const NXString &strLabel)
 Specifies the descriptive text string to display below the scrolled list and above the text field.
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.
void SetSensitivity (bool type)
 Sets the sensitivity of the selection box
Created in NX5.0.0.
void SetValue (int value)
 Sets the value
Created in NX5.0.0.
void SetVisibility (bool type)
 Sets the visibility of the selection box
Created in NX5.0.0.
void ShowSubItem (int subItemIndex)
 Requests that a list entry be scrolled up to the first line in the list.
bool Visibility ()
 Returns the visibility of the selection box
Created in NX5.0.0.

Detailed Description

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



Member Typedef Documentation

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

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:
activateeventActivate event
isDialogLaunchingEventTRUE 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:
doubleclickeventDouble click event
isDialogLaunchingEventTRUE 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:
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:
subItemIndexsubitemindex

Requests a list entry to be deselected.


Created in NX5.0.0.

License requirements : None

Parameters:
subItemIndexsubitemindex

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

Gets selected index value.

Returns:

Created in NX5.0.0.

License requirements : None

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

Returns the sensitivity of the selection box
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

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:
strLabelLabel string
NOTE: The full Unicode character set is not supported for this parameter.
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:
valuesList of items
NOTE: The full Unicode character set is not supported for this parameter.

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



License requirements : None

Parameters:
typetype

Sets the value
Created in NX5.0.0.



License requirements : None

Parameters:
valuevalue

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



License requirements : None

Parameters:
typetype
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:
subItemIndexsubitemindex

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.