graphic.h File Reference

#include <ilviews/base/iostream.h>
#include <ilviews/util/util.h>
#include <ilviews/base/region.h>
#include <ilviews/base/clssinfo.h>
#include <ilviews/graphics/io.h>
#include <ilviews/intrface/value.h>
#include <ilviews/util/im.h>
#include <ilviews/util/proplist.h>
#include <ilviews/bidi/interf.h>

Classes
class	IlvGradientGraphicBBoxManager
	Graphic class. More...
class	IlvGraphic
	Graphic class. More...
class	IlvSimpleGraphic
	Graphic class. More...
Defines
#define	DeclareGraphicAccessors()
	Declares accessors-related methods for an IlvGraphic subtype.
#define	DeclareIOConstructors(classname)
	Declares persistence-related constructors for an IlvGraphic subtype.
#define	DeclareTypeInfo()
	Declares class information related member functions for an IlvGraphic subtype.
#define	DeclareTypeInfoRO()
	Declares class information related member functions for an IlvGraphic subtype that has no write.
#define	IlvPredefinedIOMembers(classname)
	Defines persistence-related member functions.
#define	IlvRegisterClass(classname, superclass)
	Registers a new IlvGraphic subclass.
Typedefs
typedef void(*	IlvApplyObject )(IlvGraphic *graphic, IlAny userArg)
typedef IlvApplyObject	IlvGraphicCallback

---

Detailed Description

[library views ilviews/base/graphic.h] Declaration of the IlvGraphic and IlvSimpleGraphic classes.

---

Define Documentation

 

#define DeclareGraphicAccessors

(

)

Declares accessors-related methods for an IlvGraphic subtype.

This macro declares the required methods to make any graphic class accessible from a scripting language. This macro is equivalent to the lines:

 virtual IlvValue&  queryValue(IlvValue&) const;
 virtual IlBoolean  applyValue(const IlvValue&);
 static void GetAccessors(const IlSymbol* const**,
                const IlvValueTypeClass* const**,
                IlUInt&)

See also:

DeclareTypeInfo.

#define DeclareIOConstructors

(

classname

)

Declares persistence-related constructors for an IlvGraphic subtype.

This macro declares two constructors in a class declaration for any graphic class. These constructors make it easier to create subclasses of IlvGraphic.

className is the name of the graphic class.

This macro is equivalent to the lines:

 className(const className& source);
 className(IlvInputFile& inputFile,
           IlvPalette*   palette = 0);

See also:

DeclareTypeInfo.

 

#define DeclareTypeInfo

(

)

Declares class information related member functions for an IlvGraphic subtype.

This macro is similar to the DeclareTypeInfoRO macro, except that it adds the declaration of the member function write :

 virtual void write(IlvOutputFile& outputFile) const;

See also:

DeclareTypeInfoRO.

 

#define DeclareTypeInfoRO

(

)

Declares class information related member functions for an IlvGraphic subtype that has no write.

See also:

DeclareTypeInfo.

#define IlvPredefinedIOMembers

(

classname

)

Defines persistence-related member functions.

This macro to define the member functions copy and read of a subclass of IlvGraphic.

className is the name of the graphic class.

This macro must be used in the implementation file, outside any function definition block, just like IlvRegisterClass.

It is equivalent to:

 IlvGraphic*
 className::read(IlvInputFile& input, IlvPalette* palette)
 {
     return new className(input, palette);
 }

 IlvGraphic*
 className::copy() const
 {
     return new className(*this);
 }

See also:

DeclareIOConstructors.

#define IlvRegisterClass	(	classname,
		superclass		)

Registers a new IlvGraphic subclass.

When you define a subtype of IlvGraphic, if you want to be able to save and restore instances of this class you must redefine the read and write functions of IlvGraphic and register the new class by means of this macro.

This macro must be used in the implementation file, outside any function definition block.

Warning:

[note] This macro is an initialization macro and should be called only once for each new subtype of the graphic class.

The arguments are C++ identifiers specifying a C++ class and its superclass. For example, the line IlvRegisterClass(IlvSimpleGraphic, IlvGraphic); registers the fact that the IlvSimpleGraphic class is a subclass of the IlvGraphic class.

---

Typedef Documentation

IlvApplyObject

This type defines the signatures of functions that are called by member functions that can apply transformations to graphic objects.

Parameters:

	graphic	The graphic object that the function applies to.
	userArg	The user parameter that was provided to the member function that calls this function.

See also:

IlvGraphic::apply, IlvContainer::applyToObject, IlvContainer::applyToObjects, IlvContainer::applyToTaggedObjects, IlvManager::applyToObject, IlvManager::applyToObjects, IlvManager::applyToTaggedObjects, IlvManager::applyToSelections.

IlvGraphicCallback

A synonym for IlvApplyObject.
This type defines the signature of all callbacks that apply to graphic objects.