Scribus
Open source desktop publishing at your fingertips
OldScribusFormat Class Reference
Inheritance diagram for OldScribusFormat:
Collaboration diagram for OldScribusFormat:

Public Member Functions

virtual const QString fullTrName () const
 Plug-in's human-readable, translated name. More...
 
virtual const AboutDatagetAboutData () const
 Return descriptive information about the plug-in. More...
 
virtual void deleteAboutData (const AboutData *about) const
 
virtual void languageChange ()
 Update all user-visible text to reflect current UI language. More...
 
virtual bool fileSupported (QIODevice *file) const
 
virtual bool loadFile (const QString &fileName, const FileFormat &fmt, int flags, int index=0)
 
virtual bool saveFile (const QString &fileName, const FileFormat &fmt)
 
virtual void addToMainWindowMenu (ScribusMainWindow *)
 Allow plugins to add to a main menu.
 
bool loadPage (int pageNumber, bool Mpage)
 
- Public Member Functions inherited from LoadSavePlugin
virtual bool loadElements (const QString &data, QString fileDir, int toLayer, double Xp_in, double Yp_in, bool loc)
 
virtual bool loadPalette (const QString &fileName)
 
virtual bool savePalette (const QString &fileName)
 
virtual QString saveElements (double xp, double yp, double wp, double hp, Selection *selection, QByteArray &prevData)
 
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, QHash< QString, multiLine > *Sty)
 
virtual bool readColors (const QString &fileName, ColorList &colors)
 
virtual bool readPageCount (const QString &fileName, int *num1, int *num2, QStringList &masterPageNames)
 
virtual QImage readThumbnail (const QString &fileName)
 
- Public Member Functions inherited from ScPlugin
 ScPlugin ()
 ctor, returns a new ScPlugin instance More...
 
virtual ~ScPlugin ()=0
 Destroy the ScPlugin instance. More...
 
virtual bool newPrefsPanelWidget (QWidget *parent, PrefsPanel *&panel, QString &caption, QPixmap &icon)
 Create and return a prefs UI panel for the plugin. More...
 
virtual bool newPrefsPanelWidget (QWidget *parent, Prefs_Pane *&panel, QString &caption, QPixmap &icon)
 
const QString & lastError () const
 Text summary of last error encountered. More...
 
bool hasLastError () const
 Returns if lastError message is not empty.
 
void clearLastError ()
 Clear last error message.
 
const QString pluginTypeName () const
 Returns human readable plugin type from plug-in's pluginType.
 
virtual void setDoc (ScribusDoc *doc)
 hooks that plugins can use to detect if the current document was closed etc..
 
virtual void unsetDoc ()
 
virtual void changedDoc (ScribusDoc *doc)
 

Additional Inherited Members

- Public Types inherited from LoadSavePlugin
enum  loadFlags {
  lfCreateDoc = 1, lfUseCurrentPage = 2, lfInsertPage = 4, lfInteractive = 8,
  lfScripted = 16, lfKeepColors = 32, lfKeepGradients = 64, lfKeepPatterns = 128,
  lfCreateThumbnail = 256, lfLoadAsPattern = 512
}
 
- Static Public Member Functions inherited from LoadSavePlugin
static const QStringList getExtensionsForColors (const int id=47)
 
static const QStringList getExtensionsForImport (const int id=47)
 
static const QStringList getExtensionsForPreview (const int id=47)
 
static const QStringList fileDialogLoadFilter ()
 
static const QStringList fileDialogSaveFilter ()
 
static const FileFormatgetFormatById (const int id)
 
static FileFormatgetFormatByID (int id)
 
static FileFormatgetFormatByExt (const QString ext)
 
static const QList< FileFormat > & supportedFormats ()
 
- Protected Member Functions inherited from LoadSavePlugin
virtual bool checkFlags (int flags)
 Check a loadFlags combination.
 
void registerFormat (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.
 
virtual void setFileReadError ()
 
virtual void setDomParsingError (const QString &msg, int line, int column)
 
- Protected Attributes inherited from LoadSavePlugin
ScribusDocm_Doc
 
ScribusViewm_View
 
ScribusMainWindowm_ScMW
 
QProgressBar * m_mwProgressBar
 
SCFontsm_AvailableFonts
 
QString m_lastSavedFile
 
UndoManager *const undoManager
 
- Protected Attributes inherited from ScPlugin
QString m_lastError
 Human readable, translated version of last error to occur.
 

Member Function Documentation

const QString OldScribusFormat::fullTrName ( ) const
virtual

Plug-in's human-readable, translated name.

Please don't use this for anything except display to the user. The results of testing the value of this can not be guaranteed, as its value may change depending on locale and change at runtime.

Implements ScPlugin.

const ScActionPlugin::AboutData * OldScribusFormat::getAboutData ( ) const
virtual

Return descriptive information about the plug-in.

Returns a structure containing descriptive information about the plug-in. This information is used in places like the Help->About Plug-ins menu item. The stucture MUST be deleted using deleteAboutData(AboutData* about) when finished with.

Every plugin MUST reimplement getAboutData(...) and deleteAboutData(...).

See also
ScPlugin::deleteAboutData

Implements ScPlugin.

void OldScribusFormat::languageChange ( )
virtual

Update all user-visible text to reflect current UI language.

Updates the text on all widgets on the plug-in to reflect the new language. You should generally use this method to set all the widget text during construction. That ensures that text is not duplicated, and that when this method is called the text of all persistent widgets is correctly changed.

This method only needs to affect text in widgets that currently exists (displayed or otherwise).

Implements ScPlugin.


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