Scribus
Open source desktop publishing at your fingertips
cmdcell.h
1 /*
2  * Copyright (C) 2011 Elvis Stansvik <elvstone@gmail.com>
3  *
4  * For general Scribus (>=1.3.2) copyright and licensing information please refer
5  * to the COPYING file provided with the program. Following this notice may exist
6  * a copyright and/or license notice that predates the release of Scribus 1.3.2
7  * for which a new license (GPL+exception) is in place.
8  */
9 
10 // Pulls in <Python.h> first
11 #include "cmdvar.h"
12 
15 #ifndef CMDCELL_H
16 #define CMDCELL_H
17 
19 PyDoc_STRVAR(scribus_setcelltext__doc__,
20 QT_TR_NOOP("setCellText(row, column, text, [\"name\"])\n\
21 \n\
22 Sets the text of the cell at \"row\", \"column\" in the table \"name\" to \"text\".\n\
23 If \"name\" is not given the currently selected item is used.\n\
24 \n\
25 May throw ValueError if the cell does not exist.\n\
26 "));
28 PyObject *scribus_setcelltext(PyObject * /*self*/, PyObject* args);
29 
31 PyDoc_STRVAR(scribus_getcellstyle__doc__,
32 QT_TR_NOOP("getCellStyle(row, column, [\"name\"]) -> string\n\
33 \n\
34 Returns the named style of the cell at \"row\", \"column\" in the table \"name\".\n\
35 If \"name\" is not given the currently selected item is used.\n\
36 \n\
37 May throw ValueError if the cell does not exist.\n\
38 "));
40 PyObject *scribus_getcellstyle(PyObject * /*self*/, PyObject* args);
41 
43 PyDoc_STRVAR(scribus_setcellstyle__doc__,
44 QT_TR_NOOP("setCellStyle(row, column, style, [\"name\"])\n\
45 \n\
46 Sets the named style of the cell at \"row\", \"column\" in the table \"name\" to \"style\".\n\
47 If \"name\" is not given the currently selected item is used.\n\
48 \n\
49 May throw ValueError if the cell does not exist.\n\
50 "));
52 PyObject *scribus_setcellstyle(PyObject * /*self*/, PyObject* args);
53 
55 PyDoc_STRVAR(scribus_getcellrowspan__doc__,
56 QT_TR_NOOP("getCellRowSpan(row, column, [\"name\"]) -> int\n\
57 \n\
58 Returns the row span of the cell at \"row\", \"column\" in the table \"name\" or -1 if the\n\
59 cell does not exist. If the cell is covered by another spanning cell, the row span of the\n\
60 spanning cell is returned. If \"name\" is not given the currently selected item is used.\n\
61 "));
63 PyObject *scribus_getcellrowspan(PyObject * /*self*/, PyObject* args);
64 
66 PyDoc_STRVAR(scribus_getcellcolumnspan__doc__,
67 QT_TR_NOOP("getCellColumnSpan(row, column, [\"name\"]) -> int\n\
68 \n\
69 Returns the column span of the cell at \"row\", \"column\" in the table \"name\" or -1 if the\n\
70 cell does not exist. If the cell is covered by another spanning cell, the column span of the\n\
71 spanning cell is returned. If \"name\" is not given the currently selected item is used.\n\
72 "));
74 PyObject *scribus_getcellcolumnspan(PyObject * /*self*/, PyObject* args);
75 
77 PyDoc_STRVAR(scribus_getcellfillcolor__doc__,
78 QT_TR_NOOP("getCellFillColor(row, column, [\"name\"]) -> string\n\
79 \n\
80 Returns the fill color of the cell at \"row\", \"column\" in the table \"name\"\n\
81 If \"name\" is not given the currently selected item is used.\n\
82 "));
84 PyObject *scribus_getcellfillcolor(PyObject * /*self*/, PyObject* args);
85 
87 PyDoc_STRVAR(scribus_setcellfillcolor__doc__,
88 QT_TR_NOOP("setCellFillColor(row, column, color, [\"name\"])\n\
89 \n\
90 Sets the fill color of the cell at \"row\", \"column\" in the table \"name\"\n\
91 to \"color\". If \"name\" is not given the currently selected item is used.\n\
92 \n\
93 May throw ValueError the cell does not exist.\n\
94 "));
96 PyObject *scribus_setcellfillcolor(PyObject * /*self*/, PyObject* args);
97 
99 PyDoc_STRVAR(scribus_setcellleftborder__doc__,
100 QT_TR_NOOP("setCellLeftBorder(row, column, borderLines, [\"name\"])\n\
101 \n\
102 Sets the left border of the cell at \"row\", \"column\" in the table \"name\".\n\
103 The border is specified as a list of \"(width, style, color)\" tuples.\n\
104 \"style\" is one of the LINE_* constants. If \"name\" is not given\n\
105 the currently selected item is used.\n\
106 \n\
107 May throw ValueError the cell does not exist or if \"borderLines\" is of the wrong format.\n\
108 "));
110 PyObject *scribus_setcellleftborder(PyObject * /*self*/, PyObject* args);
111 
113 PyDoc_STRVAR(scribus_setcellrightborder__doc__,
114 QT_TR_NOOP("setCellRightBorder(row, column, borderLines, [\"name\"])\n\
115 \n\
116 Sets the right border of the cell at \"row\", \"column\" in the table \"name\".\n\
117 The border is specified as a list of \"(width, style, color)\" tuples.\n\
118 \"style\" is one of the LINE_* constants. If \"name\" is not given\n\
119 the currently selected item is used.\n\
120 \n\
121 May throw ValueError the cell does not exist or if \"borderLines\" is of the wrong format.\n\
122 "));
124 PyObject *scribus_setcellrightborder(PyObject * /*self*/, PyObject* args);
125 
127 PyDoc_STRVAR(scribus_setcelltopborder__doc__,
128 QT_TR_NOOP("setCellTopBorder(row, column, borderLines, [\"name\"])\n\
129 \n\
130 Sets the top border of the cell at \"row\", \"column\" in the table \"name\".\n\
131 The border is specified as a list of \"(width, style, color)\" tuples.\n\
132 \"style\" is one of the LINE_* constants. If \"name\" is not given\n\
133 the currently selected item is used.\n\
134 \n\
135 May throw ValueError the cell does not exist or if \"borderLines\" is of the wrong format.\n\
136 "));
138 PyObject *scribus_setcelltopborder(PyObject * /*self*/, PyObject* args);
139 
141 PyDoc_STRVAR(scribus_setcellbottomborder__doc__,
142 QT_TR_NOOP("setCellBottomBorder(row, column, borderLines, [\"name\"])\n\
143 \n\
144 Sets the bottom border of the cell at \"row\", \"column\" in the table \"name\".\n\
145 The border is specified as a list of \"(width, style, color)\" tuples.\n\
146 \"style\" is one of the LINE_* constants. If \"name\" is not given\n\
147 the currently selected item is used.\n\
148 \n\
149 May throw ValueError the cell does not exist or if \"borderLines\" is of the wrong format.\n\
150 "));
152 PyObject *scribus_setcellbottomborder(PyObject * /*self*/, PyObject* args);
153 
155 PyDoc_STRVAR(scribus_setcellleftpadding__doc__,
156 QT_TR_NOOP("setCellLeftPadding(row, column, padding, [\"name\"])\n\
157 \n\
158 Sets the left padding of the cell at \"row\", \"column\" in the table \"name\"\n\
159 to \"padding\". If \"name\" is not given the currently selected item is used.\n\
160 \n\
161 May throw ValueError the cell does not exist or if \"padding\" less than 0.\n\
162 "));
164 PyObject *scribus_setcellleftpadding(PyObject * /*self*/, PyObject* args);
165 
167 PyDoc_STRVAR(scribus_setcellrightpadding__doc__,
168 QT_TR_NOOP("setCellRightPadding(row, column, padding, [\"name\"])\n\
169 \n\
170 Sets the right padding of the cell at \"row\", \"column\" in the table \"name\"\n\
171 to \"padding\". If \"name\" is not given the currently selected item is used.\n\
172 \n\
173 May throw ValueError the cell does not exist or if \"padding\" less than 0.\n\
174 "));
176 PyObject *scribus_setcellrightpadding(PyObject * /*self*/, PyObject* args);
177 
179 PyDoc_STRVAR(scribus_setcelltoppadding__doc__,
180 QT_TR_NOOP("setCellTopPadding(row, column, padding, [\"name\"])\n\
181 \n\
182 Sets the top padding of the cell at \"row\", \"column\" in the table \"name\"\n\
183 to \"padding\". If \"name\" is not given the currently selected item is used.\n\
184 \n\
185 May throw ValueError the cell does not exist or if \"padding\" is less than 0.\n\
186 "));
188 PyObject *scribus_setcelltoppadding(PyObject * /*self*/, PyObject* args);
189 
191 PyDoc_STRVAR(scribus_setcellbottompadding__doc__,
192 QT_TR_NOOP("setCellBottomPadding(row, column, padding, [\"name\"])\n\
193 \n\
194 Sets the bottom padding of the cell at \"row\", \"column\" in the table \"name\"\n\
195 to \"padding\". If \"name\" is not given the currently selected item is used.\n\
196 \n\
197 May throw ValueError the cell does not exist or if \"padding\" is less than 0.\n\
198 "));
200 PyObject *scribus_setcellbottompadding(PyObject * /*self*/, PyObject* args);
201 
202 #endif // CMDCELL_H