TgfFileFormatPlugin Class Reference

#include <TgfFileFormatPlugin.h>

Inheritance diagram for TgfFileFormatPlugin:

Public Member Functions
	TgfFileFormatPlugin (QObject *parent, const QList< QVariant > &)
	~TgfFileFormatPlugin ()
virtual const QStringList	extensions () const
virtual void	readFile ()
virtual void	writeFile (Document &graph)
Public Member Functions inherited from GraphFilePluginInterface
	GraphFilePluginInterface (const KAboutData *aboutData, QObject *parent)
virtual	~GraphFilePluginInterface ()
const KAboutData *	aboutData () const
Error	error () const
QString	errorString () const
virtual Document *	graphDocument () const
bool	hasError () const
virtual bool	isGraphDocument () const
virtual PluginType	pluginCapability () const
void	setFile (const KUrl &file)

Additional Inherited Members
Public Types inherited from GraphFilePluginInterface
enum	Error {   None, Unknown, FileIsReadOnly, CouldNotOpenFile,   NoGraphFound, EncodingProblem, CouldNotRecognizeFileFormat, NotSupportedOperation }
enum	PluginType { ImportOnly, ExportOnly, ImportAndExport }
Protected Member Functions inherited from GraphFilePluginInterface
const KUrl &	file () const
void	setError (Error error, QString message=QString())
void	setGraphDocument (Document *document)

Detailed Description

class TgfFileFormatPlugin: Import and Export Plugin for TGF

This plugin class allows reading and writing of Trivial Graph Format (TGF) files. TGF is a simple file format that can store directed graphs by a list of nodes and list of edges. Each node and each edge can have exactly one label.

Format Specification:

• The file starts with a list of nodes (one node per line), followed by a line with the only character "#", followed by a list of edges (one edge per line).
• A node consists of an integer (identifier), followed by a space, followed by an arbitrary string.
• An edge consists of two integers (identifiers) separated by a space, followed by a space, followed by an arbitray string. It is assumed that the directed edge points from the first identifier to the second identifier.

Definition at line 41 of file TgfFileFormatPlugin.h.

Constructor & Destructor Documentation

TgfFileFormatPlugin::TgfFileFormatPlugin ( QObject *  parent, const QList< QVariant > &    )

explicit

Definition at line 44 of file TgfFileFormatPlugin.cpp.

TgfFileFormatPlugin::~TgfFileFormatPlugin

(

)

Definition at line 49 of file TgfFileFormatPlugin.cpp.

Member Function Documentation

const QStringList TgfFileFormatPlugin::extensions ( ) const

virtual

File extensions that are common for this file type.

Implements GraphFilePluginInterface.

Definition at line 53 of file TgfFileFormatPlugin.cpp.

void TgfFileFormatPlugin::readFile ( )

virtual

Open given file and imports it into internal format.

Parameters

file	is url of a local file

Implements GraphFilePluginInterface.

Definition at line 60 of file TgfFileFormatPlugin.cpp.

void TgfFileFormatPlugin::writeFile ( Document &  graph )

virtual

Writes given graph document to formerly specified file.

See also

setFile().

Parameters

graph

is graphDocument to be serialized

Implements GraphFilePluginInterface.

Definition at line 116 of file TgfFileFormatPlugin.cpp.

---

The documentation for this class was generated from the following files:

• TgfFileFormatPlugin.h
• TgfFileFormatPlugin.cpp