C-Pluff C API  0.2.0
Data Fields
cp_cfg_element_t Struct Reference

A configuration element contains configuration information for an extension. More...

Collaboration diagram for cp_cfg_element_t:
Collaboration graph
[legend]

Data Fields

char * name
 The name of the configuration element. More...
 
unsigned int num_atts
 Number of attribute name, value pairs in the atts array. More...
 
char ** atts
 An array of pointers to alternating attribute names and values. More...
 
char * value
 An optional value of this configuration element. More...
 
cp_cfg_element_tparent
 A pointer to the parent element or NULL if this is a root element. More...
 
unsigned int index
 The index of this element among its siblings (0-based). More...
 
unsigned int num_children
 Number of children in the children array. More...
 
cp_cfg_element_tchildren
 An array of num_children childrens of this element. More...
 

Detailed Description

A configuration element contains configuration information for an extension.

Utility functions cp_lookup_cfg_element and cp_lookup_cfg_value can be used for traversing the tree of configuration elements. Pointer to the root configuration element is stored at cp_extension_t::configuration and others are contained as children of parent elements.

Field Documentation

◆ name

char* name

The name of the configuration element.

This corresponds to the name of the element in a plug-in descriptor.

◆ num_atts

unsigned int num_atts

Number of attribute name, value pairs in the atts array.

◆ atts

char** atts

An array of pointers to alternating attribute names and values.

Attribute values can be localized.

◆ value

char* value

An optional value of this configuration element.

NULL if not available. The value can be localized. This corresponds to the text contents of the element in a plug-in descriptor.

◆ parent

A pointer to the parent element or NULL if this is a root element.

◆ index

unsigned int index

The index of this element among its siblings (0-based).

◆ num_children

unsigned int num_children

Number of children in the children array.

◆ children

cp_cfg_element_t* children

An array of num_children childrens of this element.

These correspond to child elements in a plug-in descriptor.


The documentation for this struct was generated from the following file:

Generated on Fri May 1 2020 01:06:58 for C-Pluff C API by doxygen 1.8.13