Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

Scribus12Format Class Reference

#include <scribus12format.h>

Inheritance diagram for Scribus12Format:

Inheritance graph
[legend]
Collaboration diagram for Scribus12Format:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Scribus12Format ()
virtual ~Scribus12Format ()
virtual const QString fullTrName () const
 Plug-in's human-readable, translated name.
virtual const AboutDatagetAboutData () const
 Return descriptive information about the plug-in.
virtual void deleteAboutData (const AboutData *about) const
virtual void languageChange ()
 Update all user-visible text to reflect current UI language.
virtual bool fileSupported (QIODevice *file, const QString &fileName=QString::null) 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.
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 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)
virtual void getReplacedFontData (bool &getNewReplacement, QMap< QString, QString > &getReplacedFonts, QList< ScFace > &getDummyScFaces)

Private Member Functions

void registerFormats ()
void GetItemProps (QDomElement *obj, struct CopyPasteBuffer *OB, const QString &baseDir, bool newVersion)
void GetItemText (QDomElement *it, ScribusDoc *doc, bool VorLFound, bool impo, PageItem *obj, LastStyles *last)
void GetStyle (QDomElement *pg, ParagraphStyle *vg, StyleSet< ParagraphStyle > *tempParagraphStyles, ScribusDoc *doc, bool fl)
QString readSLA (const QString &fileName)

Private Attributes

QMap< long long, int > itemRemap
QMap< int, long long > itemNext
QMap< uint, QString > DoVorl
uint VorlC


Detailed Description

Definition at line 23 of file scribus12format.h.


Constructor & Destructor Documentation

Scribus12Format::Scribus12Format (  ) 

Definition at line 35 of file scribus12format.cpp.

References languageChange().

Referenced by scribus12format_getPlugin().

Scribus12Format::~Scribus12Format (  )  [virtual]

Definition at line 43 of file scribus12format.cpp.

References LoadSavePlugin::unregisterAll().


Member Function Documentation

const QString Scribus12Format::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.

Definition at line 55 of file scribus12format.cpp.

References tr().

const ScActionPlugin::AboutData * Scribus12Format::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.

Definition at line 60 of file scribus12format.cpp.

void Scribus12Format::deleteAboutData ( const AboutData about  )  const [virtual]

Implements ScPlugin.

Definition at line 67 of file scribus12format.cpp.

void Scribus12Format::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.

Definition at line 48 of file scribus12format.cpp.

References registerFormats(), and LoadSavePlugin::unregisterAll().

Referenced by Scribus12Format().

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

Implements LoadSavePlugin.

Definition at line 110 of file scribus12format.cpp.

References ScGzFile::data(), loadRawText(), and ScGzFile::read().

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

Reimplemented from LoadSavePlugin.

Definition at line 184 of file scribus12format.cpp.

References ScribusDoc::activeLayer(), ScribusDoc::addMasterPage(), ScribusView::addPage(), ScribusDoc::addPage(), VGradient::addStop(), ScribusDoc::BookMa::Aktion, LPIData::Angle, PrefsManager::appPrefs, PDFOptions::Articles, PageItem::asTextFrame(), ScribusDoc::AutoCheck, typoPrefs::autoLineSpacing, ScribusDoc::Automatic, guidesPrefs::baseShown, PDFOptions::Binding, CMSData::BlackPoint, PDFOptions::bleeds, PDFOptions::Bookmarks, ScribusDoc::BookMarks, MarginStruct::Bottom, PageItem::BottomLink, PageItem::BottomLinkID, CMSData::CMSinUse, ScribusDoc::CMSSettings, guidesPrefs::colBordersShown, SingleLine::Color, PDFOptions::Compress, PDFOptions::CompressMethod, StyleSet< STYLE >::create(), ScribusDoc::currentPage(), ScribusDoc::currentPageLayout, SingleLine::Dash, PDFOptions::Datei, toolPrefs::dCols, CMSData::DefaultImageCMYKProfile, CMSData::DefaultImageRGBProfile, CMSData::DefaultIntentColors, CMSData::DefaultIntentImages, CMSData::DefaultMonitorProfile, CMSData::DefaultPrinterProfile, CMSData::DefaultSolidColorCMYKProfile, CMSData::DefaultSolidColorRGBProfile, toolPrefs::defFont, toolPrefs::defSize, toolPrefs::dEndArrow, toolPrefs::dGap, PDFPresentationData::Di, PDFPresentationData::Dm, ScribusDoc::documentInfo, PDFOptions::doMultiFile, PDFOptions::doOverprint, DoVorl, toolPrefs::dStartArrow, PDFPresentationData::effectType, PDFOptions::EmbeddedI, PDFOptions::EmbedList, PDFOptions::Encrypt, CopyPasteBuffer::endArrowIndex, CopyPasteBuffer::fill_gradient, SCFonts::findFont(), ScribusDoc::BookMa::First, ScribusDoc::FirstAuto, ScribusDoc::FirstPnum, ScLayer::flowControl, guidesPrefs::framesShown, LPIData::Frequency, ScColor::fromQColor(), CMSData::GamutCheck, GetItemProps(), GetItemText(), GetStyle(), CopyPasteBuffer::GrColor, CopyPasteBuffer::GrColor2, guidesPrefs::gridShown, ScribusDoc::GroupCounter, CopyPasteBuffer::Groups, ScribusDoc::GuideLock, ApplicationPrefs::guidesSettings, ScribusDoc::guidesSettings, guidesPrefs::guidesShown, handleOldColorShade(), ScribusDoc::HyCount, CopyPasteBuffer::IFont, PDFOptions::ImageProf, PDFOptions::Info, PrefsManager::instance(), PDFOptions::Intent, PDFOptions::Intent2, PageItem::isAutoText, CopyPasteBuffer::isBookmark, PDFOptions::isGrayscale, PageItem::isTableItem, itemNext, ScribusDoc::BookMa::ItemNr, PageItem::ItemNr, itemRemap, ScribusDoc::Items, CopyPasteBuffer::itemText, ScribusDoc::JavaScripts, CopyPasteBuffer::Language, ScribusDoc::Language, ScribusDoc::BookMa::Last, ScribusDoc::LastAuto, ScribusDoc::layerCount(), guidesPrefs::layerMarkersShown, CopyPasteBuffer::LayerNr, ScribusDoc::Layers, MarginStruct::Left, PageItem::LeftLink, PageItem::LeftLinkID, SingleLine::LineEnd, SingleLine::LineJoin, PageItem::link(), guidesPrefs::linkShown, ScLayer::LNr, PDFOptions::LPISettings, PDFPresentationData::M, LoadSavePlugin::m_AvailableFonts, LoadSavePlugin::m_Doc, LoadSavePlugin::m_mwProgressBar, ScribusDoc::m_pageSize, LoadSavePlugin::m_View, guidesPrefs::majorGrid, guidesPrefs::marginsShown, ScribusDoc::masterPageMode(), guidesPrefs::minorGrid, ScribusDoc::MinWordLen, PDFOptions::MirrorH, PDFOptions::MirrorV, ScribusDoc::MLineStyles, Page::MPageNam, CopyPasteBuffer::NamedLStyle, ScLayers::newLayer(), ScribusDoc::BookMa::Next, PageItem::nextInChain(), CommonStrings::None, typoPrefs::offsetBaseGrid, ScribusDoc::OldBM, PageItem::oldOwnPage, PageItem::OnMasterPage, PageItem::OwnPage, ScribusDoc::PageColors, PDFPresentationData::pageEffectDuration, ScribusDoc::pageHeight, ScribusDoc::pageMargins, ScribusDoc::BookMa::PageObject, ScribusDoc::PageOri, ScribusDoc::Pages, ScribusDoc::pageSets, ScribusDoc::PageSp, ScribusDoc::PageSpa, PDFPresentationData::pageViewDuration, ScribusDoc::pageWidth, ScribusDoc::BookMa::Parent, PDFOptions::PassOwner, PDFOptions::PassUser, ScribusView::PasteItem(), ScribusDoc::PDF_Options, PDFOptions::Permissions, PDFOptions::PicRes, PDFOptions::PresentMode, PDFOptions::PresentVals, ScribusDoc::BookMa::Prev, PageItem::prevInChain(), PDFOptions::PrintProf, PDFOptions::Quality, GuideManagerIO::readHorizontalGuides(), readSLA(), GuideManagerIO::readVerticalGuides(), PDFOptions::RecalcPic, ScribusDoc::redefineStyles(), ScribusView::reformPages(), PDFOptions::Resolution, MarginStruct::Right, PageItem::RightLink, PageItem::RightLinkID, PDFOptions::RotateDeg, typoPrefs::scalingSubScript, typoPrefs::scalingSuperScript, scribus12itemID(), ScribusDoc::setActiveLayer(), DocumentInformation::setAuthor(), SetColor(), DocumentInformation::setComments(), DocumentInformation::setContrib(), DocumentInformation::setCover(), setCurrentComboItem(), ScribusDoc::setCurrentPage(), DocumentInformation::setDate(), DocumentInformation::setFormat(), DocumentInformation::setIdent(), DocumentInformation::setKeywords(), DocumentInformation::setLangInfo(), ScribusDoc::setMasterPageMode(), ScColor::setNamedColor(), DocumentInformation::setPublisher(), PageItem::setRedrawBounding(), ScColor::setRegistrationColor(), DocumentInformation::setRelation(), DocumentInformation::setRights(), DocumentInformation::setSource(), ScColor::setSpotColor(), DocumentInformation::setTitle(), DocumentInformation::setType(), ScribusDoc::setUnitIndex(), ScribusDoc::setUsesAutomaticTextFrames(), SingleLine::Shade, guidesPrefs::showControls, guidesPrefs::showPic, ScribusDoc::SnapGuides, CMSData::SoftProofFullOn, CMSData::SoftProofOn, PDFOptions::SolidProf, LPIData::SpotFunc, GuideManagerCore::Standard, CopyPasteBuffer::startArrowIndex, PDFOptions::SubsetList, ScribusDoc::BookMa::Text, CopyPasteBuffer::textAlignment, PDFOptions::Thumbnails, ScribusDoc::BookMa::Title, ApplicationPrefs::toolSettings, ScribusDoc::toolSettings, MarginStruct::Top, PageItem::TopLink, PageItem::TopLinkID, tr(), ScribusDoc::typographicSettings, unitGetStrFromIndex(), ScribusDoc::unitIndex(), ScribusView::unitSwitcher, PDFOptions::useLayers, PDFOptions::UseLPI, PDFOptions::UseProfiles, PDFOptions::UseProfiles2, ScribusDoc::useRaster, PDFOptions::UseRGB, PDFOptions::UseSpotColors, typoPrefs::valueBaseGrid, typoPrefs::valueSmallCaps, typoPrefs::valueSubScript, typoPrefs::valueSuperScript, PDFOptions::Version, VorlC, SingleLine::Width, CopyPasteBuffer::Xpos, and CopyPasteBuffer::Ypos.

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

Reimplemented from LoadSavePlugin.

Definition at line 748 of file scribus12format.cpp.

virtual void Scribus12Format::addToMainWindowMenu ( ScribusMainWindow  )  [inline, virtual]

Allow plugins to add to a main menu.

Implements ScPlugin.

Definition at line 40 of file scribus12format.h.

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

Reimplemented from LoadSavePlugin.

Definition at line 1108 of file scribus12format.cpp.

References VGradient::addStop(), ScribusDoc::BookMa::Aktion, PageItem::asTextFrame(), ScribusDoc::BookMarks, PageItem::BottomLink, PageItem::BottomLinkID, SingleLine::Color, ScribusDoc::currentPage(), SingleLine::Dash, toolPrefs::defFont, DoVorl, CopyPasteBuffer::endArrowIndex, CopyPasteBuffer::fill_gradient, SCFonts::findFont(), ScribusDoc::BookMa::First, ScColor::fromQColor(), GetItemProps(), GetItemText(), GetStyle(), CopyPasteBuffer::GrColor, CopyPasteBuffer::GrColor2, CopyPasteBuffer::Groups, handleOldColorShade(), CopyPasteBuffer::IFont, CopyPasteBuffer::isBookmark, itemNext, ScribusDoc::BookMa::ItemNr, itemRemap, ScribusDoc::Items, CopyPasteBuffer::itemText, ScribusDoc::JavaScripts, ScribusDoc::Language, CopyPasteBuffer::Language, ScribusDoc::BookMa::Last, ScLayers::layerByName(), ScribusDoc::layerCount(), CopyPasteBuffer::LayerNr, ScribusDoc::Layers, PageItem::LeftLink, PageItem::LeftLinkID, SingleLine::LineEnd, SingleLine::LineJoin, PageItem::link(), ScLayer::LNr, LoadSavePlugin::m_AvailableFonts, LoadSavePlugin::m_Doc, LoadSavePlugin::m_View, ScribusDoc::MLineStyles, CopyPasteBuffer::NamedLStyle, ScribusDoc::BookMa::Next, PageItem::nextInChain(), CommonStrings::None, ScribusDoc::OldBM, ScribusDoc::PageColors, Page::pageNr(), ScribusDoc::BookMa::PageObject, ScribusDoc::Pages, ScribusDoc::BookMa::Parent, ScribusView::PasteItem(), ScribusDoc::BookMa::Prev, PageItem::prevInChain(), GuideManagerIO::readHorizontalGuides(), readSLA(), GuideManagerIO::readVerticalGuides(), ScribusView::reformPages(), PageItem::RightLink, PageItem::RightLinkID, scribus12itemID(), SetColor(), ScColor::setNamedColor(), ScColor::setRegistrationColor(), ScColor::setSpotColor(), SingleLine::Shade, GuideManagerCore::Standard, CopyPasteBuffer::startArrowIndex, ScribusDoc::BookMa::Text, CopyPasteBuffer::textAlignment, ScribusDoc::BookMa::Title, ScribusDoc::toolSettings, PageItem::TopLink, PageItem::TopLinkID, tr(), VorlC, SingleLine::Width, CopyPasteBuffer::Xpos, and CopyPasteBuffer::Ypos.

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

Reimplemented from LoadSavePlugin.

Definition at line 1641 of file scribus12format.cpp.

References GetStyle(), and readSLA().

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

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

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

Reimplemented from LoadSavePlugin.

Definition at line 1775 of file scribus12format.cpp.

References readSLA().

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

Reimplemented from LoadSavePlugin.

Definition at line 172 of file scribus12format.cpp.

void Scribus12Format::registerFormats (  )  [private]

void Scribus12Format::GetItemProps ( QDomElement *  obj,
struct CopyPasteBuffer OB,
const QString &  baseDir,
bool  newVersion 
) [private]

Definition at line 753 of file scribus12format.cpp.

References Annotation::ActionType(), CopyPasteBuffer::AnName, CopyPasteBuffer::AspectRatio, CopyPasteBuffer::BaseOffs, CopyPasteBuffer::BExtra, CopyPasteBuffer::BottomLine, CopyPasteBuffer::BottomLinkID, VGradient::clearStops(), CopyPasteBuffer::Clip, CopyPasteBuffer::ClipEdited, CopyPasteBuffer::ColGap, CopyPasteBuffer::Cols, CopyPasteBuffer::ContourLine, CopyPasteBuffer::DashOffset, CopyPasteBuffer::DashValues, CopyPasteBuffer::EmProfile, Annotation::Extern(), CopyPasteBuffer::Extra, CopyPasteBuffer::ExtraV, CopyPasteBuffer::fill_gradient, CopyPasteBuffer::FillRule, CopyPasteBuffer::flippedH, CopyPasteBuffer::flippedV, CopyPasteBuffer::FrameType, CopyPasteBuffer::GrColor, CopyPasteBuffer::GrColor2, CopyPasteBuffer::GrEndX, CopyPasteBuffer::GrEndY, CopyPasteBuffer::GrShade, CopyPasteBuffer::GrShade2, CopyPasteBuffer::GrStartX, CopyPasteBuffer::GrStartY, CopyPasteBuffer::GrType, CopyPasteBuffer::Height, CopyPasteBuffer::IProfile, CopyPasteBuffer::IRender, CopyPasteBuffer::ISize, CopyPasteBuffer::isPrintable, CopyPasteBuffer::isTableItem, CopyPasteBuffer::LeftLine, CopyPasteBuffer::LeftLinkID, CopyPasteBuffer::LineSp, CopyPasteBuffer::LineSpMode, CopyPasteBuffer::LocalScX, CopyPasteBuffer::LocalScY, CopyPasteBuffer::LocalX, CopyPasteBuffer::LocalY, CopyPasteBuffer::Locked, CopyPasteBuffer::LockRes, CopyPasteBuffer::m_annotation, CopyPasteBuffer::m_isAnnotation, CommonStrings::None, CopyPasteBuffer::pattern, CopyPasteBuffer::patternOffsetX, CopyPasteBuffer::patternOffsetY, CopyPasteBuffer::patternRotation, CopyPasteBuffer::patternScaleX, CopyPasteBuffer::patternScaleY, CopyPasteBuffer::Pcolor, CopyPasteBuffer::Pcolor2, CopyPasteBuffer::Pfile, CopyPasteBuffer::Pfile2, CopyPasteBuffer::Pfile3, CopyPasteBuffer::PicArt, CopyPasteBuffer::PLineArt, CopyPasteBuffer::PLineEnd, CopyPasteBuffer::PLineJoin, CopyPasteBuffer::PoLine, CopyPasteBuffer::PoShow, CopyPasteBuffer::PType, CopyPasteBuffer::Pwidth, CopyPasteBuffer::RadRect, Relative2Path(), FPointArray::resize(), CopyPasteBuffer::Reverse, CopyPasteBuffer::RExtra, CopyPasteBuffer::RightLine, CopyPasteBuffer::RightLinkID, CopyPasteBuffer::Rot, CopyPasteBuffer::ScaleType, Annotation::setAAact(), Annotation::setAction(), Annotation::setActionType(), Annotation::setBl_act(), Annotation::setBorderColor(), Annotation::setBsty(), Annotation::setBwid(), Annotation::setC_act(), Annotation::setChkStil(), Annotation::setD_act(), Annotation::setDown(), Annotation::setE_act(), Annotation::setExtern(), Annotation::setF_act(), Annotation::setFeed(), Annotation::setFlag(), Annotation::setFo_act(), Annotation::setFont(), Annotation::setFormat(), Annotation::setHTML(), Annotation::setIPlace(), Annotation::setIsChk(), Annotation::setK_act(), Annotation::setMaxChar(), FPointArray::setPoint(), Annotation::setRollOver(), Annotation::setScaleW(), Annotation::setToolTip(), Annotation::setType(), Annotation::setUseIcons(), Annotation::setV_act(), Annotation::setVis(), Annotation::setX_act(), Annotation::setZiel(), CopyPasteBuffer::Shade, CopyPasteBuffer::Shade2, CopyPasteBuffer::ShTxtFill, CopyPasteBuffer::ShTxtStroke, ParagraphStyle::TabRecord::tabFillChar, ParagraphStyle::TabRecord::tabPosition, ParagraphStyle::TabRecord::tabType, CopyPasteBuffer::TabValues, CopyPasteBuffer::textAlignment, PageItem::TextFlowDisabled, CopyPasteBuffer::TextflowMode, PageItem::TextFlowUsesBoundingBox, PageItem::TextFlowUsesContourLine, PageItem::TextFlowUsesFrameShape, CopyPasteBuffer::textPathFlipped, CopyPasteBuffer::textPathType, CopyPasteBuffer::TExtra, CopyPasteBuffer::TopLine, CopyPasteBuffer::TopLinkID, CopyPasteBuffer::TransBlend, CopyPasteBuffer::TransBlendS, CopyPasteBuffer::Transparency, CopyPasteBuffer::TranspStroke, CopyPasteBuffer::TxTBase, CopyPasteBuffer::TxtFill, CopyPasteBuffer::TxtOutline, CopyPasteBuffer::TxtScale, CopyPasteBuffer::TxtScaleV, CopyPasteBuffer::TxtShadowX, CopyPasteBuffer::TxtShadowY, CopyPasteBuffer::TxtStrikePos, CopyPasteBuffer::TxtStrikeWidth, CopyPasteBuffer::TxtStroke, CopyPasteBuffer::TxTStyle, CopyPasteBuffer::TxtUnderPos, CopyPasteBuffer::TxtUnderWidth, CopyPasteBuffer::UseEmbedded, and CopyPasteBuffer::Width.

Referenced by loadFile(), and loadPage().

void Scribus12Format::GetItemText ( QDomElement *  it,
ScribusDoc doc,
bool  VorLFound,
bool  impo,
PageItem obj,
LastStyles last 
) [private]

void Scribus12Format::GetStyle ( QDomElement *  pg,
ParagraphStyle vg,
StyleSet< ParagraphStyle > *  tempParagraphStyles,
ScribusDoc doc,
bool  fl 
) [private]

QString Scribus12Format::readSLA ( const QString &  fileName  )  [private]


Member Data Documentation

QMap<long long,int> Scribus12Format::itemRemap [private]

Definition at line 62 of file scribus12format.h.

Referenced by loadFile(), and loadPage().

QMap<int,long long> Scribus12Format::itemNext [private]

Definition at line 63 of file scribus12format.h.

Referenced by loadFile(), and loadPage().

QMap<uint,QString> Scribus12Format::DoVorl [private]

Definition at line 64 of file scribus12format.h.

Referenced by GetItemText(), GetStyle(), loadFile(), and loadPage().

uint Scribus12Format::VorlC [private]

Definition at line 65 of file scribus12format.h.

Referenced by GetStyle(), loadFile(), and loadPage().


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.