OP_PostItNoteList Class Reference

#include <OP_PostItNoteList.h>

Inheritance diagram for OP_PostItNoteList:

List of all members.

Public Member Functions
	OP_PostItNoteList (OP_Network *net)
virtual	~OP_PostItNoteList ()
void	clearAndDestroy ()
	Remove all network boxes from this list.
OP_PostIt *	createPostItNote (const char *name)
OP_PostIt *	findPostItNote (const char *name) const
	Find and return a given network box by name, or NULL if it's not found.
int	findPostItNoteIndex (const char *name) const
	Find the index of a given network box by name. Returns -1 if not found.
int	findPostItNoteIndex (OP_PostIt *netbox) const
	Find the index of a given network box by ptr. Returns -1 if not found.
bool	deletePostItNote (OP_PostIt *netbox)
bool	deletePostItNote (int index)
bool	load (UT_IStream &is, const char *path, int overwrite=0, OP_PostIt **created=NULL)

---

Detailed Description

Definition at line 34 of file OP_PostItNoteList.h.

---

Constructor & Destructor Documentation

OP_PostItNoteList::OP_PostItNoteList

(

OP_Network *

net

)

virtual OP_PostItNoteList::~OP_PostItNoteList

(

)

[virtual]

---

Member Function Documentation

void OP_PostItNoteList::clearAndDestroy

(

)

Remove all network boxes from this list.

OP_PostIt* OP_PostItNoteList::createPostItNote

(

const char *

name

)

Create a network box with the specified name and insert it into this OP_PostItNoteList at the next available index. Returns a pointer to the OP_PostIt 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_PostItNoteList::deletePostItNote

(

int

index

)

Remove a network box by index. Returns true if it was successfully removed; false if the index is invalid

bool OP_PostItNoteList::deletePostItNote

(

OP_PostIt *

netbox

)

Remove a network box by ptr. Returns true if it was successfully removed; false if the box wasn't found

OP_PostIt* OP_PostItNoteList::findPostItNote

(

const char *

name

)

const

Find and return a given network box by name, or NULL if it's not found.

int OP_PostItNoteList::findPostItNoteIndex

(

OP_PostIt *

netbox

)

const

Find the index of a given network box by ptr. Returns -1 if not found.

int OP_PostItNoteList::findPostItNoteIndex

(

const char *

name

)

const

Find the index of a given network box by name. Returns -1 if not found.

bool OP_PostItNoteList::load	(	UT_IStream &	is,
		const char *	path,
		int	overwrite = 0,
		OP_PostIt **	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.

---

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

• OP/OP_PostItNoteList.h