NX Open C++ Reference Guide
|
Represents a SetList block
Created in NX6.0.0.
More...
Public Types | |
typedef NXOpen::Callback1< int, NXOpen::BlockStyler::SetList * > | AddCallback |
Add callback Created in NX6.0.0. | |
typedef NXOpen::Callback2< int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock * > | DeleteCallback |
Delete callback. | |
enum | InsertionLocation { InsertionLocationBefore, InsertionLocationAfter } |
During Insert, indicates whether component should be inserted before or after the insertion location. More... | |
typedef NXOpen::Callback4< int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock *, int, int > | ReorderCallback |
Reorder callback Created in NX6.0.0. | |
Public Member Functions | |
NXOpen::BlockStyler::UIBlock * | AddNewSet (bool copyPropertiesAndSelect) |
Adds an item to the end of the list. | |
void | Delete (NXOpen::BlockStyler::UIBlock *uicomp) |
Deletes an item from the list Created in NX6.0.0. | |
NXOpen::BlockStyler::UIBlock * | FindUpdated () |
When an update event occurs on the list, this method finds the item in the list that was updated. | |
std::vector < NXOpen::BlockStyler::UIBlock * > | GetItems () |
Gets all the items in the list. | |
std::vector< NXString > | GetItemText (NXOpen::BlockStyler::UIBlock *item) |
Gets the text for the specified item. | |
std::vector < NXOpen::BlockStyler::UIBlock * > | GetSelected () |
Gets the selected items. | |
NXOpen::BlockStyler::UIBlock * | InsertNewSet (NXOpen::BlockStyler::UIBlock *location, NXOpen::BlockStyler::SetList::InsertionLocation insertBeforeOrAfter, bool copyPropertiesAndSelect) |
Inserts an item before or after a specified item. | |
void | SetAddHandler (const NXOpen::BlockStyler::SetList::AddCallback &cb) |
Sets the AddNewSet handler. | |
void | SetDeleteHandler (const NXOpen::BlockStyler::SetList::DeleteCallback &cb) |
Sets the Delete handler. | |
void | SetItemText (NXOpen::BlockStyler::UIBlock *item, std::vector< NXString > &strings) |
Sets the text for the specified item. | |
void | SetReorderObserver (const NXOpen::BlockStyler::SetList::ReorderCallback &cb) |
Sets the Reorder observer. | |
void | SetSeed (const NXString &dlxFile) |
Sets the seed using a dlx file. | |
void | SetSelected (const std::vector< NXOpen::BlockStyler::UIBlock * > &items) |
Sets the selected items. | |
void | Swap (NXOpen::BlockStyler::UIBlock *uicomp1, NXOpen::BlockStyler::UIBlock *uicomp2) |
Swaps the location of two items Created in NX6.0.0. |
Represents a SetList block
Created in NX6.0.0.
typedef NXOpen::Callback1<int, NXOpen::BlockStyler::SetList *> NXOpen::BlockStyler::SetList::AddCallback |
Add callback
Created in NX6.0.0.
License requirements : None
typedef NXOpen::Callback2<int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::DeleteCallback |
Delete callback.
Return a non-zero value in order to veto the deletion.
Created in NX6.0.0.
License requirements : None
typedef NXOpen::Callback4<int, NXOpen::BlockStyler::SetList *, NXOpen::BlockStyler::UIBlock *, int, int> NXOpen::BlockStyler::SetList::ReorderCallback |
Reorder callback
Created in NX6.0.0.
License requirements : None
NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::SetList::AddNewSet | ( | bool | copyPropertiesAndSelect | ) |
Adds an item to the end of the list.
copyPropertiesAndSelect | Indicates whether to copy properties from the currently selected component and set focus to the new set |
void NXOpen::BlockStyler::SetList::Delete | ( | NXOpen::BlockStyler::UIBlock * | uicomp | ) |
Deletes an item from the list
Created in NX6.0.0.
License requirements : None
uicomp | Item to delete |
When an update event occurs on the list, this method finds the item in the list that was updated.
std::vector<NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::GetItems | ( | ) |
Gets all the items in the list.
std::vector<NXString> NXOpen::BlockStyler::SetList::GetItemText | ( | NXOpen::BlockStyler::UIBlock * | item | ) |
Gets the text for the specified item.
If the list has a title column, the title column is not included in the item text.
item | item |
std::vector<NXOpen::BlockStyler::UIBlock *> NXOpen::BlockStyler::SetList::GetSelected | ( | ) |
Gets the selected items.
NXOpen::BlockStyler::UIBlock* NXOpen::BlockStyler::SetList::InsertNewSet | ( | NXOpen::BlockStyler::UIBlock * | location, |
NXOpen::BlockStyler::SetList::InsertionLocation | insertBeforeOrAfter, | ||
bool | copyPropertiesAndSelect | ||
) |
Inserts an item before or after a specified item.
location | Location to insert the new item |
insertBeforeOrAfter | Indicates whether to insert the new item before or after the specified location |
copyPropertiesAndSelect | Indicates whether to copy properties from the currently selected component and set focus to the new set |
void NXOpen::BlockStyler::SetList::SetAddHandler | ( | const NXOpen::BlockStyler::SetList::AddCallback & | cb | ) |
Sets the AddNewSet handler.
If you set this handler, the handler will be called when the Add New Set button is pressed, and the handler will be 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
cb | cb |
void NXOpen::BlockStyler::SetList::SetDeleteHandler | ( | const NXOpen::BlockStyler::SetList::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 item if and only if the handler returns 0.
Created in NX6.0.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::SetList::SetItemText | ( | NXOpen::BlockStyler::UIBlock * | item, |
std::vector< NXString > & | strings | ||
) |
Sets the text for the specified item.
If the list has a title column, the title column is not included in the item text.
Created in NX6.0.0.
License requirements : None
item | item |
strings | The text. The text may only contain characters in the locale character set |
void NXOpen::BlockStyler::SetList::SetReorderObserver | ( | const NXOpen::BlockStyler::SetList::ReorderCallback & | cb | ) |
Sets the Reorder observer.
If you set this observer, the observer will be called after an item is moved by pressing the Move Up and Down buttons. The observer does not need to implement the move up and down behavior and is called after the item has already been moved.
Created in NX6.0.0.
License requirements : None
cb | cb |
void NXOpen::BlockStyler::SetList::SetSeed | ( | const NXString & | dlxFile | ) |
Sets the seed using a dlx file.
The seed must be set during initialization. Setting the seed will also reset any Add and Delete handlers that has been registered, so SetSeed should be called prior to calling SetAddHandler or SetDeleteHandler.
Created in NX6.0.0.
License requirements : None
dlxFile | The dlx file used to create the seed NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::BlockStyler::SetList::SetSelected | ( | const std::vector< NXOpen::BlockStyler::UIBlock * > & | items | ) |
Sets the selected items.
If the "Multiple Edit" property is false, no more than one item can be selected
Created in NX6.0.0.
License requirements : None
items | items |
void NXOpen::BlockStyler::SetList::Swap | ( | NXOpen::BlockStyler::UIBlock * | uicomp1, |
NXOpen::BlockStyler::UIBlock * | uicomp2 | ||
) |
Swaps the location of two items
Created in NX6.0.0.
License requirements : None
uicomp1 | Item to swap |
uicomp2 | Item to swap |