Back to index

scribus-ng  1.3.4.dfsg+svn20071115
cmdmani.h
Go to the documentation of this file.
00001 /*
00002 For general Scribus (>=1.3.2) copyright and licensing information please refer
00003 to the COPYING file provided with the program. Following this notice may exist
00004 a copyright and/or license notice that predates the release of Scribus 1.3.2
00005 for which a new license (GPL+exception) is in place.
00006 */
00007 #ifndef CMDMANI_H
00008 #define CMDMANI_H
00009 
00010 // Pulls in <Python.h> first
00011 #include "cmdvar.h"
00012 
00016 PyDoc_STRVAR(scribus_moveobjrel__doc__,
00017 QT_TR_NOOP("moveObject(dx, dy [, \"name\"])\n\
00018 \n\
00019 Moves the object \"name\" by dx and dy relative to its current position. The\n\
00020 distances are expressed in the current measurement unit of the document (see\n\
00021 UNIT constants). If \"name\" is not given the currently selected item is used.\n\
00022 If the object \"name\" belongs to a group, the whole group is moved.\n\
00023 "));
00025 PyObject *scribus_moveobjrel(PyObject */*self*/, PyObject* args);
00026 
00028 PyDoc_STRVAR(scribus_moveobjabs__doc__,
00029 QT_TR_NOOP("moveObjectAbs(x, y [, \"name\"])\n\
00030 \n\
00031 Moves the object \"name\" to a new location. The coordinates are expressed in\n\
00032 the current measurement unit of the document (see UNIT constants).  If \"name\"\n\
00033 is not given the currently selected item is used.  If the object \"name\"\n\
00034 belongs to a group, the whole group is moved.\n\
00035 "));
00037 PyObject *scribus_moveobjabs(PyObject */*self*/, PyObject* args);
00038 
00040 PyDoc_STRVAR(scribus_rotobjrel__doc__,
00041 QT_TR_NOOP("rotateObject(rot [, \"name\"])\n\
00042 \n\
00043 Rotates the object \"name\" by \"rot\" degrees relatively. The object is\n\
00044 rotated by the vertex that is currently selected as the rotation point - by\n\
00045 default, the top left vertext at zero rotation. Positive values mean counter\n\
00046 clockwise rotation when the default rotation point is used. If \"name\" is not\n\
00047 given the currently selected item is used.\n\
00048 "));
00050 PyObject *scribus_rotobjrel(PyObject */*self*/, PyObject* args);
00051 
00053 PyDoc_STRVAR(scribus_rotobjabs__doc__,
00054 QT_TR_NOOP("rotateObjectAbs(rot [, \"name\"])\n\
00055 \n\
00056 Sets the rotation of the object \"name\" to \"rot\". Positive values\n\
00057 mean counter clockwise rotation. If \"name\" is not given the currently\n\
00058 selected item is used.\n\
00059 "));
00061 PyObject *scribus_rotobjabs(PyObject */*self*/, PyObject* args);
00062 
00064 PyDoc_STRVAR(scribus_sizeobjabs__doc__,
00065 QT_TR_NOOP("sizeObject(width, height [, \"name\"])\n\
00066 \n\
00067 Resizes the object \"name\" to the given width and height. If \"name\"\n\
00068 is not given the currently selected item is used.\n\
00069 "));
00071 PyObject *scribus_sizeobjabs(PyObject */*self*/, PyObject* args);
00072 
00074 PyDoc_STRVAR(scribus_getselobjnam__doc__,
00075 QT_TR_NOOP("getSelectedObject([nr]) -> string\n\
00076 \n\
00077 Returns the name of the selected object. \"nr\" if given indicates the number\n\
00078 of the selected object, e.g. 0 means the first selected object, 1 means the\n\
00079 second selected Object and so on.\n\
00080 "));
00082 PyObject *scribus_getselobjnam(PyObject */*self*/, PyObject* args);
00083 
00085 PyDoc_STRVAR(scribus_selcount__doc__,
00086 QT_TR_NOOP("selectionCount() -> integer\n\
00087 \n\
00088 Returns the number of selected objects.\n\
00089 "));
00091 PyObject *scribus_selcount(PyObject */*self*/);
00092 
00094 PyDoc_STRVAR(scribus_selectobj__doc__,
00095 QT_TR_NOOP("selectObject(\"name\")\n\
00096 \n\
00097 Selects the object with the given \"name\".\n\
00098 "));
00100 PyObject *scribus_selectobj(PyObject */*self*/, PyObject* args);
00101 
00103 PyDoc_STRVAR(scribus_deselect__doc__,
00104 QT_TR_NOOP("deselectAll()\n\
00105 \n\
00106 Deselects all objects in the whole document.\n\
00107 "));
00109 PyObject *scribus_deselect(PyObject */*self*/);
00110 
00112 PyDoc_STRVAR(scribus_groupobj__doc__,
00113 QT_TR_NOOP("groupObjects(list)\n\
00114 \n\
00115 Groups the objects named in \"list\" together. \"list\" must contain the names\n\
00116 of the objects to be grouped. If \"list\" is not given the currently selected\n\
00117 items are used.\n\
00118 "));
00120 PyObject *scribus_groupobj(PyObject */*self*/, PyObject* args);
00121 
00123 PyDoc_STRVAR(scribus_ungroupobj__doc__,
00124 QT_TR_NOOP("unGroupObjects(\"name\")\n\n\
00125 Destructs the group the object \"name\" belongs to.\
00126 If \"name\" is not given the currently selected item is used."));
00128 PyObject *scribus_ungroupobj(PyObject */*self*/, PyObject* args);
00129 
00131 PyDoc_STRVAR(scribus_scalegroup__doc__,
00132 QT_TR_NOOP("scaleGroup(factor [,\"name\"])\n\
00133 \n\
00134 Scales the group the object \"name\" belongs to. Values greater than 1 enlarge\n\
00135 the group, values smaller than 1 make the group smaller e.g a value of 0.5\n\
00136 scales the group to 50 % of its original size, a value of 1.5 scales the group\n\
00137 to 150 % of its original size.  The value for \"factor\" must be greater than\n\
00138 0. If \"name\" is not given the currently selected item is used.\n\
00139 \n\
00140 May raise ValueError if an invalid scale factor is passed.\n\
00141 "));
00143 PyObject *scribus_scalegroup(PyObject */*self*/, PyObject* args);
00144 
00146 PyDoc_STRVAR(scribus_loadimage__doc__,
00147 QT_TR_NOOP("loadImage(\"filename\" [, \"name\"])\n\
00148 \n\
00149 Loads the picture \"picture\" into the image frame \"name\". If \"name\" is\n\
00150 not given the currently selected item is used.\n\
00151 \n\
00152 May raise WrongFrameTypeError if the target frame is not an image frame\n\
00153 "));
00155 PyObject *scribus_loadimage(PyObject */*self*/, PyObject* args);
00156 
00158 PyDoc_STRVAR(scribus_scaleimage__doc__,
00159 QT_TR_NOOP("scaleImage(x, y [, \"name\"])\n\
00160 \n\
00161 Sets the scaling factors of the picture in the image frame \"name\".\n\
00162 If \"name\" is not given the currently selected item is used. A number of 1\n\
00163 means 100 %.\n\
00164 \n\
00165 May raise WrongFrameTypeError if the target frame is not an image frame\n\
00166 "));
00168 PyObject *scribus_scaleimage(PyObject */*self*/, PyObject* args);
00169 
00171 PyDoc_STRVAR(scribus_lockobject__doc__,
00172 QT_TR_NOOP("lockObject([\"name\"]) -> bool\n\
00173 \n\
00174 Locks the object \"name\" if it's unlocked or unlock it if it's locked.\n\
00175 If \"name\" is not given the currently selected item is used. Returns true\n\
00176 if locked.\n\
00177 "));
00179 PyObject *scribus_lockobject(PyObject */*self*/, PyObject* args);
00180 
00182 PyDoc_STRVAR(scribus_islocked__doc__,
00183 QT_TR_NOOP("isLocked([\"name\"]) -> bool\n\
00184 \n\
00185 Returns true if is the object \"name\" locked.  If \"name\" is not given the\n\
00186 currently selected item is used.\n\
00187 "));
00189 PyObject *scribus_islocked(PyObject */*self*/, PyObject* args);
00190 
00191 PyDoc_STRVAR(scribus_setscaleimagetoframe__doc__,
00192 QT_TR_NOOP("setScaleImageToFrame(scaletoframe, proportional=None, name=<selection>)\n\
00193 \n\
00194 Sets the scale to frame on the selected or specified image frame to `scaletoframe'.\n\
00195 If `proportional' is specified, set fixed aspect ratio scaling to `proportional'.\n\
00196 Both `scaletoframe' and `proportional' are boolean.\n\
00197 \n\
00198 May raise WrongFrameTypeError.\n\
00199 "));
00200 PyObject *scribus_setscaleimagetoframe(PyObject */*self*/, PyObject* args, PyObject* kwargs);
00201 
00202 #endif