Scripter2 API

From Scribus Wiki
Revision as of 12:08, 13 August 2011 by Jainbasil1 (talk | contribs)
Jump to navigation Jump to search

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
  • activeWindow
  • colors

Methods

  • openDocument
  • newDocument

Document API

Properties

  • available
  • margins
  • modified
  • activePage
  • pageCount
  • activeItem
  • dimensions
  • items
  • selection
  • colors
  • layers

Methods

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