Scribus API for plugins
A stable, high level and documented interface to the Scribus core that plugin developers can use to access the Scribus features.
Todo List
Member ScribusAPIDocument::getPageAsPNG (int pageNumber, int width, int height)
implement this (what's the use case?); untested for now.
Member ScribusAPIDocumentItemText::append (const QString text, const QString paragraphStyle="", const QString characterStyle="")
: implement it.
Member ScribusAPIDocumentItemText::applyCharacterStyle (const QString styleName)
:
  • apply the style depending on the "type" of the current selection:
    • to the whole frame if a frame is selected
    • to the whole paragraphs in the selection if there is a selection
    • to the whole current paragraph if there is no selection but the cursor is in edit mode.
    • have a look at void ScribusDoc::itemSelection_SetNamedCharStyle(const QString& name, Selection* customSelection)
Member ScribusAPIDocumentItemText::applyParagraphStyle (const QString styleName)
:
  • apply the style depending on the "type" of the current selection:
    • to the whole frame if a frame is selected
    • to the whole paragraphs in the selection if there is a selection
    • to the whole current paragraph if there is no selection but the cursor is in edit mode.
    • have a look at void ScribusDoc::itemSelection_SetNamedCharStyle(const QString& name, Selection* customSelection)
    • a different approach might use the story-applyStyle(pos, style) used in gtaction.cpp
    • it probably only works if we are already in edit mode and the cursor has a position
Member ScribusAPIDocumentItemText::getDom (QDomDocument xhtmlDocument)
:
  • should xhtmlDocument be passed by value?
  • eventually allow to get the dom of the current frame only (not the full story)
Member ScribusAPIDocumentItemText::getRuns (int start, int end)
:
  • use the text/storytext methods as soon as they are implemented