AOResource_t

The addon's resource structure

Synopsis:

typedef struct
{
        char *name;
        char *description;
        void *value;
        void *info;
        int32_t type;
} AOResource_t;

Description:

This structure defines an addon's resources. It contains at least the following members:

char *name

The name of the resource.

char *description

A short description of the resource.

void * parent

The parent control for the resource.

void *value

A pointer to the actual value of the resource.

void *info

A pointer to typing information (such as a range, list of items, etc.).

int32_t type

The resource type flags, which is one of:

• AOR_TYPE_LONG — a long integer; value points to an int32_t, and info points to an array of three int32_t numbers containing minimum, maximum, and increment values.
• AOR_TYPE_LONGLONG — a long long integer; value points to an int64_t, and info points to an array of three int64_t numbers containing minimum, maximum, and increment values.
• AOR_TYPE_FLOAT — a float; value points to a float, and info points to an array of three float numbers containing minimum, maximum, and increment values.
• AOR_TYPE_STRING — a string; value points to an allocated string buffer, and info points to an int32_t that contains the maximum length of the string.
• AOR_TYPE_RADIO — a radio button; value points to an int32_t, and info points to a structure containing an int32_t for the count value, followed by count char* pointers.
• AOR_TYPE_TOGGLE — a toggle button; value points to an int32_t. There is no info pointer requirement.
• AOR_TYPE_POINTER — a pointer; value is the actual pointer.

You can OR the type member with one or more of the following permission values:

• AOR_TYPE_READABLE — readable using resource functions.
• AOR_TYPE_WRITABLE — writable using resource functions.
• AOR_TYPE_ENABLED — enabled.
• AOR_TYPE_VISIBLE — visible.

These values are used when automatically generating a GUI for a DLL's resources, for example.

Classification:

See also:

AOIStream_t, AOMimeInfo_t