Represents a ListBox block
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::BlockStyler::ListBox:

Public Types
typedef NXOpen::Callback1< int, NXOpen::BlockStyler::ListBox * >	AddCallback
	Add callback Created in NX6.0.0.

typedef NXOpen::Callback1< int, NXOpen::BlockStyler::ListBox * >	DeleteCallback
	Delete callback.

Public Member Functions
bool	AllowDeselectForSingleSelect ()
	Returns the AllowDeselectForSingleSelect.

std::vector< NXString >	GetListItems ()
	Gets the ListItems.

std::vector< int >	GetSelectedItemBooleans ()
	Gets the SelectedItemBooleans.

std::vector< int >	GetSelectedItems ()
	Gets SelectedItems.

std::vector< NXString >	GetSelectedItemStrings ()
	Gets the SelectedItemStrings.

int	Height ()
	Returns the Height Created in NX8.5.0.

bool	IsAddButtonSensitive ()
	Returns the IsAddButtonSensitive Created in NX8.5.0.

bool	IsDeleteButtonSensitive ()
	Returns the IsDeleteButtonSensitive Created in NX8.5.0.

bool	Localize ()
	Returns the Localize.

int	MaximumHeight ()
	Returns the MaximumHeight Created in NX8.5.0.

int	MaximumStringLength ()
	Returns the MaximumStringLength Created in NX8.5.0.

int	MinimumHeight ()
	Returns the MinimumHeight Created in NX8.5.0.

bool	ResizeHeightWithDialog ()
	Returns the ResizeHeightWithDialog Created in NX8.5.0.

int	SelectedItemIndex ()
	Returns the SelectedItemIndex.

NXString	SelectedItemString ()
	Returns the SelectedItemString.

void	SetAddButtonSensitive (bool sensitive)
	Sets the IsAddButtonSensitive Created in NX8.5.0.

void	SetAddHandler (const NXOpen::BlockStyler::ListBox::AddCallback &cb)
	Sets the Add handler.

void	SetAllowDeselectForSingleSelect (bool allow)
	Sets the AllowDeselectForSingleSelect.

void	SetDeleteButtonSensitive (bool sesitive)
	Sets the IsDeleteButtonSensitive Created in NX8.5.0.

void	SetDeleteHandler (const NXOpen::BlockStyler::ListBox::DeleteCallback &cb)
	Sets the Delete handler.

void	SetHeight (int height)
	Sets the Height Created in NX8.5.0.

void	SetListItems (std::vector< NXString > &items)
	Sets the ListItems Created in NX8.5.0.

void	SetLocalize (bool localize)
	Sets the Localize.

void	SetMaximumHeight (int maxHeight)
	Sets the MaximumHeight Created in NX8.5.0.

void	SetMaximumStringLength (int maxLength)
	Sets the MaximumStringLength Created in NX8.5.0.

void	SetMinimumHeight (int minHeight)
	Sets the MinimumHeight Created in NX8.5.0.

void	SetResizeHeightWithDialog (bool resize)
	Sets the ResizeHeightWithDialog Created in NX8.5.0.

void	SetSelectedItemBooleans (const std::vector< int > &items)
	Sets the SelectedItemStrings.

void	SetSelectedItemIndex (int index)
	Sets the SelectedItemIndex.

void	SetSelectedItems (const std::vector< int > &selectedItems)
	Sets SelectedItems Created in NX8.5.0.

void	SetSelectedItemString (const NXString &string)
	Sets the SelectedItemString.

void	SetSelectedItemString (const char *string)
	Sets the SelectedItemString.

void	SetSelectedItemStrings (std::vector< NXString > &strings)
	Sets the SelectedItemStrings.

void	SetShowAddButton (bool show)
	Sets the ShowAddButton.

void	SetShowDeleteButton (bool show)
	Sets the ShowDeleteButton.

void	SetShowMoveUpDownButtons (bool show)
	Sets the ShowMoveUpDownButtons.

void	SetSingleSelect (bool sinleSelect)
	Sets the SingleSelect.

bool	ShowAddButton ()
	Returns the ShowAddButton.

bool	ShowDeleteButton ()
	Returns the ShowDeleteButton.

bool	ShowMoveUpDownButtons ()
	Returns the ShowMoveUpDownButtons.

bool	SingleSelect ()
	Returns the SingleSelect.

Public Member Functions inherited from NXOpen::BlockStyler::UIBlock
bool	Enable ()
	Returns the Enable.

bool	Expanded ()
	Returns the Expanded Created in NX8.5.0.

void	Focus ()
	Focuses on the block.

NXOpen::BlockStyler::PropertyList *	GetProperties ()
	Returns the properties of the block.

bool	Group ()
	Returns the Group Created in NX8.5.0.

NXString	Label ()
	Returns the Label Created in NX8.5.0.

NXString	Name ()
	Returns the name of the block or BlockID Created in NX6.0.0.

void	SetEnable (bool enable)
	Sets the Enable.

void	SetExpanded (bool expanded)
	Sets the Expanded Created in NX8.5.0.

void	SetGroup (bool group)
	Sets the Group Created in NX8.5.0.

void	SetLabel (const NXString &label)
	Sets the Label Created in NX8.5.0.

void	SetLabel (const char *label)
	Sets the Label Created in NX8.5.0.

void	SetShow (bool show)
	Sets the Visibility of block.

bool	Show ()
	Returns the Visibility of block.

NXString	Type ()
	Returns the type of block Created in NX6.0.0.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a ListBox block
Created in NX6.0.0.

Member Typedef Documentation

typedef NXOpen::Callback1<int, NXOpen::BlockStyler::ListBox *> NXOpen::BlockStyler::ListBox::AddCallback

       Add callback

Created in NX6.0.0.

License requirements : None

typedef NXOpen::Callback1<int, NXOpen::BlockStyler::ListBox *> NXOpen::BlockStyler::ListBox::DeleteCallback

Delete callback.

Return a non-zero value in order to veto the deletion.
Created in NX6.0.0.

License requirements : None

Member Function Documentation

bool NXOpen::BlockStyler::ListBox::AllowDeselectForSingleSelect ( )

Returns the AllowDeselectForSingleSelect.

Allows deselection of item using Ctrl+MB1 when single select is true.
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::ListBox::GetListItems ( )

Gets the ListItems.

Returns: Created in NX8.5.0.

License requirements : None

std::vector<int> NXOpen::BlockStyler::ListBox::GetSelectedItemBooleans ( )

Gets the SelectedItemBooleans.

This method returns an integer array of boolen values populated with 0 and 1

Returns: Created in NX8.5.0.

License requirements : None

std::vector<int> NXOpen::BlockStyler::ListBox::GetSelectedItems ( )

Gets SelectedItems.

Returns: selected items
Created in NX8.5.0.

License requirements : None

std::vector<NXString> NXOpen::BlockStyler::ListBox::GetSelectedItemStrings ( )

Gets the SelectedItemStrings.

Returns: Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::ListBox::Height ( )

Returns the Height
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::IsAddButtonSensitive ( )

Returns the IsAddButtonSensitive
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::IsDeleteButtonSensitive ( )

Returns the IsDeleteButtonSensitive
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::Localize ( )

Returns the Localize.

If true, translates the Label string into the language of the current locale.
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::ListBox::MaximumHeight ( )

Returns the MaximumHeight
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::ListBox::MaximumStringLength ( )

Returns the MaximumStringLength
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::ListBox::MinimumHeight ( )

Returns the MinimumHeight
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::ResizeHeightWithDialog ( )

Returns the ResizeHeightWithDialog
Created in NX8.5.0.

License requirements : None

int NXOpen::BlockStyler::ListBox::SelectedItemIndex ( )

Returns the SelectedItemIndex.

Valid only if SingleSelect is true. Otherwise -1 is returned.
Created in NX8.5.0.

License requirements : None

NXString NXOpen::BlockStyler::ListBox::SelectedItemString ( )

Returns the SelectedItemString.

Valid only if SingleSelect is true. Otherwise empty string is returned.
Created in NX8.5.0.

License requirements : None

void NXOpen::BlockStyler::ListBox::SetAddButtonSensitive ( bool sensitive )

Sets the IsAddButtonSensitive
Created in NX8.5.0.

License requirements : None

Parameters

sensitive sensitive

void NXOpen::BlockStyler::ListBox::SetAddHandler ( const NXOpen::BlockStyler::ListBox::AddCallback & cb )

Sets the Add handler.

This handler is called when the Add button is pressed. The handler is responsible for adding an item to the list. Nothing will be added to the list unless the handler adds it.
Created in NX6.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::ListBox::SetAllowDeselectForSingleSelect ( bool allow )

Sets the AllowDeselectForSingleSelect.

Allows deselection of item using Ctrl+MB1 when single select is true.
Created in NX8.5.0.

License requirements : None

Parameters

allow allow

void NXOpen::BlockStyler::ListBox::SetDeleteButtonSensitive ( bool sesitive )

Sets the IsDeleteButtonSensitive
Created in NX8.5.0.

License requirements : None

Parameters

sesitive sesitive

void NXOpen::BlockStyler::ListBox::SetDeleteHandler ( const NXOpen::BlockStyler::ListBox::DeleteCallback & cb )

Sets the Delete handler.

If you set this handler, the handler will be called when the Delete button is pressed. The handler does not need to implement code to delete the item. The list will delete the selected items if and only if the handler returns 0.
Created in NX6.0.0.

License requirements : None

Parameters

cb cb

void NXOpen::BlockStyler::ListBox::SetHeight ( int height )

Sets the Height
Created in NX8.5.0.

License requirements : None

Parameters

height height

void NXOpen::BlockStyler::ListBox::SetListItems ( std::vector< NXString > & items )

Sets the ListItems
Created in NX8.5.0.

License requirements : None

Parameters

items items

void NXOpen::BlockStyler::ListBox::SetLocalize ( bool localize )

Sets the Localize.

If true, translates the Label string into the language of the current locale.
Created in NX8.5.0.

License requirements : None

Parameters

localize localize

void NXOpen::BlockStyler::ListBox::SetMaximumHeight ( int maxHeight )

Sets the MaximumHeight
Created in NX8.5.0.

License requirements : None

Parameters

maxHeight max height

void NXOpen::BlockStyler::ListBox::SetMaximumStringLength ( int maxLength )

Sets the MaximumStringLength
Created in NX8.5.0.

License requirements : None

Parameters

maxLength max length

void NXOpen::BlockStyler::ListBox::SetMinimumHeight ( int minHeight )

Sets the MinimumHeight
Created in NX8.5.0.

License requirements : None

Parameters

minHeight min height

void NXOpen::BlockStyler::ListBox::SetResizeHeightWithDialog ( bool resize )

Sets the ResizeHeightWithDialog
Created in NX8.5.0.

License requirements : None

Parameters

resize resize

void NXOpen::BlockStyler::ListBox::SetSelectedItemBooleans ( const std::vector< int > & items )

Sets the SelectedItemStrings.

Selects the list items based on input boolean array. Item is deselcted if value is 0 and selected otherwise.
Created in NX8.5.0.

License requirements : None

Parameters

items items

void NXOpen::BlockStyler::ListBox::SetSelectedItemIndex ( int index )

Sets the SelectedItemIndex.

Valid only if SingleSelect is true. Otherwise -1 is returned.
Created in NX8.5.0.

License requirements : None

Parameters

index index

void NXOpen::BlockStyler::ListBox::SetSelectedItems ( const std::vector< int > & selectedItems )

Sets SelectedItems
Created in NX8.5.0.

License requirements : None

Parameters

selectedItems selected items

void NXOpen::BlockStyler::ListBox::SetSelectedItemString ( const NXString & string )

Sets the SelectedItemString.

Valid only if SingleSelect is true. Otherwise empty string is returned.
Created in NX8.5.0.

License requirements : None

Parameters

string string

void NXOpen::BlockStyler::ListBox::SetSelectedItemString ( const char * string )

Sets the SelectedItemString.

Valid only if SingleSelect is true. Otherwise empty string is returned.
Created in NX8.5.0.

License requirements : None

Parameters

string string

void NXOpen::BlockStyler::ListBox::SetSelectedItemStrings ( std::vector< NXString > & strings )

Sets the SelectedItemStrings.

Selects the list items based on input array of strings.
Created in NX8.5.0.

License requirements : None

Parameters

strings strings

void NXOpen::BlockStyler::ListBox::SetShowAddButton ( bool show )

Sets the ShowAddButton.

If true, Add button is shown.
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::ListBox::SetShowDeleteButton ( bool show )

Sets the ShowDeleteButton.

If true, Delete button is shown.
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::ListBox::SetShowMoveUpDownButtons ( bool show )

Sets the ShowMoveUpDownButtons.

If true, MoveUp and MoveDown buttons are shown.
Created in NX8.5.0.

License requirements : None

Parameters

show show

void NXOpen::BlockStyler::ListBox::SetSingleSelect ( bool sinleSelect )

Sets the SingleSelect.

If true, only single item can be selected.
Created in NX8.5.0.

License requirements : None

Parameters

sinleSelect sinle select

bool NXOpen::BlockStyler::ListBox::ShowAddButton ( )

Returns the ShowAddButton.

If true, Add button is shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::ShowDeleteButton ( )

Returns the ShowDeleteButton.

If true, Delete button is shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::ShowMoveUpDownButtons ( )

Returns the ShowMoveUpDownButtons.

If true, MoveUp and MoveDown buttons are shown.
Created in NX8.5.0.

License requirements : None

bool NXOpen::BlockStyler::ListBox::SingleSelect ( )

Returns the SingleSelect.

If true, only single item can be selected.
Created in NX8.5.0.

License requirements : None

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

BlockStyler_ListBox.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Function Documentation