#include <object_constructor.h>

Inheritance diagram for MacroConstructor:

Public Member Functions
	MacroConstructor (const std::vector< ObjectCalcer * > &input, const std::vector< ObjectCalcer * > &output, const QString &name, const QString &description, const QByteArray &iconfile=0)

	MacroConstructor (const ObjectHierarchy &hier, const QString &name, const QString &desc, const QByteArray &iconfile=0)

	~MacroConstructor ()

const QString	description () const

const QString	descriptiveName () const

void	handleArgs (const std::vector< ObjectCalcer * > &os, KigPart &d, KigWidget &v) const

void	handlePrelim (KigPainter &p, const std::vector< ObjectCalcer * > &sel, const KigDocument &d, const KigWidget &v) const

const ObjectHierarchy &	hierarchy () const

const QByteArray	iconFileName (const bool canBeNull=false) const

bool	isAlreadySelectedOK (const std::vector< ObjectCalcer * > &os, const uint &) const

bool	isTransform () const

void	plug (KigPart doc, KigGUIAction kact)

QString	selectStatement (const std::vector< ObjectCalcer * > &sel, const KigDocument &d, const KigWidget &w) const

void	setBuiltin (bool builtin)

void	setDescription (const QString &desc)

void	setIcon (QByteArray &icon)

void	setName (const QString &name)

QString	useText (const ObjectCalcer &o, const std::vector< ObjectCalcer * > &sel, const KigDocument &d, const KigWidget &v) const

int	wantArgs (const std::vector< ObjectCalcer * > &os, const KigDocument &d, const KigWidget &v) const

Public Member Functions inherited from ObjectConstructor
virtual	~ObjectConstructor ()

virtual BaseConstructMode *	constructMode (KigPart &doc)

virtual bool	isIntersection () const

virtual bool	isTest () const

Detailed Description

MacroConstructor is a class that represents Kig macro's: these are constructed by the user, and defined by a set of input and a set of output objects.

The macro-constructor saves the way in which the output objects have been built from the input objects, and when given similar input objects, it will produce objects in the given way. The data is saved in a ObjectHierarchy.

Definition at line 336 of file object_constructor.h.

Constructor & Destructor Documentation

MacroConstructor::MacroConstructor	(	const std::vector< ObjectCalcer * > &	input,
		const std::vector< ObjectCalcer * > &	output,
		const QString &	name,
		const QString &	description,
		const QByteArray &	iconfile = `0`
	)

Definition at line 359 of file object_constructor.cc.

MacroConstructor::MacroConstructor	(	const ObjectHierarchy &	hier,
		const QString &	name,
		const QString &	desc,
		const QByteArray &	iconfile = `0`
	)

Definition at line 351 of file object_constructor.cc.

MacroConstructor::~MacroConstructor ( )

Definition at line 370 of file object_constructor.cc.

Member Function Documentation

const QString MacroConstructor::description ( ) const

virtual

Implements ObjectConstructor.

Definition at line 379 of file object_constructor.cc.

const QString MacroConstructor::descriptiveName ( ) const

virtual

Implements ObjectConstructor.

Definition at line 374 of file object_constructor.cc.

void MacroConstructor::handleArgs	(	const std::vector< ObjectCalcer * > &	os,
		KigPart &	d,
		KigWidget &	v
	)		const

virtual

do something fun with os .

. This func is only called if wantArgs returned Complete.. handleArgs should not do any drawing.. after somebody calls this function, he should redrawScreen() himself..

Implements ObjectConstructor.

Definition at line 400 of file object_constructor.cc.

void MacroConstructor::handlePrelim	(	KigPainter &	p,
		const std::vector< ObjectCalcer * > &	sel,
		const KigDocument &	d,
		const KigWidget &	v
	)		const

virtual

show a preliminary version of what you would do when handleArgs would be called.

. E.g. if this constructor normally constructs a locus through some 5 points, then it will try to draw a locus through whatever number of points it gets..

Implements ObjectConstructor.

Definition at line 442 of file object_constructor.cc.

const ObjectHierarchy & MacroConstructor::hierarchy ( ) const

Definition at line 498 of file object_constructor.cc.

const QByteArray MacroConstructor::iconFileName ( const bool canBeNull = false ) const

virtual

Implements ObjectConstructor.

Definition at line 384 of file object_constructor.cc.

bool MacroConstructor::isAlreadySelectedOK	(	const std::vector< ObjectCalcer * > &	os,
		const uint &
	)		const

virtual

the following function is called in case of duplication of arguments and returns true if this is acceptable; this will return false for typical objects

Implements ObjectConstructor.

Definition at line 389 of file object_constructor.cc.

bool MacroConstructor::isTransform ( ) const

virtual

is this the ctor for a transformation type.

We want to know this cause transform types are shown separately in an object's RMB menu..

Implements ObjectConstructor.

Definition at line 521 of file object_constructor.cc.

void MacroConstructor::plug	(	KigPart *	doc,
		KigGUIAction *	kact
	)

virtual

Implements ObjectConstructor.

Definition at line 475 of file object_constructor.cc.

QString MacroConstructor::selectStatement	(	const std::vector< ObjectCalcer * > &	sel,
		const KigDocument &	d,
		const KigWidget &	w
	)		const

virtual

return a string describing what argument you want next, if the given selection of objects were selected.

Implements ObjectConstructor.

Definition at line 416 of file object_constructor.cc.

void MacroConstructor::setBuiltin ( bool builtin )

Definition at line 526 of file object_constructor.cc.

void MacroConstructor::setDescription ( const QString & desc )

Definition at line 602 of file object_constructor.cc.

void MacroConstructor::setIcon ( QByteArray & icon )

Definition at line 607 of file object_constructor.cc.

void MacroConstructor::setName ( const QString & name )

Definition at line 597 of file object_constructor.cc.

QString MacroConstructor::useText	(	const ObjectCalcer &	o,
		const std::vector< ObjectCalcer * > &	sel,
		const KigDocument &	d,
		const KigWidget &	v
	)		const

virtual

return a string describing what you would use o for if it were selected...

o should be part of sel .

Implements ObjectConstructor.

Definition at line 429 of file object_constructor.cc.

int MacroConstructor::wantArgs	(	const std::vector< ObjectCalcer * > &	os,
		const KigDocument &	d,
		const KigWidget &	v
	)		const

virtual

can this constructor do something useful with os ? return ArgsParser::Complete, Valid or NotGood

Implements ObjectConstructor.

Definition at line 394 of file object_constructor.cc.

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

kig

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kig

kdeedu API Reference

Search