GNOME.org

GdaGraphviz

GdaGraphviz — Creates .dot files which can then be processed with GraphViz.

Synopsis

                    GdaGraphviz;
                    GdaGraphviz;
                    GdaGraphvizClass;
                    GdaGraphvizPrivate;
GObject*            gda_graphviz_new                    (GdaDict *dict);
void                gda_graphviz_add_to_graph           (GdaGraphviz *graph,
                                                         GObject *obj);
gboolean            gda_graphviz_save_file              (GdaGraphviz *graph,
                                                         const gchar *filename,
                                                         GError **error);

Object Hierarchy

  GObject
   +----GdaObject
         +----GdaGraphviz

  GObject
   +----GdaObject
         +----GdaGraphviz

Description

An object os this class will be able to produce .dot files representing a graphical view of one or more query internals. The .dot file can be processed with the GraphViz tool (http://www.graphviz.org/).

Details

GdaGraphviz

typedef struct _GdaGraphviz GdaGraphviz;

GdaGraphviz

typedef struct _GdaGraphviz GdaGraphviz;

GdaGraphvizClass

typedef struct {
	GdaObjectClass              parent_class;
} GdaGraphvizClass;

GdaGraphvizPrivate

typedef struct _GdaGraphvizPrivate GdaGraphvizPrivate;

gda_graphviz_new ()

GObject*            gda_graphviz_new                    (GdaDict *dict);

Creates a new GdaGraphviz object

dict :

 a GdaDict object

Returns :

 the new object

gda_graphviz_add_to_graph ()

void                gda_graphviz_add_to_graph           (GdaGraphviz *graph,
                                                         GObject *obj);

Adds obj to be graphed by graph

graph :

 a GdaGraphviz object

obj :

 a GObject object to be graphed

gda_graphviz_save_file ()

gboolean            gda_graphviz_save_file              (GdaGraphviz *graph,
                                                         const gchar *filename,
                                                         GError **error);

Saves a dot representation of the graph object to filename

graph :

 a GdaGraphviz object

filename :

error :

Returns :

 TRUE if no error occurred
Generated by GTK-Doc V1.11