1 files changed, 263 insertions, 0 deletions
diff --git a/scribus/plugins/scriptplugin/cmdobj.h b/scribus/plugins/scriptplugin/cmdobj.h
new file mode 100644
index 0000000..d44ac6f
--- /dev/null
+++ b/scribus/plugins/scriptplugin/cmdobj.h
@@ -0,0 +1,263 @@
+/*
+For general Scribus (>=1.3.2) copyright and licensing information please refer
+to the COPYING file provided with the program. Following this notice may exist
+a copyright and/or license notice that predates the release of Scribus 1.3.2
+for which a new license (GPL+exception) is in place.
+*/
+#ifndef CMDOBJ_H
+#define CMDOBJ_H
+
+// Pulls in <Python.h> first
+#include "cmdvar.h"
+
+/** Object related Commands */
+
+/*! docstring */
+PyDoc_STRVAR(scribus_newrect__doc__,
+QT_TR_NOOP("createRect(x, y, width, height, [\"name\"]) -> string\n\
+\n\
+Creates a new rectangle on the current page and returns its name. The\n\
+coordinates are given in the current measurement units of the document\n\
+(see UNIT constants). \"name\" should be a unique identifier for the object\n\
+because you need this name to reference that object in future. If \"name\"\n\
+is not given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+"));
+/** Creates a rectangular with params X, Y (base position)
+ b, h (width, height) and optional name of the object.
+ */
+PyObject *scribus_newrect(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_newellipse__doc__,
+QT_TR_NOOP("createEllipse(x, y, width, height, [\"name\"]) -> string\n\
+\n\
+Creates a new ellipse on the current page and returns its name.\n\
+The coordinates are given in the current measurement units of the document\n\
+(see UNIT constants). \"name\" should be a unique identifier for the object\n\
+because you need this name for further referencing of that object. If \"name\"\n\
+is not given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+"));
+/** Creates an ellipse with x, y, b and h - name optionally
+ params.
+ */
+PyObject *scribus_newellipse(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_newimage__doc__,
+QT_TR_NOOP("createImage(x, y, width, height, [\"name\"]) -> string\n\
+\n\
+Creates a new picture frame on the current page and returns its name. The\n\
+coordinates are given in the current measurement units of the document.\n\
+\"name\" should be a unique identifier for the object because you need this\n\
+name for further access to that object. If \"name\" is not given Scribus will\n\
+create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+"));
+/** Creates an image frame - x, y, b, h and opt. name. */
+PyObject *scribus_newimage(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_newtext__doc__,
+QT_TR_NOOP("createText(x, y, width, height, [\"name\"]) -> string\n\
+\n\
+Creates a new text frame on the actual page and returns its name.\n\
+The coordinates are given in the actual measurement unit of the document (see\n\
+UNIT constants). \"name\" should be a unique identifier for the object because\n\
+you need this name for further referencing of that object. If \"name\" is not\n\
+given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+"));
+/** Creates a text frame - x, y, b, h and opt. name. */
+PyObject *scribus_newtext(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_newline__doc__,
+QT_TR_NOOP("createLine(x1, y1, x2, y2, [\"name\"]) -> string\n\
+\n\
+Creates a new line from the point(x1, y1) to the point(x2, y2) and returns\n\
+its name. The coordinates are given in the current measurement unit of the\n\
+document (see UNIT constants). \"name\" should be a unique identifier for the\n\
+object because you need this name for further access to that object. If\n\
+\"name\" is not given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+"));
+/** Creates a line object - x, y, b, h and opt. name. */
+PyObject *scribus_newline(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_polyline__doc__,
+QT_TR_NOOP("createPolyLine(list, [\"name\"]) -> string\n\
+\n\
+Creates a new polyline and returns its name. The points for the polyline are\n\
+stored in the list \"list\" in the following order: [x1, y1, x2, y2...xn. yn].\n\
+The coordinates are given in the current measurement units of the document (see\n\
+UNIT constants). \"name\" should be a unique identifier for the object because\n\
+you need this name for further access to that object. If \"name\" is not given\n\
+Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+May raise ValueError if an insufficient number of points is passed or if\n\
+the number of values passed don't group into points without leftovers.\n\
+"));
+/** Creates a polygon line - list with points and opt. name as params. */
+PyObject *scribus_polyline(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_polygon__doc__,
+QT_TR_NOOP("createPolygon(list, [\"name\"]) -> string\n\
+\n\
+Creates a new polygon and returns its name. The points for the polygon are\n\
+stored in the list \"list\" in the following order: [x1, y1, x2, y2...xn. yn].\n\
+At least three points are required. There is no need to repeat the first point\n\
+to close the polygon. The polygon is automatically closed by connecting the\n\
+first and the last point.  The coordinates are given in the current measurement\n\
+units of the document (see UNIT constants).  \"name\" should be a unique\n\
+identifier for the object because you need this name for further access to that\n\
+object. If \"name\" is not given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+May raise ValueError if an insufficient number of points is passed or if\n\
+the number of values passed don't group into points without leftovers.\n\
+"));
+/** Creates a polygon - list with points and opt. name as params. */
+PyObject *scribus_polygon(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_bezierline__doc__,
+QT_TR_NOOP("createBezierLine(list, [\"name\"]) -> string\n\
+\n\
+Creates a new bezier curve and returns its name. The points for the bezier\n\
+curve are stored in the list \"list\" in the following order:\n\
+[x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn]\n\
+In the points list, x and y mean the x and y coordinates of the point and kx\n\
+and ky meaning the control point for the curve.  The coordinates are given in\n\
+the current measurement units of the document (see UNIT constants). \"name\"\n\
+should be a unique identifier for the object because you need this name for\n\
+further access to that object. If \"name\" is not given Scribus will create one\n\
+for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+May raise ValueError if an insufficient number of points is passed or if\n\
+the number of values passed don't group into points without leftovers.\n\
+"));
+/** Creates a Bezier line - list with points and opt. name as params. */
+PyObject *scribus_bezierline(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_pathtext__doc__,
+QT_TR_NOOP("createPathText(x, y, \"textbox\", \"beziercurve\", [\"name\"]) -> string\n\
+\n\
+Creates a new pathText by merging the two objects \"textbox\" and\n\
+\"beziercurve\" and returns its name. The coordinates are given in the current\n\
+measurement unit of the document (see UNIT constants). \"name\" should be a\n\
+unique identifier for the object because you need this name for further access\n\
+to that object. If \"name\" is not given Scribus will create one for you.\n\
+\n\
+May raise NameExistsError if you explicitly pass a name that's already used.\n\
+May raise NotFoundError if one or both of the named base object don't exist.\n\
+"));
+/** Joins 2 objects - textframe and line - into text on path.
+ Uses x, y (base of the new object), name of the text frame,
+ name of the line and opt. new name as params. */
+PyObject *scribus_pathtext(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_deleteobj__doc__,
+QT_TR_NOOP("deleteObject([\"name\"])\n\
+\n\
+Deletes the item with the name \"name\". If \"name\" is not given the currently\n\
+selected item is deleted.\n\
+"));
+/** Deletes an object - if is the name given the named object is
+ deleted else the active object erased. */
+PyObject *scribus_deleteobj(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_textflow__doc__,
+QT_TR_NOOP("textFlowMode(\"name\" [, state])\n\
+\n\
+Enables/disables \"Text Flows Around Frame\" feature for object \"name\".\n\
+Called with parameters string name and optional int \"state\" (0 <= state <= 3).\n\
+Setting \"state\" to 0 will disable text flow.\n\
+Setting \"state\" to 1 will make text flow around object frame.\n\
+Setting \"state\" to 2 will make text flow around bounding box.\n\
+Setting \"state\" to 3 will make text flow around contour line.\n\
+If \"state\" is not passed, text flow is toggled.\n\
+"));
+/**
+Enables/disables "Text Flows Around Object" feature for object.
+Called with params string objectName and state 0|1|2|3.
+When set to 0 disable flowing, 1 text flows around frame, 
+2 around bounding box, 3 around contour line. When is second param
+empty flowing is reverted.
+02/28/2004 petr vanek
+ */
+PyObject *scribus_textflow(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_objectexists__doc__,
+QT_TR_NOOP("objectExists([\"name\"]) -> bool\n\
+\n\
+Test if an object with specified name really exists in the document.\n\
+The optional parameter is the object name. When no object name is given,\n\
+returns True if there is something selected.\n\
+"));
+/**
+User test if an object with specified name really exists in
+the doc. Object name as param.
+03/29/2004 petr vanek
+ObjectName is now optional. When none set, search for selection...
+07/11/2004 pv
+*/
+PyObject *scribus_objectexists(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_setstyle__doc__,
+QT_TR_NOOP("setStyle(\"style\" [, \"name\"])\n\
+\n\
+Apply the named \"style\" to the object named \"name\". If is no object name\n\
+given, it's applied on the selected object.\n\
+"));
+/**
+ Craig Ringer, 2004-09-09
+ Apply the named style to the currently selected object.
+ pv, 2004-09-13, optionaly param objectName + "check the page" stuff
+ */
+PyObject *scribus_setstyle(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_getstylenames__doc__,
+QT_TR_NOOP("getAllStyles() -> list\n\
+\n\
+Return a list of the names of all paragraph styles in the current document.\n\
+"));
+/**
+ Craig Ringer, 2004-09-09
+ Enumerate all known paragraph styles
+*/
+PyObject *scribus_getstylenames(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_duplicateobject__doc__,
+QT_TR_NOOP("duplicateObject([\"name\"]) -> string\n\
+\n\
+creates a Duplicate of the selected Object (or Selection Group).\n\
+"));
+/**
+ Christian Hausknecht, 2006-07-12
+ duplicate an object
+*/
+PyObject *scribus_duplicateobject(PyObject * /* self */, PyObject *args);
+
+/* Internal function not intended for general use; no docstring */
+PyObject* scribus_getframetype(PyObject* self, PyObject* args, PyObject* kw);
+
+#endif
+