MgGraphviz

Name

MgGraphviz -- Creates .dot files which can then be processed with GraphViz.

Synopsis



#define     MG_GRAPHVIZ_TYPE
#define     MG_GRAPHVIZ                     (obj)
#define     IS_MG_GRAPHVIZ                  (obj)
#define     MG_GRAPHVIZ_CLASS               (klass)
struct      MgGraphviz;
guint       mg_graphviz_get_type            (void);
GObject*    mg_graphviz_new                 (MgConf *conf);
void        mg_graphviz_add_to_graph        (MgGraphviz *graph,
                                             GObject *obj);
gboolean    mg_graphviz_save_file           (MgGraphviz *graph,
                                             const gchar *filename,
                                             GError **error);

Object Hierarchy


  GObject
   +----MgBase
         +----MgGraphviz

Properties


  "prop"                 gpointer             : Read / Write

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

MG_GRAPHVIZ_TYPE

#define MG_GRAPHVIZ_TYPE          (mg_graphviz_get_type())


MG_GRAPHVIZ()

#define MG_GRAPHVIZ(obj)          G_TYPE_CHECK_INSTANCE_CAST (obj, mg_graphviz_get_type(), MgGraphviz)

obj :


IS_MG_GRAPHVIZ()

#define IS_MG_GRAPHVIZ(obj)       G_TYPE_CHECK_INSTANCE_TYPE (obj, mg_graphviz_get_type ())

obj :


MG_GRAPHVIZ_CLASS()

#define MG_GRAPHVIZ_CLASS(klass)  G_TYPE_CHECK_CLASS_CAST (klass, mg_graphviz_get_type (), MgGraphvizClass)

klass :


struct MgGraphviz

struct MgGraphviz;


mg_graphviz_get_type ()

guint       mg_graphviz_get_type            (void);

Returns :


mg_graphviz_new ()

GObject*    mg_graphviz_new                 (MgConf *conf);

Creates a new MgGraphviz object

conf :

a MgConf object

Returns :

the new object


mg_graphviz_add_to_graph ()

void        mg_graphviz_add_to_graph        (MgGraphviz *graph,
                                             GObject *obj);

Adds obj to be graphed by graph

graph :

a MgGraphviz object

obj :

a GObject object to be graphed


mg_graphviz_save_file ()

gboolean    mg_graphviz_save_file           (MgGraphviz *graph,
                                             const gchar *filename,
                                             GError **error);

Saves a dot representation of the graph object to filename

graph :

a MgGraphviz object

filename :

error :

Returns :

TRUE if no error occured

Properties

"prop" (gpointer : Read / Write)