Scripter2 API: Difference between revisions

From Scribus Wiki
Jump to navigation Jump to search
No edit summary
Line 17: Line 17:
===Scripter===
===Scripter===
====Properties====
====Properties====
* activeDocument
=====activeDocument


This property return '''DocumentAPI''' object.
This property return '''DocumentAPI''' object.
Line 27: Line 27:
Here '''document''' will represent the active document, and is of type '''DocumentAPI'''
Here '''document''' will represent the active document, and is of type '''DocumentAPI'''


* activeWindow
=====activeWindow=====
* colors
=====colors=====


====Methods====
====Methods====
* openDocument
=====openDocument=====
* newDocument
=====newDocument=====


===Document API===
===Document API===
====Properties====
====Properties====
* name
=====name=====
* available
=====available=====
* margins
=====margins=====
* modified
===== modified=====
* activePage
* activePage
* pageCount
* pageCount

Revision as of 08:40, 19 August 2011

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

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

  • Scripter (Main API)
  • Document API
  • Page API
  • Color API
  • Layer API
  • Printer API
  • PDF File API
  • Text API
  • Dialogs API
  • Preferences API
  • Window API

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
colors

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