VisuDumpData

VisuDumpData — A generic class defining interface to export VisuData into text formats.

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── ToolDbgObj
        ╰── ToolFileFormat
            ╰── VisuDump
                ╰── VisuDumpData

Description

Instance of this class can be used to export any VisuData into other text formats.

Functions

VisuDumpDataWriteFunc ()

gboolean
(*VisuDumpDataWriteFunc) (VisuDumpData *format,
                          const char *fileName,
                          VisuData *dataObj,
                          GError **error);

This is a prototype of a method implemented by a dumping extension that is called when the current rendering must be dumped to a file.

Parameters

format

a VisuDumpData object ;

 

fileName

a string that defined the file to write to ;

 

dataObj

the VisuData to be exported ;

 

error

a location to store some error (not NULL) ;.

[allow-none]

Returns

TRUE if everything went right.


visu_dump_data_new ()

VisuDumpData *
visu_dump_data_new (const gchar *descr,
                    const gchar **patterns,
                    VisuDumpDataWriteFunc method);

Creates a new VisuDumpData object.

Parameters

descr

a description.

 

patterns

a list of file patterns.

[array zero-terminated=1]

method

the write method.

[scope call]

Returns

a newly created VisuDumpData object.

[transfer full]

Since: 3.8


visu_dump_data_write ()

gboolean
visu_dump_data_write (VisuDumpData *dump,
                      const char *fileName,
                      VisuData *dataObj,
                      GError **error);

Use the write function of dump to export the current dataObj to file fileName .

Parameters

dump

a VisuDump object ;

 

fileName

a string that defined the file to write to ;.

[type filename]

dataObj

the VisuData to be exported ;

 

error

a location to store some error (not NULL) ;

 

Returns

TRUE if dump succeed.

Since: 3.6

Types and Values

struct VisuDumpData

struct VisuDumpData;

Common name to refer to a _VisuDumpData.


struct VisuDumpDataClass

struct VisuDumpDataClass {
  VisuDumpClass parent;
};

Common name to refer to a _VisuDumpDataClass.

Members

VisuDumpClass parent;

private.