rrp_parameter_api.h File Reference

Plugins API Parameters Header. More...

#include "rrp_exporter.h"
#include "rrp_types.h"

Go to the source code of this file.

Functions
RRParameterHandle	createParameter (const char *label, const char *type, const char *hint, void *value)
	Create a parameter of type "type". More...
bool	freeParameter (RRParameterHandle para)
	Free the memory created by a parameter. More...
bool	addParameterToList (RRParametersHandle handle, RRParameterHandle para)
	Add a parameter to a parameters container, from a parameter pointer. More...
bool	setParameterByString (RRParameterHandle handle, const char *value)
	Set a parameter by a string. More...
bool	getBoolParameter (RRParameterHandle handle, bool *value)
	Get a boolean parameter. More...
bool	setBoolParameter (RRParameterHandle handle, bool value)
	Set a boolean parameter. More...
bool	setIntParameter (RRParameterHandle handle, int value)
	Set an int parameter. More...
bool	getIntParameter (RRParameterHandle handle, int *value)
	Get the value of an int parameter. More...
bool	setDoubleParameter (RRParameterHandle handle, double value)
	Set a double parameter. More...
bool	getDoubleParameter (RRParameterHandle handle, double *value)
	Get the value of a double parameter. More...
bool	setStringParameter (RRParameterHandle handle, char *value)
	Set a string (char*) parameter. More...
bool	getStringParameter (RRParameterHandle handle, const char *(*value))
	Get the value of a string (char*) parameter. More...
bool	setListParameter (RRParameterHandle handle, void *(value))
	Set a listOfParameters (Parameters) parameter. More...
bool	getListParameter (RRParameterHandle handle, void *(value))
	Get the value of a listOfParameters (Parameters) parameter. More...
bool	setRoadRunnerDataParameter (RRParameterHandle handle, void *value)
	Set a roadRunnerDataParameter parameter. More...
bool	getRoadRunnerDataParameter (RRParameterHandle handle, void *value)
	Get the value of a roadRunnerDataParameter parameter. More...
char *	getParameterInfo (RRParameterHandle handle)
	Get a parameters info. More...
char *	getParameterValueAsString (RRParameterHandle handle)
	Get a parameters value as char*. More...
void *	getParameterValueHandle (RRParameterHandle handle)
	Get a handle to a parameters value. More...
char *	getParameterName (RRParameterHandle handle)
	Get a parameters name. More...
char *	getParameterHint (RRParameterHandle handle)
	Get a parameters hint. More...
bool	setParameterHint (RRParameterHandle handle, const char *value)
	Set a parameters hint. More...
char *	getParameterDescription (RRParameterHandle handle)
	Get a parameters description. More...
bool	setParameterDescription (RRParameterHandle handle, const char *value)
	Set a parameters Description. More...
char *	getParameterType (RRParameterHandle handle)
	Get a parameters type. More...
RRParameterHandle	getFirstParameter (RRParametersHandle handle)
RRParameterHandle	getNextParameter (RRParametersHandle handle)
RRParameterHandle	getPreviousParameter (RRParametersHandle handle)
RRParameterHandle	getCurrentParameter (RRParametersHandle handle)
char *	getNamesFromParameterList (RRParametersHandle handle)
	Get a list of names for a plugins parameters. More...
bool	clearParameterList (RRParametersHandle handle)
	Clear a list of parameters. More...

Detailed Description

Plugins API Parameters Header.

Author

Totte Karlsson & Herbert M Sauro

<-----------------------------------------------------------— This file is part of cRoadRunner. See http://code.google.com/p/roadrunnerlib for more details.

Copyright (C) 2012-2013 University of Washington, Seattle, WA, USA

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

In plain english this means:

You CAN freely download and use this software, in whole or in part, for personal, company internal, or commercial purposes;

You CAN use the software in packages or distributions that you create.

You SHOULD include a copy of the license in any redistribution you may make;

You are NOT required include the source of software, or of any modifications you may have made to it, in any redistribution you may assemble that includes it.

YOU CANNOT:

redistribute any piece of this software without proper attribution;