TikzFileFormatPlugin Class Reference

#include <TikzFileFormatPlugin.h>

Inheritance diagram for TikzFileFormatPlugin:

Public Member Functions
	TikzFileFormatPlugin (QObject *parent, const QList< QVariant > &)
	~TikzFileFormatPlugin ()
virtual const QStringList	extensions () const
virtual GraphFilePluginInterface::PluginType	pluginCapability () 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
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 TikzFileFormatPlugin: Export Plugin for PGF/TikZ files

This plugin class allows (only) writing of PGF/TikZ files for usage in LaTeX documents.

Definition at line 29 of file TikzFileFormatPlugin.h.

Constructor & Destructor Documentation

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

explicit

Definition at line 42 of file TikzFileFormatPlugin.cpp.

TikzFileFormatPlugin::~TikzFileFormatPlugin

(

)

Definition at line 47 of file TikzFileFormatPlugin.cpp.

Member Function Documentation

const QStringList TikzFileFormatPlugin::extensions ( ) const

virtual

File extensions that are common for this file type.

Implements GraphFilePluginInterface.

Definition at line 51 of file TikzFileFormatPlugin.cpp.

GraphFilePluginInterface::PluginType TikzFileFormatPlugin::pluginCapability ( ) const

virtual

Returns PluginType to indicate whether the plugin only provides import, only export or both capabilities.

This method should be used to determine in which file dialogs the plugin shall be included.

Returns

is by default PluginType::ImportAndExport

Reimplemented from GraphFilePluginInterface.

Definition at line 57 of file TikzFileFormatPlugin.cpp.

void TikzFileFormatPlugin::readFile ( )

virtual

Open given file and imports it into internal format.

Implements GraphFilePluginInterface.

Definition at line 63 of file TikzFileFormatPlugin.cpp.

void TikzFileFormatPlugin::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 70 of file TikzFileFormatPlugin.cpp.

---

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

• TikzFileFormatPlugin.h
• TikzFileFormatPlugin.cpp