Scripter2 API: Difference between revisions
Jainbasil1 (talk | contribs) |
Jainbasil1 (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
[[Category:Scribus]] | [[Category:Scribus]] | ||
==Document API== | ==Document API== | ||
Document | Document API is the primary access point to active document in Scribus. A DocumentAPI object may be created as '''Scripter.activeDocument'''. This will return an object of type DocumentAPI. The following methods/properties are available in DocumentAPI. | ||
==Layer API== | |||
==Object API== | |||
need changes! | |||
QString '''createRect'''(double x, double y, double width, double height, QString name); | QString '''createRect'''(double x, double y, double width, double height, QString name); | ||
Line 178: | Line 133: | ||
==Page API== | ==Page API== | ||
==Color API== | ==Color API== | ||
Revision as of 16:37, 26 July 2011
Document API
Document API is the primary access point to active document in Scribus. A DocumentAPI object may be created as Scripter.activeDocument. This will return an object of type DocumentAPI. The following methods/properties are available in DocumentAPI.
Layer API
Object API
need changes!
QString createRect(double x, double y, double width, double height, QString name);
QString createEllipse(double x, double y, double width, double height, QString name);
QString createImage(double x, double y, double width, double height, QString name);
QString createText(double x, double y, double width, double height, QString name);
QString createTable(double x, double y, double width, double height, int numRows, int numColumns, QString name);
QString createLine(double x1, double y1, double x2, double y2, QString name);
QString createPolyLine(QList<QVariant> list, QString name);
QString createPolygon(QList<QVariant> list, QString name);
QString createBezierLine(QList<QVariant> list, QString name);
QString createPathText(double x, double y, QString textbox, QString beziercurve, QString name);
void deleteObject(QString name);
void textFlowMode(QString name, int stat);
bool objectExists(QString name);
void setStyle(QString style, QString name);
QList<QVariant> getAllStyles();
void duplicateObject(QString name);
void moveObject(double dx, double dy, QString name);
void moveObjectAbs(double x, double y, QString name);
void rotateObject(double rot, QString name);
void rotateObjectAbs(double rot, QString name);
void sizeObject(double width, double height, QString name);
QString getSelectedObject(int nr);
long selectionCount();
void selectObject(QString name);
void deselectAll();
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);
Getter functions
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();