formZ SDK | 4.0 Call Back Reference | Object Attributes

# fz_attr_flags_enum

Description

These bit encoded flags give basic information about the nature of the attribute. These flags are used in the plugin supplied . For example, if a plugin wants to indicate that its attribute is to be added to all new objects and that it is to be shown in the query attributes dialog, the flags argument of the callback function can be set as follows :

enum fz_attr_flags_enum {

FZ_ATTR_FLAGS_ADD_OBJ_ALWAYS,

FZ_ATTR_FLAGS_SHOW_QUERY,

FZ_ATTR_FLAGS_SHOW_QUERY_ALWAYS,

FZ_ATTR_FLAGS_TEMPORARY };

Members

FZ_ATTR_FLAGS_ADD_OBJ_ALWAYS

The attribute will always be added to a new object. When this is done, the callback function is invoked to set the default parameters.

FZ_ATTR_FLAGS_SHOW_QUERY

A button with the attributes name will be shown in the respective Query Attributes dialog. The button will only be shown, if the entity has an attribute of the given type assigned to it. When pressed, the attribute dialog, which is set up by the callback function, will be invoked.

FZ_ATTR_FLAGS_SHOW_QUERY_ALWAYS

A button with the attributes name will be shown in the respective Query Attributes dialog. The button will always be shown, regardless of whether the attribute is assigned to the entity or not. When pressed, the attribute dialog, which is set up by the callback function, will be invoked. If the attribute does not exist with the entity, formZ will automatically create the attribute. This will invoke the callback function.

FZ_ATTR_FLAGS_TEMPORARY

The attribute will only exist during the runtime session of formZ. The attribute content will not be read to or written from file. When combined with the FZ_ATTR_FLAGS_SHOW_QUERY and FZ_ATTR_FLAGS_SHOW_QUERY_ALWAYS not set, it allows a plugin to create an attribute which is invisible to the user.

Availability

5.0.0.0

Plugin Example

FZ_SETBIT(*flags,ATTR_FLAGS_ADD_ALWAYS); FZ_SETBIT(*flags,FZ_ATTR_FLAGS_SHOW_QUERY);

Defined in

fz_objt_attr_api.h