Scripter2 API: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
(link to https://scribus-scripter.readthedocs.org/en/latest/)
 
(26 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:Scribus]]
Scripter2 API is described below. This is a reference for the actual documentation of new scripter.
==Document API==
==Layer API==


QList<QVariant> '''getLayers'''()
See also rather : https://scribus-scripter.readthedocs.org/en/latest/


void '''setActiveLayer'''(QString layer)
The new Scripter is composed of different modules, which are either accessible externally, or via methods of other apis.


QString '''getActiveLayer'''()
==Scripter==
===<u>Properties</u>===
====activeDocument====


void '''sendToLayer'''(QString layer, QString name)
:This property return '''DocumentAPI''' object.


void '''setLayerVisible'''(QString layer, bool visible)
:Usage:


void '''setLayerPrintable'''(QString layer, bool printable)
::''document = Scripter.activeDocument''


void '''setLayerLocked'''(QString layer, bool locked)
::Here '''document''' will represent the active document, and is of type '''DocumentAPI'''


void '''setLayerOutlined'''(QString layer, bool outline)
====activeWindow====
:This property return '''WindowAPI''' object.


void '''setLayerFlow'''(QString layer, bool flow)
:Usage:
::''window = Scripter.activeWindow''


void '''setLayerBlendmode'''(QString layer, int blend)
:: Here, '''window''' will represent the active window, and is of type '''WindowAPI'''. See WindowAPI for methods and properties available for this object.
====colors====
:This property will return a '''list''' of default colors in Scribus, each color as an object of '''ScColorWrapper'''.


void '''setLayerTransparency'''(QString layer, int trans)
:Usage:
::''colors = Scripter.colors''
::''for i in colors:''
:::''print i.name''
:Result:
:::''Black''
:::''Blue''
:::''Cool Black''
:::''Cyan''
:::''Green''
:::''Magenta''
:::''Red''
:::''Registration''
:::''Rich Black''
:::''Warm Black''
:::''White''
:::''Yellow''
===Methods===
====openDocument====
====newDocument====


bool '''isLayerVisible'''(QString layer)
==Document API==
 
===Properties===
bool '''isLayerPrintable'''(QString layer)
====name====
====available====
====margins====
====modified====
====activePage====
====pageCount====
====activeItem====
====dimensions====
====items====
====selection====
====selectionCount====
====colors====
====layers====
====masterPages====
====styles====


bool '''isLayerLocked'''(QString layer)
===Methods===
* save
* saveAs(name)
* setInformation(author, title, comment)


bool '''isLayerOutlined'''(QString layer)
====Layer Methods in activeDocument====
* newLayer
* removeLayer
* getActiveLayer
* getActiveLayerName
* setActiveLayer


bool '''isLayerFlow'''(QString layer)
=====Color Methods in activeDocument=====
* newColorCMYK
* newColorRGB
* getColor


int '''getLayerBlendmode'''(QString layer)
=====Printer method =====
* Printer


double '''getLayerTransparency'''(QString layer)
=====Image Export methods=====
* supportedImageTypes
* exportAsImages


void '''deleteLayer'''(QString layer)
===Margins API===
====Properties====
* top
* left
* right
* bottom


void '''createLayer'''(QString name)
===Dimensions API===
 
====Properties====
==Object API==
* width
* height


===Page API===
====Properties====
* number
* items
* position
* selection
====Methods====
* newRectangle
* newEllipse
* newImage
* newText
* newLine
* placeSVG
* placeODG
* placeEPS
* placeSXD
* savePageAsEPS


QString '''createRect'''(double x, double y, double width, double height, QString name);
===Layer API===
QString '''createEllipse'''(double x, double y, double width, double height, QString name);
====Properties====
QString '''createImage'''(double x, double y, double width, double height, QString name);
* name
QString '''createText'''(double x, double y, double width, double height, QString name);
* id
    QString '''createTable'''(double x, double y, double width, double height, int numRows, int numColumns, QString name);
* level
    QString '''createLine'''(double x1, double y1, double x2, double y2, QString name);
* printable
    QString '''createPolyLine'''(QList<QVariant> list, QString name);
* viewable
    QString '''createPolygon'''(QList<QVariant> list, QString name);
* editable
    QString '''createBezierLine'''(QList<QVariant> list, QString name);
* flowControl
    QString '''createPathText'''(double x, double y, QString textbox, QString beziercurve, QString name);
* outlineMode
    void '''deleteObject'''(QString name);
* transparency
    void '''textFlowMode'''(QString name, int stat);
* blendMode
    bool '''objectExists'''(QString name);
* active
    void '''setStyle'''(QString style, QString name);
    QList<QVariant> '''getAllStyles'''();
    void '''duplicateObject'''(QString name);


    void '''moveObject'''(double dx, double dy, QString name);
===Color API===
    void '''moveObjectAbs'''(double x, double y, QString name);
====Properties====
    void '''rotateObject'''(double rot, QString name);
* name
    void '''rotateObjectAbs'''(double rot, QString name);
* spotColor
    void '''sizeObject'''(double width, double height, QString name);
====Methods====
    QString '''getSelectedObject'''(int nr);
* changeCMYK
    long '''selectionCount'''();
* changeRGB
    void '''selectObject'''(QString name);
* replace
    void '''deselectAll'''();
* remove
    QString '''groupObjects'''(QList<QVariant> list);
    void '''unGroupObjects'''(QString name);
    void '''scaleGroup'''(double factor, QString name);
    void '''loadImage'''(QString filename, QString name);
    void '''scaleImage'''(double x, double y, QString name);
    void '''setImageOffset'''(double x, double y, QString name);
    void '''setImageScale'''(double x, double y, QString name);
    void '''setImageBrightness'''(double n, QString name);
    void '''setImageGrayscale'''(QString name);
    bool '''lockObject'''(QString name);
    bool '''isLocked'''(QString name);
    void '''setScaleImageToFrame'''(bool scaletoframe, bool Proportional, QString name);
    void '''flipObject'''(bool h, bool v, QString name);
//Get Properties of objects.
QString '''getObjectType'''(QString name);
QString '''getFillColor'''(QString name);
double '''getFillTransparency'''(QString name);
int '''getBlendMode'''(QString name);
QString '''getLineColor'''(QString name);
double '''getLineTransparency'''(QString name);
int '''getLineBlendMode'''(QString name);
int '''getLineWidth'''(QString name);
int '''getLineShade'''(QString name);
int '''getLineJoin'''(QString name);
int '''getLineCap'''(QString name);
int '''getLineStyle'''(QString name);
int '''getFillShade'''(QString name);
int '''getCornerRadius'''(QString name);
QList<QVariant> '''getImageScale'''(QString name);
QString '''getImageName'''(QString name);
QList<QVariant> '''getPosition'''(QString name);
QList<QVariant> '''getSize'''(QString name);
int '''getRotation'''(QString name);
QList<QVariant> '''getAllObjects'''();


==Page API==
===Printer API===
==Color API==

Latest revision as of 10:00, 14 June 2013

Scripter2 API is described below. This is a reference for the actual documentation of new scripter.

See also rather : https://scribus-scripter.readthedocs.org/en/latest/

The new Scripter is composed of different modules, which are either accessible externally, or via methods of other apis.

Scripter

Properties

activeDocument

This property return DocumentAPI object.
Usage:
document = Scripter.activeDocument
Here document will represent the active document, and is of type DocumentAPI

activeWindow

This property return WindowAPI object.
Usage:
window = Scripter.activeWindow
Here, window will represent the active window, and is of type WindowAPI. See WindowAPI for methods and properties available for this object.

colors

This property will return a list of default colors in Scribus, each color as an object of ScColorWrapper.
Usage:
colors = Scripter.colors
for i in colors:
print i.name
Result:
Black
Blue
Cool Black
Cyan
Green
Magenta
Red
Registration
Rich Black
Warm Black
White
Yellow

Methods

openDocument

newDocument

Document API

Properties

name

available

margins

modified

activePage

pageCount

activeItem

dimensions

items

selection

selectionCount

colors

layers

masterPages

styles

Methods

  • save
  • saveAs(name)
  • setInformation(author, title, comment)

Layer Methods in activeDocument

  • newLayer
  • removeLayer
  • getActiveLayer
  • getActiveLayerName
  • setActiveLayer
Color Methods in activeDocument
  • newColorCMYK
  • newColorRGB
  • getColor
Printer method
  • Printer
Image Export methods
  • supportedImageTypes
  • exportAsImages

Margins API

Properties

  • top
  • left
  • right
  • bottom

Dimensions API

Properties

  • width
  • height

Page API

Properties

  • number
  • items
  • position
  • selection

Methods

  • newRectangle
  • newEllipse
  • newImage
  • newText
  • newLine
  • placeSVG
  • placeODG
  • placeEPS
  • placeSXD
  • savePageAsEPS

Layer API

Properties

  • name
  • id
  • level
  • printable
  • viewable
  • editable
  • flowControl
  • outlineMode
  • transparency
  • blendMode
  • active

Color API

Properties

  • name
  • spotColor

Methods

  • changeCMYK
  • changeRGB
  • replace
  • remove

Printer API