Referência ao ficheiro src/vapiOperation.h

#include "vapiTypes.h"
#include "vapiImages.h"
#include "vapiOptions.h"
#include "vapiResult.h"
#include <stdarg.h>

Diagrama de dependências de inclusão para vapiOperation.h:

Este grafo mostra quais são os ficheiros que incluem directamente ou indirectamente este ficheiro:

Ir para o código fonte deste ficheiro.

Estruturas de Dados
struct	_vEffect
	The Operations Data Structure. Mais...
struct	_vEffectOptions
	Custom Options used in operations. Mais...
struct	_vEffectSettings
	Defines the operation's specific options. Mais...
Definições de tipos
typedef _vEffect	vEffect
	The Operations Data Structure.
typedef _vEffectOptions	vEffectOptions
	Custom Options used in operations.
typedef _vEffectSettings	vEffectSettings
	Defines the operation's specific options.
typedef void(*)	vOperationFunction (vImages *Images, vOptions *options, vMacroResult *PreviousResult)
	The operation's function.
Funções
vEffect *	vapiOperationInit (const char *name, const char *Group, vOperationFunction func)
	Initiates an Operation.
void	vapiOperationSettingsSetBoolean (vEffect *Operation, const char *name, const char *description, vBoolean defaultValue)
	Adds a boolean option.
void	vapiOperationSettingsSetChar (vEffect *Operation, const char *name, const char *description)
	Adds a character or string option.
void	vapiOperationSettingsSetChoose (vEffect *Operation, const char *name, const char *description, int numberOfChoices, int defaultOption,...)
	Adds a "option list" option.
void	vapiOperationSettingsSetFloat (vEffect *Operation, const char *name, const char *description, double min, double max, double defaultValue, double scale, vInterfaceType interfaceType)
	Adds a float option.
void	vapiOperationSettingsSetHasOriginalOption (vEffect *Operation)
	Set if the operation can ask the user for the use of the original image, or not.
void	vapiOperationSettingsSetInt (vEffect *Operation, const char *name, const char *description, int min, int max, int defaultValue, int scale, vInterfaceType interfaceType)
	Adds an integer option.
void	vapiOperationSettingsSetMacros (vEffect *Operation, int MacrosNumber)
	Sets the use of Macros, so that space can be spared for them.
void	vapiOperationSettingsSetNeedOfAuxImage (vEffect *Operation, int NeedOfAuxImage)
	Sets the need of a Template space.
void	vapiOperationSettingsSetOperationBriefDescription (vEffect *Operation, const char *briefDescription)
	Define the operation's brief Description.
void	vapiOperationSettingsSetOperationLongDescription (vEffect *Operation, const char *longDescription)
	Define the operation's long Description.
void	vapiOperationSettingsSetRepeatInside (vEffect *Operation)
	Sets if the operation handles the repetitions.
void	vapiOperationSettingsSetRunSeveralTimes (vEffect *Operation)
	Sets if the Operation Can run several times (repetitions).

---

Documentação dos tipos

typedef struct _vEffect vEffect

The Operations Data Structure.

typedef struct _vEffectOptions vEffectOptions

Custom Options used in operations.

typedef struct _vEffectSettings vEffectSettings

Defines the operation's specific options.

typedef void(*) vOperationFunction(vImages *Images, vOptions *options, vMacroResult *PreviousResult)

The operation's function.

Parâmetros:

	Images	The images handler
	PreviousResult	the result Handler
	options	the opration's options

Definido na linha 41 do ficheiro vapiOperation.h.

---

Documentação das funções

vEffect* vapiOperationInit	(	const char *	name,
		const char *	Group,
		vOperationFunction	func
	)

Initiates an Operation.

Parâmetros:

	name	name of the Operation
	func	pointer for the operation's function
	Group	Thematic group of the function

Retorna:

a pointer to the operation's data

Definido na linha 13 do ficheiro vapiOperation.c.

Referências _vEffect::briefDescription, _vOptionsSettings::CustomOptionsSettings, _vEffect::func, _vEffect::Group, _vEffectSettings::HasOriginalOption, _vEffect::longDescription, _vEffectSettings::MacrosNumber, _vEffect::name, _vEffectSettings::NeedOfAuxImage, NoNeed, _vEffect::OptionsSettings, _vEffectSettings::repeatInside, _vEffectSettings::runSeveralTimes, vapiOptionsSettingsInit(), vapiReturnStringPointer() e vFALSE.

Referenciado por vapiAvailableEfects(), vapiImageOperations(), vapiIOOperations() e vapiTimerOperations().

{

        vEffect *Operation = malloc (sizeof (vEffect));
        vEffectSettings *CustomOptionsSettings =
                malloc (sizeof (vEffectSettings));
        Operation->OptionsSettings = vapiOptionsSettingsInit ();
        Operation->OptionsSettings->CustomOptionsSettings =
                CustomOptionsSettings;

        Operation->name = vapiReturnStringPointer (name);
        Operation->Group = vapiReturnStringPointer (Group);
        Operation->briefDescription = vapiReturnStringPointer (" ");
        Operation->longDescription = vapiReturnStringPointer (" ");
        Operation->func = func;
        /*
         * Iniciar as definições a zero.
         */
        CustomOptionsSettings->HasOriginalOption = vFALSE;
        CustomOptionsSettings->MacrosNumber = 0;
        CustomOptionsSettings->runSeveralTimes = vFALSE;
        CustomOptionsSettings->NeedOfAuxImage = NoNeed;
        CustomOptionsSettings->repeatInside = vFALSE;

        return Operation;
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetBoolean	(	vEffect *	Operation,
		const char *	name,
		const char *	description,
		vBoolean	defaultValue
	)

Adds a boolean option.

Parâmetros:

	name	Name of the Option, for users to read.
	description	Option's description
	defaultvalue	Option's default value

Definido na linha 64 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vapiOptionsSetBoolean().

Referenciado por vapiAvailableEfects().

{
        vapiOptionsSetBoolean (Operation->OptionsSettings, name,
                               description, defaultValue);

}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetChar	(	vEffect *	Operation,
		const char *	name,
		const char *	description
	)

Adds a character or string option.

Parâmetros:

	name	Name of the Option, for users to read.
	description	Option's description

Definido na linha 87 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vapiOptionsSetChar().

Referenciado por vapiAvailableEfects() e vapiImageOperations().

{
        vapiOptionsSetChar (Operation->OptionsSettings, name, description);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetChoose	(	vEffect *	Operation,
		const char *	name,
		const char *	description,
		int	numberOfChoices,
		int	defaultOption,
			...
	)

Adds a "option list" option.

Parâmetros:

	name	Name of the Option, for users to read.
	description	Option's description
	numberOfChoices	Number of choices in the option list
	defaultOption	The default active option. It's the index of the option's list.
	...	the choices.

Definido na linha 74 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vapiOptionsSetChoose().

Referenciado por vapiAvailableEfects() e vapiImageOperations().

{
        va_list choices;
        va_start (choices, defaultOption);
        vapiOptionsSetChoose (Operation->OptionsSettings,
                              name, description,
                              numberOfChoices, defaultOption, choices);
        va_end (choices);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetFloat	(	vEffect *	Operation,
		const char *	name,
		const char *	description,
		double	min,
		double	max,
		double	defaultValue,
		double	scale,
		vInterfaceType	interfaceType
	)

Adds a float option.

Parâmetros:

	name	Name of the Option, for users to read.
	description	Option's description
	min	Option's Minimum value
	max	Option's Maximum value
	defaultvalue	Option's default value
	scale	Option's scan or increment.
	interfaceType	Type of the interface that user will see to fill this option.

Definido na linha 53 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vapiOptionsSetFloat().

Referenciado por vapiAvailableEfects() e vapiTimerOperations().

{
        vapiOptionsSetFloat (Operation->OptionsSettings, name,
                             description, min,
                             max, defaultValue, scale, interfaceType);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetHasOriginalOption

(

vEffect *

Operation

)

Set if the operation can ask the user for the use of the original image, or not.

Definido na linha 123 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vTRUE.

Referenciado por vapiAvailableEfects() e vapiImageOperations().

{
        ((vEffectSettings *) Operation->OptionsSettings->
         CustomOptionsSettings)->HasOriginalOption = vTRUE;
}

Here is the caller graph for this function:

void vapiOperationSettingsSetInt	(	vEffect *	Operation,
		const char *	name,
		const char *	description,
		int	min,
		int	max,
		int	defaultValue,
		int	scale,
		vInterfaceType	interfaceType
	)

Adds an integer option.

Parâmetros:

	name	Name of the Option, for users to read.
	description	Option's description
	min	Option's Minimum value
	max	Option's Maximum value
	defaultvalue	Option's default value
	scale	Option's scan or increment.
	interfaceType	Type of the interface that user will see to fill this option.

Definido na linha 42 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vapiOptionsSetInt().

Referenciado por vapiAvailableEfects() e vapiIOOperations().

{
        vapiOptionsSetInt (Operation->OptionsSettings, name,
                           description, min, max,
                           defaultValue, scale, interfaceType);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetMacros	(	vEffect *	Operation,
		int	MacrosNumber
	)

Sets the use of Macros, so that space can be spared for them.

Definido na linha 116 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings.

Referenciado por vapiAvailableEfects().

{
        ((vEffectSettings *) Operation->OptionsSettings->
         CustomOptionsSettings)->MacrosNumber = MacrosNumber;
}

Here is the caller graph for this function:

void vapiOperationSettingsSetNeedOfAuxImage	(	vEffect *	Operation,
		int	NeedOfAuxImage
	)

Sets the need of a Template space.

Definido na linha 94 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings.

Referenciado por vapiAvailableEfects().

{
        ((vEffectSettings *) Operation->OptionsSettings->
         CustomOptionsSettings)->NeedOfAuxImage = NeedOfAuxImage;
}

Here is the caller graph for this function:

void vapiOperationSettingsSetOperationBriefDescription	(	vEffect *	Operation,
		const char *	briefDescription
	)

Define the operation's brief Description.

Definido na linha 130 do ficheiro vapiOperation.c.

Referências _vEffect::briefDescription e vapiReturnStringPointer().

Referenciado por vapiAvailableEfects(), vapiImageOperations(), vapiIOOperations() e vapiTimerOperations().

{
        free (Operation->briefDescription);
        Operation->briefDescription =
                vapiReturnStringPointer (briefDescription);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetOperationLongDescription	(	vEffect *	Operation,
		const char *	longDescription
	)

Define the operation's long Description.

Definido na linha 140 do ficheiro vapiOperation.c.

Referências _vEffect::longDescription e vapiReturnStringPointer().

Referenciado por vapiAvailableEfects(), vapiImageOperations() e vapiTimerOperations().

{
        free (Operation->longDescription);
        Operation->longDescription =
                vapiReturnStringPointer (longDescription);
}

Grafo de chamadas desta função:

Here is the caller graph for this function:

void vapiOperationSettingsSetRepeatInside

(

vEffect *

Operation

)

Sets if the operation handles the repetitions.

Definido na linha 102 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vTRUE.

Referenciado por vapiAvailableEfects().

{
        ((vEffectSettings *) Operation->OptionsSettings->
         CustomOptionsSettings)->repeatInside = vTRUE;
}

Here is the caller graph for this function:

void vapiOperationSettingsSetRunSeveralTimes

(

vEffect *

Operation

)

Sets if the Operation Can run several times (repetitions).

Definido na linha 109 do ficheiro vapiOperation.c.

Referências _vEffect::OptionsSettings e vTRUE.

Referenciado por vapiAvailableEfects().

{
        ((vEffectSettings *) Operation->OptionsSettings->
         CustomOptionsSettings)->runSeveralTimes = vTRUE;
}

Here is the caller graph for this function:

---