CpgAnnotatable

CpgAnnotatable — Interface for annotating objects

Synopsis

struct              CpgAnnotatableInterface;
gchar *             cpg_annotatable_get_title           (CpgAnnotatable *annotatable);
gchar *             cpg_annotatable_get_annotation      (CpgAnnotatable *annotatable);
void                cpg_annotatable_set_annotation      (CpgAnnotatable *annotatable,
                                                         gchar const *annotation);

Description

This interface can be implemented when an object supports annotations.

Details

struct CpgAnnotatableInterface

struct CpgAnnotatableInterface {
	GTypeInterface parent;

	gchar *(*get_title) (CpgAnnotatable *annotatable);

	void (*set_annotation) (CpgAnnotatable *annotatable,
	                        gchar const    *annotation);

	gchar *(*get_annotation) (CpgAnnotatable *annotatable);
};


cpg_annotatable_get_title ()

gchar *             cpg_annotatable_get_title           (CpgAnnotatable *annotatable);

Get the title (display name) of the annotatable object.

annotatable :

A CpgAnnotatable

Returns :

the title. [transfer full]

cpg_annotatable_get_annotation ()

gchar *             cpg_annotatable_get_annotation      (CpgAnnotatable *annotatable);

Get the annotation.

annotatable :

A CpgAnnotatable

Returns :

Get the object annotation. [transfer full]

cpg_annotatable_set_annotation ()

void                cpg_annotatable_set_annotation      (CpgAnnotatable *annotatable,
                                                         gchar const *annotation);

Set the object annotation.

annotatable :

A CpgAnnotatable

annotation :

The annotation