proto.h File Reference

#include <ilviews/graphics/io.h>
#include <ilviews/protos/group.h>

Classes
class	IlvAbstractProtoLibrary
	Abstract base class of prototype libraries. More...
class	IlvProtoInstance
	Clone of a prototype. More...
class	IlvProtoLibrary
	Simple prototype library implementation based on file system directories. More...
class	IlvPrototype
	Clonable group. More...
Functions
IlvAbstractProtoLibrary *	IlvGetProtoLibrary (const char *name)
	Returns the prototype library whose name is specified as argument, or 0 if the library does not exist.
IlvPrototype *	IlvLoadPrototype (const char *name, IlvDisplay *display, IlBoolean reload=IlFalse)
	Use this function to load a prototype.

---

Detailed Description

[library ilvproto ilviews/protos/proto.h] Declaration of the IlvPrototype, IlvProtoInstance and IlvProtoLibrary classes.

---

Function Documentation

IlvAbstractProtoLibrary* IlvGetProtoLibrary

(

const char *

name

)

Returns the prototype library whose name is specified as argument, or 0 if the library does not exist.

Parameters:

name

The name of the library to retrieve.

Returns:

The prototype library that matches name, or 0 if there are none.

IlvPrototype* IlvLoadPrototype	(	const char *	name,
		IlvDisplay *	display,
		IlBoolean	reload = IlFalse
	)

Use this function to load a prototype.

Loads a prototype. If name is of the form libname.protoname, the prototype is searched in the library libname. If this library does not exist, the prototype library file libname.ipl is searched. If the file is not found, the file libname/libname.ipl is searched. If the file is found, the prototype library is created and loaded. Then the prototype protoname is searched in this library.

If name is a simple prototype name (without a dot character), the file protoname.ivp is searched in the display path. If the file is found, the prototype is loaded from this file as standalone prototype: it is not added to any prototype library.

If reload is IlFalse and if the prototype is already loaded, the prototype is returned. If reload is IlTrue, the prototype is reloaded even if it already exists. The function returns 0 if the requested prototype could not be loaded.

This function is called automatically when you load a .ilv file containing prototype instances. You need to call this function explicitly only if you want to create and edit prototype instances by code.

See also:

IlvPrototype, IlvProtoLibrary.