Scripter2 API: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
No edit summary
(link to https://scribus-scripter.readthedocs.org/en/latest/)
 
(8 intermediate revisions by one other user not shown)
Line 1: Line 1:
Scripter2 API is described below. This is a reference for the actual documentation of new scripter.  
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.
The new Scripter is composed of different modules, which are either accessible externally, or via methods of other apis.


* Scripter (Main API)
==Scripter==
* Document API
===<u>Properties</u>===
* Page API
====activeDocument====
* Color API
 
* Layer API
:This property return '''DocumentAPI''' object.
* Printer API
* PDF File API
* Text API
* Dialogs API
* Preferences API
* Window API


===Scripter===
:Usage:
====Properties====
=====activeDocument=====


This property return '''DocumentAPI''' object.
::''document = Scripter.activeDocument''


Usage:  
::Here '''document''' will represent the active document, and is of type '''DocumentAPI'''


document = Scripter.activeDocument
====activeWindow====
:This property return '''WindowAPI''' object.


Here '''document''' will represent the active document, and is of type '''DocumentAPI'''
:Usage:
::''window = Scripter.activeWindow''


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


====Methods====
:Usage:
=====openDocument=====
::''colors = Scripter.colors''
=====newDocument=====
::''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===
==Document API==
====Properties====
===Properties===
=====name=====
====name====
=====available=====
====available====
=====margins=====
====margins====
===== modified=====
====modified====
* activePage
====activePage====
* pageCount
====pageCount====
* activeItem
====activeItem====
* dimensions
====dimensions====
* items
====items====
* selection
====selection====
* selectionCount
====selectionCount====
* colors
====colors====
* layers
====layers====
* masterPages
====masterPages====
* styles
====styles====


====Methods====
===Methods===
* save
* save
* saveAs(name)
* saveAs(name)
* setInformation(author, title, comment)
* setInformation(author, title, comment)


=====Layer Methods in activeDocument=====
====Layer Methods in activeDocument====
* newLayer
* newLayer
* removeLayer
* removeLayer

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

Retrieved from "https://wiki.scribus.net/wiki/index.php?title=Scripter2_API&oldid=28743"