Back to index

scribus-ng  1.3.4.dfsg+svn20071115
cmdgetprop.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 CMDGETPROP_H
00008 #define CMDGETPROP_H
00009 
00010 // Pulls in <Python.h> first
00011 #include "cmdvar.h"
00012 
00016 PyDoc_STRVAR(scribus_getfillcolor__doc__,
00017 QT_TR_NOOP("getFillColor([\"name\"]) -> string\n\
00018 \n\
00019 Returns the name of the fill color of the object \"name\".\n\
00020 If \"name\" is not given the currently selected item is used.\n\
00021 "));
00023 PyObject *scribus_getfillcolor(PyObject */*self*/, PyObject* args);
00024 
00026 PyDoc_STRVAR(scribus_getfilltrans__doc__,
00027 QT_TR_NOOP("getFillTransparency([\"name\"]) -> float\n\
00028 \n\
00029 Returns the fill transparency of the object \"name\". If \"name\"\n\
00030 is not given the currently selected Item is used.\n\
00031 "));
00033 PyObject *scribus_getfilltrans(PyObject */*self*/, PyObject* args);
00034 
00036 PyDoc_STRVAR(scribus_getfillblend__doc__,
00037 QT_TR_NOOP("getFillBlendmode([\"name\"]) -> integer\n\
00038 \n\
00039 Returns the fill blendmode of the object \"name\". If \"name\"\n\
00040 is not given the currently selected Item is used.\n\
00041 "));
00043 PyObject *scribus_getfillblend(PyObject */*self*/, PyObject* args);
00044 
00046 PyDoc_STRVAR(scribus_getlinecolor__doc__,
00047 QT_TR_NOOP("getLineColor([\"name\"]) -> string\n\
00048 \n\
00049 Returns the name of the line color of the object \"name\".\n\
00050 If \"name\" is not given the currently selected item is used.\n\
00051 "));
00053 PyObject *scribus_getlinecolor(PyObject */*self*/, PyObject* args);
00054 
00056 PyDoc_STRVAR(scribus_getlinetrans__doc__,
00057 QT_TR_NOOP("getLineTransparency([\"name\"]) -> float\n\
00058 \n\
00059 Returns the line transparency of the object \"name\". If \"name\"\n\
00060 is not given the currently selected Item is used.\n\
00061 "));
00063 PyObject *scribus_getlinetrans(PyObject */*self*/, PyObject* args);
00064 
00066 PyDoc_STRVAR(scribus_getlineblend__doc__,
00067 QT_TR_NOOP("getLineBlendmode([\"name\"]) -> integer\n\
00068 \n\
00069 Returns the line blendmode of the object \"name\". If \"name\"\n\
00070 is not given the currently selected Item is used.\n\
00071 "));
00073 PyObject *scribus_getlineblend(PyObject */*self*/, PyObject* args);
00074 
00076 PyDoc_STRVAR(scribus_getlinewidth__doc__,
00077 QT_TR_NOOP("getLineWidth([\"name\"]) -> integer\n\
00078 \n\
00079 Returns the line width of the object \"name\". If \"name\"\n\
00080 is not given the currently selected Item is used.\n\
00081 "));
00083 PyObject *scribus_getlinewidth(PyObject */*self*/, PyObject* args);
00084 
00086 PyDoc_STRVAR(scribus_getlineshade__doc__,
00087 QT_TR_NOOP("getLineShade([\"name\"]) -> integer\n\
00088 \n\
00089 Returns the shading value of the line color of the object \"name\".\n\
00090 If \"name\" is not given the currently selected item is used.\n\
00091 "));
00093 PyObject *scribus_getlineshade(PyObject */*self*/, PyObject* args);
00094 
00096 PyDoc_STRVAR(scribus_getlinejoin__doc__,
00097 QT_TR_NOOP("getLineJoin([\"name\"]) -> integer (see contants)\n\
00098 \n\
00099 Returns the line join style of the object \"name\". If \"name\" is not given\n\
00100 the currently selected item is used.  The join types are:\n\
00101 JOIN_BEVEL, JOIN_MITTER, JOIN_ROUND\n\
00102 "));
00104 PyObject *scribus_getlinejoin(PyObject */*self*/, PyObject* args);
00105 
00107 PyDoc_STRVAR(scribus_getlineend__doc__,
00108 QT_TR_NOOP("getLineEnd([\"name\"]) -> integer (see constants)\n\
00109 \n\
00110 Returns the line cap style of the object \"name\". If \"name\" is not given the\n\
00111 currently selected item is used. The cap types are:\n\
00112 CAP_FLAT, CAP_ROUND, CAP_SQUARE\n\
00113 "));
00115 PyObject *scribus_getlineend(PyObject */*self*/, PyObject* args);
00116 
00118 PyDoc_STRVAR(scribus_getlinestyle__doc__,
00119 QT_TR_NOOP("getLineStyle([\"name\"]) -> integer (see constants)\n\
00120 \n\
00121 Returns the line style of the object \"name\". If \"name\" is not given the\n\
00122 currently selected item is used. Line style constants are:\n\
00123 LINE_DASH, LINE_DASHDOT, LINE_DASHDOTDOT, LINE_DOT, LINE_SOLID\n\
00124 "));
00126 PyObject *scribus_getlinestyle(PyObject */*self*/, PyObject* args);
00127 
00129 PyDoc_STRVAR(scribus_getfillshade__doc__,
00130 QT_TR_NOOP("getFillShade([\"name\"]) -> integer\n\
00131 \n\
00132 Returns the shading value of the fill color of the object \"name\".\n\
00133 If \"name\" is not given the currently selected item is used.\n\
00134 "));
00136 PyObject *scribus_getfillshade(PyObject */*self*/, PyObject* args);
00137 
00139 PyDoc_STRVAR(scribus_getcornerrad__doc__,
00140 QT_TR_NOOP("getCornerRadius([\"name\"]) -> integer\n\
00141 \n\
00142 Returns the corner radius of the object \"name\". The radius is\n\
00143 expressed in points. If \"name\" is not given the currently\n\
00144 selected item is used.\n\
00145 "));
00147 PyObject *scribus_getcornerrad(PyObject */*self*/, PyObject* args);
00148 
00150 PyDoc_STRVAR(scribus_getimgscale__doc__,
00151 QT_TR_NOOP("getImageScale([\"name\"]) -> (x,y)\n\
00152 \n\
00153 Returns a (x, y) tuple containing the scaling values of the image frame\n\
00154 \"name\".  If \"name\" is not given the currently selected item is used.\n\
00155 "));
00157 PyObject *scribus_getimgscale(PyObject */*self*/, PyObject* args);
00158 
00160 PyDoc_STRVAR(scribus_getimgname__doc__,
00161 QT_TR_NOOP("getImageName([\"name\"]) -> string\n\
00162 \n\
00163 Returns the filename for the image in the image frame. If \"name\" is not\n\
00164 given the currently selected item is used.\n\
00165 "));
00167 PyObject *scribus_getimgname(PyObject */*self*/, PyObject* args);
00168 
00170 PyDoc_STRVAR(scribus_getposi__doc__,
00171 QT_TR_NOOP("getPosition([\"name\"]) -> (x,y)\n\
00172 \n\
00173 Returns a (x, y) tuple with the position of the object \"name\".\n\
00174 If \"name\" is not given the currently selected item is used.\n\
00175 The position is expressed in the actual measurement unit of the document\n\
00176 - see UNIT_<type> for reference.\n\
00177 "));
00179 PyObject *scribus_getposi(PyObject */*self*/, PyObject* args);
00180 
00182 PyDoc_STRVAR(scribus_getsize__doc__,
00183 QT_TR_NOOP("getSize([\"name\"]) -> (width,height)\n\
00184 \n\
00185 Returns a (width, height) tuple with the size of the object \"name\".\n\
00186 If \"name\" is not given the currently selected item is used. The size is\n\
00187 expressed in the current measurement unit of the document - see UNIT_<type>\n\
00188 for reference.\n\
00189 "));
00191 PyObject *scribus_getsize(PyObject */*self*/, PyObject* args);
00192 
00194 PyDoc_STRVAR(scribus_getrotation__doc__,
00195 QT_TR_NOOP("getRotation([\"name\"]) -> integer\n\
00196 \n\
00197 Returns the rotation of the object \"name\". The value is expressed in degrees,\n\
00198 and clockwise is positive. If \"name\" is not given the currently selected item\n\
00199 is used.\n\
00200 "));
00202 PyObject *scribus_getrotation(PyObject */*self*/, PyObject* args);
00203 
00205 PyDoc_STRVAR(scribus_getallobj__doc__,
00206 QT_TR_NOOP("getAllObjects() -> list\n\
00207 \n\
00208 Returns a list containing the names of all objects on the current page.\n\
00209 "));
00211 PyObject *scribus_getallobj(PyObject */*self*/, PyObject* args);
00212 
00213 #endif
00214