Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

LoadSavePlugin Class Reference

#include <loadsaveplugin.h>

Inheritance diagram for LoadSavePlugin:

Inheritance graph
[legend]
Collaboration diagram for LoadSavePlugin:

Collaboration graph
[legend]

List of all members.

Public Types

enum  loadFlags {
  lfCreateDoc = 1, lfUseCurrentPage = 2, lfInsertPage = 4, lfInteractive = 8,
  lfScripted = 16
}

Public Member Functions

 LoadSavePlugin ()
 ~LoadSavePlugin ()
virtual bool loadFile (const QString &fileName, const FileFormat &fmt, int flags, int index=0)
virtual bool saveFile (const QString &fileName, const FileFormat &fmt)
virtual const QString & lastSavedFile (void)
virtual bool fileSupported (QIODevice *file, const QString &fileName=QString::null) const =0
virtual void setupTargets (ScribusDoc *targetDoc, ScribusView *targetView, ScribusMainWindow *targetMW, QProgressBar *targetMWPRogressBar, SCFonts *targetAvailableFonts)
virtual void getReplacedFontData (bool &getNewReplacement, QMap< QString, QString > &getReplacedFonts, QList< ScFace > &getDummyScFaces)
virtual bool loadPage (const QString &fileName, int pageNumber, bool Mpage, QString renamedPageName=QString::null)
virtual bool readStyles (const QString &fileName, ScribusDoc *doc, StyleSet< ParagraphStyle > &docParagraphStyles)
virtual bool readCharStyles (const QString &fileName, ScribusDoc *doc, StyleSet< CharStyle > &docCharStyles)
virtual bool readLineStyles (const QString &fileName, QMap< QString, multiLine > *Sty)
virtual bool readColors (const QString &fileName, ColorList &colors)
virtual bool readPageCount (const QString &fileName, int *num1, int *num2, QStringList &masterPageNames)

Static Public Member Functions

static const QStringList fileDialogLoadFilter ()
static const QStringList fileDialogSaveFilter ()
static const FileFormatgetFormatById (const int id)
static const QList< FileFormat > & supportedFormats ()

Protected Member Functions

virtual bool checkFlags (int flags)
 Check a loadFlags combination.
void registerFormat (const FileFormat &fmt)
 Register the passed format so it can be used by the app.
void unregisterFormat (unsigned int id)
 Unregister the format with format ID `id' that references by the calling plugin.
void unregisterAll ()
 Unregister all formats owned by the calling plugin.

Protected Attributes

ScribusDocm_Doc
ScribusViewm_View
ScribusMainWindowm_ScMW
QProgressBar * m_mwProgressBar
SCFontsm_AvailableFonts
QString m_lastSavedFile

Static Private Member Functions

static QList< FileFormat >
::iterator 
findFormat (unsigned int id, LoadSavePlugin *plug=0, QList< FileFormat >::iterator it=formats.begin())
static QList< FileFormat >
::iterator 
findFormat (const QString &extension, LoadSavePlugin *plug=0, QList< FileFormat >::iterator it=formats.begin())
static void printFormatList ()
static const QStringList getDialogFilter (bool forLoad)

Static Private Attributes

static QList< FileFormatformats


Detailed Description

Definition at line 34 of file loadsaveplugin.h.


Member Enumeration Documentation

Enumerator:
lfCreateDoc 
lfUseCurrentPage 
lfInsertPage 
lfInteractive 
lfScripted 

Definition at line 43 of file loadsaveplugin.h.


Constructor & Destructor Documentation

LoadSavePlugin::LoadSavePlugin (  ) 

Definition at line 14 of file loadsaveplugin.cpp.

LoadSavePlugin::~LoadSavePlugin (  ) 

Definition at line 24 of file loadsaveplugin.cpp.


Member Function Documentation

const QStringList LoadSavePlugin::fileDialogLoadFilter (  )  [static]

Definition at line 43 of file loadsaveplugin.cpp.

References getDialogFilter().

Referenced by FileLoader::getLoadFilterString().

const QStringList LoadSavePlugin::fileDialogSaveFilter (  )  [static]

Definition at line 48 of file loadsaveplugin.cpp.

References getDialogFilter().

const FileFormat * LoadSavePlugin::getFormatById ( const int  id  )  [static]

bool LoadSavePlugin::loadFile ( const QString &  fileName,
const FileFormat fmt,
int  flags,
int  index = 0 
) [virtual]

bool LoadSavePlugin::saveFile ( const QString &  fileName,
const FileFormat fmt 
) [virtual]

Reimplemented in OldScribusFormat, Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 85 of file loadsaveplugin.cpp.

Referenced by FileFormat::saveFile().

const QString & LoadSavePlugin::lastSavedFile ( void   )  [virtual]

Definition at line 91 of file loadsaveplugin.cpp.

References m_lastSavedFile.

Referenced by FileFormat::lastSavedFile().

virtual bool LoadSavePlugin::fileSupported ( QIODevice *  file,
const QString &  fileName = QString::null 
) const [pure virtual]

const QList< FileFormat > & LoadSavePlugin::supportedFormats (  )  [static]

Definition at line 29 of file loadsaveplugin.cpp.

References formats.

Referenced by FileLoader::findFormat(), and FileLoader::TestFile().

void LoadSavePlugin::setupTargets ( ScribusDoc targetDoc,
ScribusView targetView,
ScribusMainWindow targetMW,
QProgressBar *  targetMWPRogressBar,
SCFonts targetAvailableFonts 
) [virtual]

Definition at line 211 of file loadsaveplugin.cpp.

References m_AvailableFonts, m_Doc, m_mwProgressBar, m_ScMW, and m_View.

Referenced by FileFormat::setupTargets().

void LoadSavePlugin::getReplacedFontData ( bool &  getNewReplacement,
QMap< QString, QString > &  getReplacedFonts,
QList< ScFace > &  getDummyScFaces 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 220 of file loadsaveplugin.cpp.

Referenced by FileFormat::getReplacedFontData().

bool LoadSavePlugin::loadPage ( const QString &  fileName,
int  pageNumber,
bool  Mpage,
QString  renamedPageName = QString::null 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 224 of file loadsaveplugin.cpp.

Referenced by FileFormat::loadPage().

bool LoadSavePlugin::readStyles ( const QString &  fileName,
ScribusDoc doc,
StyleSet< ParagraphStyle > &  docParagraphStyles 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 229 of file loadsaveplugin.cpp.

Referenced by FileFormat::readStyles().

bool LoadSavePlugin::readCharStyles ( const QString &  fileName,
ScribusDoc doc,
StyleSet< CharStyle > &  docCharStyles 
) [virtual]

Reimplemented in Scribus134Format.

Definition at line 234 of file loadsaveplugin.cpp.

Referenced by FileFormat::readCharStyles().

bool LoadSavePlugin::readLineStyles ( const QString &  fileName,
QMap< QString, multiLine > *  Sty 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 239 of file loadsaveplugin.cpp.

Referenced by FileFormat::readLineStyles().

bool LoadSavePlugin::readColors ( const QString &  fileName,
ColorList colors 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 244 of file loadsaveplugin.cpp.

Referenced by FileFormat::readColors().

bool LoadSavePlugin::readPageCount ( const QString &  fileName,
int *  num1,
int *  num2,
QStringList &  masterPageNames 
) [virtual]

Reimplemented in Scribus12Format, Scribus134Format, and Scribus13Format.

Definition at line 249 of file loadsaveplugin.cpp.

Referenced by FileFormat::readPageCount().

bool LoadSavePlugin::checkFlags ( int  flags  )  [protected, virtual]

void LoadSavePlugin::registerFormat ( const FileFormat fmt  )  [protected]

void LoadSavePlugin::unregisterFormat ( unsigned int  id  )  [protected]

Unregister the format with format ID `id' that references by the calling plugin.

Definition at line 156 of file loadsaveplugin.cpp.

References findFormat(), and formats.

void LoadSavePlugin::unregisterAll (  )  [protected]

QList< FileFormat >::iterator LoadSavePlugin::findFormat ( unsigned int  id,
LoadSavePlugin plug = 0,
QList< FileFormat >::iterator  it = formats.begin() 
) [static, private]

Definition at line 177 of file loadsaveplugin.cpp.

References formats.

Referenced by getFormatById(), and unregisterFormat().

QList< FileFormat >::iterator LoadSavePlugin::findFormat ( const QString &  extension,
LoadSavePlugin plug = 0,
QList< FileFormat >::iterator  it = formats.begin() 
) [static, private]

Definition at line 194 of file loadsaveplugin.cpp.

References formats.

void LoadSavePlugin::printFormatList (  )  [static, private]

Definition at line 143 of file loadsaveplugin.cpp.

References formats.

const QStringList LoadSavePlugin::getDialogFilter ( bool  forLoad  )  [static, private]

Definition at line 53 of file loadsaveplugin.cpp.

References data, formats, and tr().

Referenced by fileDialogLoadFilter(), and fileDialogSaveFilter().


Member Data Documentation

Definition at line 117 of file loadsaveplugin.h.

Referenced by setupTargets().

QProgressBar* LoadSavePlugin::m_mwProgressBar [protected]

QString LoadSavePlugin::m_lastSavedFile [protected]

Definition at line 120 of file loadsaveplugin.h.

Referenced by lastSavedFile(), and Scribus134Format::saveFile().

QList< FileFormat > LoadSavePlugin::formats [static, private]


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.