ZVBI Library  0.2.33
Data Fields

Information about an export module. More...

Data Fields

char * keyword
char * label
char * tooltip
char * mime_type
char * extension

Detailed Description

Information about an export module.

Although export modules can be accessed by a static keyword (see vbi_export_new()) they are by definition opaque. The client can list export modules for the user and manipulate them without knowing about their availability or purpose. To do so, information about the module is necessary, given in this structure.

You can obtain this information with vbi_export_info_enum().

Examples:
src/exp-templ.c.

Field Documentation

char* vbi_export_info::keyword

Unique (within this library) keyword to identify this export module. Can be stored in configuration files.

Examples:
src/exp-templ.c.
char* vbi_export_info::label

Name of the export module to be shown to the user. Can be NULL indicating the module shall not be listed. Clients are encouraged to localize this with dgettext("zvbi", label).

char* vbi_export_info::tooltip

A brief description (or NULL) for the user. Clients are encouraged to localize this with dgettext("zvbi", tooltip).

char* vbi_export_info::mime_type

Description of the export format as MIME type, for example "text/html". May be NULL.

char* vbi_export_info::extension

Suggested filename extension. Multiple strings are possible, separated by comma. The first string is preferred. Example: "html,htm". May be NULL.