Main Page | Modules | Class List | File List | Class Members | File Members

OfxPropertySuiteV1 Struct Reference

#include <ofxProperty.h>

List of all members.

Detailed Description

The OFX suite used to access properties on OFX objects.


Public Attributes

OfxStatus(* propSetPointer )(OfxPropertySetHandle properties, const char *property, int index, void *value)
 Set a single value in a pointer property.
OfxStatus(* propSetString )(OfxPropertySetHandle properties, const char *property, int index, const char *value)
 Set a single value in a string property.
OfxStatus(* propSetDouble )(OfxPropertySetHandle properties, const char *property, int index, double value)
 Set a single value in a double property.
OfxStatus(* propSetInt )(OfxPropertySetHandle properties, const char *property, int index, int value)
 Set a single value in an int property.
OfxStatus(* propSetPointerN )(OfxPropertySetHandle properties, const char *property, int count, void **value)
 Set multiple values of the pointer property.
OfxStatus(* propSetStringN )(OfxPropertySetHandle properties, const char *property, int count, const char **value)
 Set multiple values of a string property.
OfxStatus(* propSetDoubleN )(OfxPropertySetHandle properties, const char *property, int count, double *value)
 Set multiple values of a double property.
OfxStatus(* propSetIntN )(OfxPropertySetHandle properties, const char *property, int count, int *value)
 Set multiple values of an int property.
OfxStatus(* propGetPointer )(OfxPropertySetHandle properties, const char *property, int index, void **value)
 Get a single value from a pointer property.
OfxStatus(* propGetString )(OfxPropertySetHandle properties, const char *property, int index, char **value)
 Get a single value of a string property.
OfxStatus(* propGetDouble )(OfxPropertySetHandle properties, const char *property, int index, double *value)
 Get a single value of a double property.
OfxStatus(* propGetInt )(OfxPropertySetHandle properties, const char *property, int index, int *value)
 Get a single value of an int property.
OfxStatus(* propGetPointerN )(OfxPropertySetHandle properties, const char *property, int count, void **value)
 Get multiple values of a pointer property.
OfxStatus(* propGetStringN )(OfxPropertySetHandle properties, const char *property, int count, char **value)
 Get multiple values of a string property.
OfxStatus(* propGetDoubleN )(OfxPropertySetHandle properties, const char *property, int count, double *value)
 Get multiple values of a double property.
OfxStatus(* propGetIntN )(OfxPropertySetHandle properties, const char *property, int count, int *value)
 Get multiple values of an int property.
OfxStatus(* propReset )(OfxPropertySetHandle properties, const char *property)
 Resets all dimensions of a property to it's default value.
OfxStatus(* propGetDimension )(OfxPropertySetHandle properties, const char *property, int *count)
 Gets the dimension of the property.

Member Data Documentation

OfxStatus(* OfxPropertySuiteV1::propGetDimension)(OfxPropertySetHandle properties, const char *property, int *count)
 

Gets the dimension of the property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property we are resetting
  • count is a pointer to an integer where the value is returned
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetDouble)(OfxPropertySetHandle properties, const char *property, int index, double *value)
 

Get a single value of a double property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index refers to the index of a multi-dimensional property
  • value is a pointer the return location
See the note ArchitectureStrings for how to deal with strings.

Returns:

OfxStatus(* OfxPropertySuiteV1::propGetDoubleN)(OfxPropertySetHandle properties, const char *property, int count, double *value)
 

Get multiple values of a double property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are getting of that property (ie: indicies 0..count-1)
  • value is a pointer to an array of where we will return the property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetInt)(OfxPropertySetHandle properties, const char *property, int index, int *value)
 

Get a single value of an int property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index refers to the index of a multi-dimensional property
  • value is a pointer the return location
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetIntN)(OfxPropertySetHandle properties, const char *property, int count, int *value)
 

Get multiple values of an int property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are getting of that property (ie: indicies 0..count-1)
  • value is a pointer to an array of where we will return the property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetPointer)(OfxPropertySetHandle properties, const char *property, int index, void **value)
 

Get a single value from a pointer property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index refers to the index of a multi-dimensional property
  • value is a pointer the return location
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetPointerN)(OfxPropertySetHandle properties, const char *property, int count, void **value)
 

Get multiple values of a pointer property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are getting of that property (ie: indicies 0..count-1)
  • value is a pointer to an array of where we will return the property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetString)(OfxPropertySetHandle properties, const char *property, int index, char **value)
 

Get a single value of a string property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index refers to the index of a multi-dimensional property
  • value is a pointer the return location
Returns:

OfxStatus(* OfxPropertySuiteV1::propGetStringN)(OfxPropertySetHandle properties, const char *property, int count, char **value)
 

Get multiple values of a string property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are getting of that property (ie: indicies 0..count-1)
  • value is a pointer to an array of where we will return the property values
See the note ArchitectureStrings for how to deal with strings.

Returns:

OfxStatus(* OfxPropertySuiteV1::propReset)(OfxPropertySetHandle properties, const char *property)
 

Resets all dimensions of a property to it's default value.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property we are resetting
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetDouble)(OfxPropertySetHandle properties, const char *property, int index, double value)
 

Set a single value in a double property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index is for multidimenstional properties and is dimension of the one we are setting
  • value is the value of the property we are setting
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetDoubleN)(OfxPropertySetHandle properties, const char *property, int count, double *value)
 

Set multiple values of a double property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are setting in that property (ie: indicies 0..count-1)
  • value is a pointer to an array of property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetInt)(OfxPropertySetHandle properties, const char *property, int index, int value)
 

Set a single value in an int property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index is for multidimenstional properties and is dimension of the one we are setting
  • value is the value of the property we are setting
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetIntN)(OfxPropertySetHandle properties, const char *property, int count, int *value)
 

Set multiple values of an int property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are setting in that property (ie: indicies 0..count-1)
  • value is a pointer to an array of property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetPointer)(OfxPropertySetHandle properties, const char *property, int index, void *value)
 

Set a single value in a pointer property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index is for multidimenstional properties and is dimension of the one we are setting
  • value is the value of the property we are setting
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetPointerN)(OfxPropertySetHandle properties, const char *property, int count, void **value)
 

Set multiple values of the pointer property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are setting in that property (ie: indicies 0..count-1)
  • value is a pointer to an array of property values
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetString)(OfxPropertySetHandle properties, const char *property, int index, const char *value)
 

Set a single value in a string property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • index is for multidimenstional properties and is dimension of the one we are setting
  • value is the value of the property we are setting
Returns:

OfxStatus(* OfxPropertySuiteV1::propSetStringN)(OfxPropertySetHandle properties, const char *property, int count, const char **value)
 

Set multiple values of a string property.

  • properties is the handle of the thing holding the property
  • property is the string labelling the property
  • count is the number of values we are setting in that property (ie: indicies 0..count-1)
  • value is a pointer to an array of property values
Returns:

The documentation for this struct was generated from the following file:
Copyright 2003-2004 The Foundry Visonmongers Ltd. All rights reserved.
Copying and redistribution with or without modification, is permitted provided that the following conditions are met:
  1. Redistributions of the document must retain the above copyright notice and this list of conditions.
  2. Neither the name of The Foundry Visonmongers Ltd nor names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Automatic documentation generated by DOxygen.