oyFormsArgs_s Struct Reference

a FormsArgs object More...

#include <oyranos_forms.h>

Inheritance diagram for oyFormsArgs_s:

Collaboration diagram for oyFormsArgs_s:

Public Member Functions
OYAPI oyFormsArgs_s *OYEXPORT	oyFormsArgs_New (void *object)
	allocate a new FormsArgs object More...
OYAPI oyFormsArgs_s *OYEXPORT	oyFormsArgs_Copy (oyFormsArgs_s *obj, void *object)
	copy or reference a FormsArgs object More...
OYAPI int OYEXPORT	oyFormsArgs_Release (oyFormsArgs_s **obj)
	release and possibly deallocate a FormsArgs object More...
const char *	oyFormsArgs_ModelGet (oyFormsArgs_s *args)
	obtain a XFORMS model from a FormsArgs object More...
int	oyFormsArgs_ResourceSet (oyFormsArgs_s *args, const char *registration, oyPointer resource)
	set a resource to be used by the renderer More...
int	oyFormsArgs_ResourceGet (oyFormsArgs_s *args, const char *name, oyPointer *resource)
	get a resource to be used inside the renderer More...
Public Member Functions inherited from oyStruct_s
const char *	oyStruct_GetTextFromModule (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	get object infos from a module More...
const char *	oyStruct_GetText (oyStruct_s *obj, oyNAME_e name_type, uint32_t flags)
	Get a text dump. More...
int	oyStruct_RegisterStaticMessageFunc (int type, oyStruct_RegisterStaticMessageFunc_f msg, oyStruct_RegisterStaticFreeFunc_f free_func)
	register a function for verbosity More...
const char *	oyStruct_GetInfo (oyPointer context_object, oyNAME_e type, int flags)
	get a additional string from a object More...
const char *	oyStructTypeToText (oyOBJECT_e type)
	Objects type to small string. More...

Data Fields
int	print
Data Fields inherited from oyStruct_s
const oyOBJECT_e	type_
	Type of object. More...
oyStruct_Copy_f	copy
	Copy function. More...
oyStruct_Release_f	release
	Release function. More...
oyObject_s	oy_
	Oyranos internal object. More...

Detailed Description

a FormsArgs object

Version

Oyranos: 0.1.13

Since

2009/10/12 (Oyranos: 0.1.10)

Date

2010/11/02

Member Function Documentation

oyFormsArgs_Copy()

OYAPI oyFormsArgs_s *OYEXPORT oyFormsArgs_Copy	(	oyFormsArgs_s *	obj,
		void *	object
	)

copy or reference a FormsArgs object

Function oyFormsArgs_Copy

Parameters

[in]	obj	struct object
	object	the optional object

Version

Oyranos: 0.1.10

Since

2009/10/12 (Oyranos: 0.1.10)

Date

2009/10/12

oyFormsArgs_ModelGet()

const char * oyFormsArgs_ModelGet

(

oyFormsArgs_s *

args

)

obtain a XFORMS model from a FormsArgs object

Function oyFormsArgs_ModelGet

Parameters

[in,out]

args

struct object

Returns

the model XML

Version

Oyranos: 0.1.10

Since

2009/10/12 (Oyranos: 0.1.10)

Date

2009/10/12

References oyNAME_NAME, and oyOptions_s::oyOptions_GetText().

oyFormsArgs_New()

OYAPI oyFormsArgs_s *OYEXPORT oyFormsArgs_New

(

void *

object

)

allocate a new FormsArgs object

Function oyFormsArgs_New

Version

Oyranos: 0.1.10

Since

2009/10/12 (Oyranos: 0.1.10)

Date

2009/10/12

References oyOBJECT_FORMS_ARGS_S, and oyObject_NewFrom().

oyFormsArgs_Release()

OYAPI int OYEXPORT oyFormsArgs_Release

(

oyFormsArgs_s **

obj

)

release and possibly deallocate a FormsArgs object

Function oyFormsArgs_Release

Parameters

[in,out]

obj

struct object

Version

Oyranos: 0.1.10

Since

2009/10/12 (Oyranos: 0.1.10)

Date

2009/10/12

oyFormsArgs_ResourceGet()

int oyFormsArgs_ResourceGet	(	oyFormsArgs_s *	args,
		const char *	name,
		oyPointer *	resource
	)

get a resource to be used inside the renderer

Function oyFormsArgs_ResourceGet

Parameters

[in,out]	args	argument object
[in]	registration	a registration key name for the resource
[out]	resource	the resource

Returns

0 - good; 1 - error; -1 <= issue

Version

Oyranos: 0.1.10

Since

2009/11/07 (Oyranos: 0.1.10)

Date

2009/11/07

oyFormsArgs_ResourceSet()

int oyFormsArgs_ResourceSet	(	oyFormsArgs_s *	args,
		const char *	registration,
		oyPointer	resource
	)

set a resource to be used by the renderer

Function oyFormsArgs_ResourceSet

Parameters

[in,out]	args	argument object
[in]	registration	a registration key name for the resource
[in]	resource	the resource

Returns

0 - good; 1 - error; -1 <= issue

Version

Oyranos: 0.1.10

Since

2009/11/07 (Oyranos: 0.1.10)

Date

2009/11/07

Field Documentation

print

int oyFormsArgs_s::print

0 means keep silent,

• 0x01 print options and names
• 0x02 print as well help texts
• 0x04 print all available options, can be rather long A renderer has no obligation to follow iall hints. E.g. flags 0x02 and 0x04 have less meaning for a GUI.