#include <RocsGraphFileFormatPlugin.h>

Inheritance diagram for RocsGraphFileFormatPlugin:

Public Member Functions
	RocsGraphFileFormatPlugin (QObject *parent)

	~RocsGraphFileFormatPlugin ()

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 RocsGraphFileFormatPlugin: Import and Export Plugin for internal graph format.

A Document Internal format may look like this:

'#'s are comments.

[Document Properties] # Canvas Size and Data Structure initialization. Width : [integer] Height : [integer] DataStructurePlugin : [string]

data types

[DataType Identifier1] Name : [string] IconName : [string] Color : [RGB in hex]

pointer types

[PointerType Identifier1] Name : [string] Color : [RGB in hex]

Data Structure Definitions.

Data Structures are layered, so there can be N of them.

Every Data and Pointer below a declaration of a DataStructure

belongs to that data structure.

[DataStructure Name1]

DataColor : [RGB in hex] # Color of newly created Data elements ( Nodes ) Pointercolor : [RBG in Hex] # Color of newly created Data elements ( Nodes ) name : [string] # Name of the data structure acessible in the scripting interface.

visibility : [bool] # is this DataStructure visible?

ShowNamesInData : [bool] # should the canvas show the name of the data on the screen? ShowNamesInNPointers : [bool] # ↑ ShowValuesInData : [bool] # ↑ ShowValuesInPointers : [bool] # ↑

PluginDefinedProperty1 : propertyValue; # the plugins can define other properties for the data structure. PluginDefinedProperty1 : propertyValue; PluginDefinedProperty1 : propertyValue;

UserDefinedProperty1 : propertyValue1 # the user can define other properties for the data structure. UserDefinedProperty2 : propertyValue2 UserDefinedProperty3 : propertyValue3

[Data 1] type : [int] x : [real] y : [real] color : [string in "0xFFFFFF" format] name : [string] value : [string] size : [float]

property1 : propertyValue1 property2 : propertyValue2 property3 : propertyValue3

[Data 2] <- same as above. type : [int] x : [integer] y : [integer] color : [string in "0xFFFFFF" format] name : [string] value : [string] size : [float]

property1 : propertyValue1 property2 : propertyValue2 property3 : propertyValue3

[Pointer 1 -> 2] type : [int] name : [string] value : [string] style : [string] color : [string in "0xFFFFFF" format] width : [float]

property1 : propertyValue1 property2 : propertyValue2 property3 : propertyValue3

Definition at line 115 of file RocsGraphFileFormatPlugin.h.