document

document

Synopsis

#define             GEBR_GEOXML_DOCUMENT                (x)
#define             GEBR_GEOXML_DOC                     (x)
typedef             GebrGeoXmlDocument;
enum                GebrGeoXmlDocumentType;
void                (*GebrGeoXmlDiscardMenuRefCallback) (GebrGeoXmlProgram *program,
                                                         const gchar *menu,
                                                         gint index);
int                 gebr_geoxml_document_load           (GebrGeoXmlDocument **document,
                                                         const gchar *path,
                                                         gboolean validate,
                                                         GebrGeoXmlDiscardMenuRefCallback discard_menu_ref);
int                 gebr_geoxml_document_load_buffer    (GebrGeoXmlDocument **document,
                                                         const gchar *xml);
void                gebr_geoxml_document_free           (GebrGeoXmlDocument *document);
GebrGeoXmlDocument * gebr_geoxml_document_clone         (GebrGeoXmlDocument *source);
GebrGeoXmlDocumentType  gebr_geoxml_document_get_type   (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_version    (GebrGeoXmlDocument *document);
int                 gebr_geoxml_document_validate       (const gchar *filename);
int                 gebr_geoxml_document_save           (GebrGeoXmlDocument *document,
                                                         const gchar *path);
int                 gebr_geoxml_document_to_string      (GebrGeoXmlDocument *document,
                                                         gchar **xml_string);
void                gebr_geoxml_document_set_filename   (GebrGeoXmlDocument *document,
                                                         const gchar *filename);
void                gebr_geoxml_document_set_title      (GebrGeoXmlDocument *document,
                                                         const gchar *title);
void                gebr_geoxml_document_set_author     (GebrGeoXmlDocument *document,
                                                         const gchar *author);
void                gebr_geoxml_document_set_email      (GebrGeoXmlDocument *document,
                                                         const gchar *email);
GebrGeoXmlParameters * gebr_geoxml_document_get_dict_parameters
                                                        (GebrGeoXmlDocument *document);
void                gebr_geoxml_document_set_date_created
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *created);
void                gebr_geoxml_document_set_date_modified
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *created);
void                gebr_geoxml_document_set_description
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *description);
void                gebr_geoxml_document_set_help       (GebrGeoXmlDocument *document,
                                                         const gchar *help);
const gchar *       gebr_geoxml_document_get_filename   (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_title      (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_author     (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_email      (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_date_created
                                                        (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_date_modified
                                                        (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_description
                                                        (GebrGeoXmlDocument *document);
gchar *             gebr_geoxml_document_get_help       (GebrGeoXmlDocument *document);

Description

Details

GEBR_GEOXML_DOCUMENT()

#define GEBR_GEOXML_DOCUMENT(x) ((GebrGeoXmlDocument*)(x))

GEBR_GEOXML_DOC()

#define GEBR_GEOXML_DOC(x) GEBR_GEOXML_DOCUMENT(x)

GebrGeoXmlDocument

typedef struct gebr_geoxml_document GebrGeoXmlDocument;

enum GebrGeoXmlDocumentType

typedef enum {
	GEBR_GEOXML_DOCUMENT_TYPE_FLOW = 0,
	GEBR_GEOXML_DOCUMENT_TYPE_LINE,
	GEBR_GEOXML_DOCUMENT_TYPE_PROJECT,
	GEBR_GEOXML_DOCUMENT_TYPE_UNKNOWN
} GebrGeoXmlDocumentType;

GebrGeoXmlDiscardMenuRefCallback ()

void                (*GebrGeoXmlDiscardMenuRefCallback) (GebrGeoXmlProgram *program,
                                                         const gchar *menu,
                                                         gint index);

gebr_geoxml_document_load ()

int                 gebr_geoxml_document_load           (GebrGeoXmlDocument **document,
                                                         const gchar *path,
                                                         gboolean validate,
                                                         GebrGeoXmlDiscardMenuRefCallback discard_menu_ref);

gebr_geoxml_document_load_buffer ()

int                 gebr_geoxml_document_load_buffer    (GebrGeoXmlDocument **document,
                                                         const gchar *xml);

gebr_geoxml_document_free ()

void                gebr_geoxml_document_free           (GebrGeoXmlDocument *document);

gebr_geoxml_document_clone ()

GebrGeoXmlDocument * gebr_geoxml_document_clone         (GebrGeoXmlDocument *source);

gebr_geoxml_document_get_type ()

GebrGeoXmlDocumentType  gebr_geoxml_document_get_type   (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_version ()

gchar *             gebr_geoxml_document_get_version    (GebrGeoXmlDocument *document);

gebr_geoxml_document_validate ()

int                 gebr_geoxml_document_validate       (const gchar *filename);

gebr_geoxml_document_save ()

int                 gebr_geoxml_document_save           (GebrGeoXmlDocument *document,
                                                         const gchar *path);

gebr_geoxml_document_to_string ()

int                 gebr_geoxml_document_to_string      (GebrGeoXmlDocument *document,
                                                         gchar **xml_string);

gebr_geoxml_document_set_filename ()

void                gebr_geoxml_document_set_filename   (GebrGeoXmlDocument *document,
                                                         const gchar *filename);

gebr_geoxml_document_set_title ()

void                gebr_geoxml_document_set_title      (GebrGeoXmlDocument *document,
                                                         const gchar *title);

gebr_geoxml_document_set_author ()

void                gebr_geoxml_document_set_author     (GebrGeoXmlDocument *document,
                                                         const gchar *author);

gebr_geoxml_document_set_email ()

void                gebr_geoxml_document_set_email      (GebrGeoXmlDocument *document,
                                                         const gchar *email);

gebr_geoxml_document_get_dict_parameters ()

GebrGeoXmlParameters * gebr_geoxml_document_get_dict_parameters
                                                        (GebrGeoXmlDocument *document);

Retrieves from document the parameters dictionary for use with program's parameters.

If \p document is NULL returns NULL.

document :

a GebrGeoXmlDocument

gebr_geoxml_document_set_date_created ()

void                gebr_geoxml_document_set_date_created
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *created);

gebr_geoxml_document_set_date_modified ()

void                gebr_geoxml_document_set_date_modified
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *created);

gebr_geoxml_document_set_description ()

void                gebr_geoxml_document_set_description
                                                        (GebrGeoXmlDocument *document,
                                                         const gchar *description);

gebr_geoxml_document_set_help ()

void                gebr_geoxml_document_set_help       (GebrGeoXmlDocument *document,
                                                         const gchar *help);

gebr_geoxml_document_get_filename ()

const gchar *       gebr_geoxml_document_get_filename   (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_title ()

gchar *             gebr_geoxml_document_get_title      (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_author ()

gchar *             gebr_geoxml_document_get_author     (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_email ()

gchar *             gebr_geoxml_document_get_email      (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_date_created ()

gchar *             gebr_geoxml_document_get_date_created
                                                        (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_date_modified ()

gchar *             gebr_geoxml_document_get_date_modified
                                                        (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_description ()

gchar *             gebr_geoxml_document_get_description
                                                        (GebrGeoXmlDocument *document);

gebr_geoxml_document_get_help ()

gchar *             gebr_geoxml_document_get_help       (GebrGeoXmlDocument *document);