OP_NetworkBoxList Class Reference
#include <OP_NetworkBoxList.h>
Public Member Functions | |
| OP_NetworkBoxList (OP_Network *net) | |
| virtual | ~OP_NetworkBoxList () |
| void | clearAndDestroy () |
| Remove all network boxes from this list. | |
| OP_NetworkBox * | createNetworkBox (const char *name, UT_PtrArray< OP_NetworkBoxItem * > *items=NULL) |
| OP_NetworkBox * | findNetworkBox (const char *name) const |
| Find and return a given network box by name, or NULL if it's not found. | |
| int | findNetworkBoxIndex (const char *name) const |
| Find the index of a given network box by name. Returns -1 if not found. | |
| int | findNetworkBoxIndex (OP_NetworkBox *netbox) const |
| Find the index of a given network box by ptr. Returns -1 if not found. | |
| bool | deleteNetworkBox (OP_NetworkBox *netbox) |
| bool | deleteNetworkBox (int index) |
| OP_ERROR | save (ostream &os, const OP_SaveFlags &flags, const char *path_prefix) const |
| bool | load (UT_IStream &is, const char *path, int overwrite=0, OP_NetworkBox **created=NULL) |
| int | savePickedToClipboard (ostream &os, const OP_SaveFlags &flags, int all=0) const |
| int | saveListToClipboard (ostream &os, const OP_SaveFlags &flags, const UT_PtrArray< OP_NetworkBox * > &netboxes) const |
| OP_ERROR | saveSingleNetworkBox (ostream &os, OP_NetworkBox &netbox, const OP_SaveFlags &flags, const char *path_prefix) const |
| SYS_DEPRECATED OP_NetworkBox * | loadFromClipboard (UT_IStream &is, const char *path) const |
Detailed Description
Definition at line 34 of file OP_NetworkBoxList.h.
Constructor & Destructor Documentation
| OP_NetworkBoxList::OP_NetworkBoxList | ( | OP_Network * | net | ) |
| virtual OP_NetworkBoxList::~OP_NetworkBoxList | ( | ) | [virtual] |
Member Function Documentation
| void OP_NetworkBoxList::clearAndDestroy | ( | ) |
Remove all network boxes from this list.
| OP_NetworkBox* OP_NetworkBoxList::createNetworkBox | ( | const char * | name, | |
| UT_PtrArray< OP_NetworkBoxItem * > * | items = NULL | |||
| ) |
Create a network box with the specified name and insert it into this OP_NetworkBoxList at the next available index. Returns a pointer to the OP_NetworkBox created or NULL if creation was unsuccessful. Pass in NULL as the name if you'd like a default name. If a duplicate name is passed in, it will be altered to make it unique. Passing in 'items' will automatically create a network box containing those items with the netbox positioned properly around them.
| bool OP_NetworkBoxList::deleteNetworkBox | ( | int | index | ) |
Remove a network box by index. Returns true if it was successfully removed; false if the index is invalid
| bool OP_NetworkBoxList::deleteNetworkBox | ( | OP_NetworkBox * | netbox | ) |
Remove a network box by ptr. Returns true if it was successfully removed; false if the box wasn't found
| OP_NetworkBox* OP_NetworkBoxList::findNetworkBox | ( | const char * | name | ) | const |
Find and return a given network box by name, or NULL if it's not found.
| int OP_NetworkBoxList::findNetworkBoxIndex | ( | OP_NetworkBox * | netbox | ) | const |
Find the index of a given network box by ptr. Returns -1 if not found.
| int OP_NetworkBoxList::findNetworkBoxIndex | ( | const char * | name | ) | const |
Find the index of a given network box by name. Returns -1 if not found.
| bool OP_NetworkBoxList::load | ( | UT_IStream & | is, | |
| const char * | path, | |||
| int | overwrite = 0, |
|||
| OP_NetworkBox ** | created = NULL | |||
| ) |
Load a network box from 'is'. Can load from both .hip files and the clipboard. 'path' is used as the new netbox's name (only the portion of path after the last slash). If 'overwrite' is specified, the new netbox will overwrite any other netboxes in this network with the same name, rather than modify its name to be unique. 'created' is used to return a ptr to the new network box.
| SYS_DEPRECATED OP_NetworkBox* OP_NetworkBoxList::loadFromClipboard | ( | UT_IStream & | is, | |
| const char * | path | |||
| ) | const |
DEPRECATED: Do not use this. It only exists to allow backwards- compatibility loading support for saves done with the old save mechanism (OP_NETWORKBOX_LIST_VERSION of 1) during the brief time during which it was available. Use 'load()' instead.
Loads a single netbox from the clipboard.
| OP_ERROR OP_NetworkBoxList::save | ( | ostream & | os, | |
| const OP_SaveFlags & | flags, | |||
| const char * | path_prefix | |||
| ) | const |
Save the entire list to the ostream os. 'path_prefix' should be the path you want to save the netboxes as being under.
| int OP_NetworkBoxList::saveListToClipboard | ( | ostream & | os, | |
| const OP_SaveFlags & | flags, | |||
| const UT_PtrArray< OP_NetworkBox * > & | netboxes | |||
| ) | const |
Saves all netboxes in the provided list to the clipboard. Returns the total # of items saved.
| int OP_NetworkBoxList::savePickedToClipboard | ( | ostream & | os, | |
| const OP_SaveFlags & | flags, | |||
| int | all = 0 | |||
| ) | const |
Saves all picked netboxes in this list to the clipboard for copy/paste, etc. Returns the total # items saved.
| OP_ERROR OP_NetworkBoxList::saveSingleNetworkBox | ( | ostream & | os, | |
| OP_NetworkBox & | netbox, | |||
| const OP_SaveFlags & | flags, | |||
| const char * | path_prefix | |||
| ) | const |
Save 'netbox' to 'os'. 'path_prefix' should be the path you want to save the netbox as being under.
The documentation for this class was generated from the following file:
