Branch 1.3.5 tree to 1.4.x tree, goodbye 1.3.x

git-svn-id: svn://scribus.net/branches/Version14x/Scribus@17163 11d20701-8431-0410-a711-e3c959e3b870

1 files changed, 353 insertions, 0 deletions

diff --git a/scribus/plugins/scriptplugin/cmdmisc.h b/scribus/plugins/scriptplugin/cmdmisc.h
new file mode 100644
index 0000000..48f857a
--- /dev/null
+++ b/scribus/plugins/scriptplugin/cmdmisc.h
@@ -0,0 +1,353 @@
+/*
+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 CMDMISC_H
+#define CMDMISC_H
+
+// Pulls in <Python.h> first
+#include "cmdvar.h"
+//Added by qt3to4:
+#include <QPixmap>
+
+/** Other Commands */
+
+/*! docstring */
+PyDoc_STRVAR(scribus_setredraw__doc__,
+QT_TR_NOOP("setRedraw(bool)\n\
+\n\
+Disables page redraw when bool = False, otherwise redrawing is enabled.\n\
+This change will persist even after the script exits, so make sure to call\n\
+setRedraw(True) in a finally: clause at the top level of your script.\n\
+"));
+/*! Enable/disable page redrawing. */
+PyObject *scribus_setredraw(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_fontnames__doc__,
+QT_TR_NOOP("getFontNames() -> list\n\
+\n\
+Returns a list with the names of all available fonts.\n\
+"));
+/*! simple list of font names. */
+PyObject *scribus_fontnames(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_xfontnames__doc__,
+QT_TR_NOOP("getXFontNames() -> list of tuples\n\
+\n\
+Returns a larger font info. It's a list of the tuples with:\n\
+[ (Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file), (...), ... ]\n\
+"));
+/*!
+ return a list of the tuples with
+ Scribus name, Family, Real name, subset (1|0), embed PS (1|0), font file
+*/
+PyObject *scribus_xfontnames(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_renderfont__doc__,
+QT_TR_NOOP("renderFont(\"name\", \"filename\", \"sample\", size, format=\"PPM\") -> bool\n\
+\n\
+Creates an image preview of font \"name\" with given text \"sample\" and size.\n\
+If \"filename\" is not \"\", image is saved into \"filename\". Otherwise\n\
+image data is returned as a string. The optional \"format\" argument\n\
+specifies the image format to generate, and supports any format allowed\n\
+by QPixmap.save(). Common formats are PPM, JPEG, PNG and XPM.\n\
+\n\
+May raise NotFoundError if the specified font can't be found.\n\
+May raise ValueError if an empty sample or filename is passed.\n\
+"));
+/*! Font example to image. */
+PyObject *scribus_renderfont(PyObject* /*self*/, PyObject* args, PyObject* kw);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_getlayers__doc__,
+QT_TR_NOOP("getLayers() -> list\n\
+\n\
+Returns a list with the names of all defined layers.\n\
+"));
+/*! List of the layers */
+PyObject *scribus_getlayers(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_setactlayer__doc__,
+QT_TR_NOOP("setActiveLayer(\"name\")\n\
+\n\
+Sets the active layer to the layer named \"name\".\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Move into layer */
+PyObject *scribus_setactlayer(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_getactlayer__doc__,
+QT_TR_NOOP("getActiveLayer() -> string\n\
+\n\
+Returns the name of the current active layer.\n\
+"));
+/*! Get layer name */
+PyObject *scribus_getactlayer(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_senttolayer__doc__,
+QT_TR_NOOP("sentToLayer(\"layer\" [, \"name\"])\n\
+\n\
+Sends the object \"name\" to the layer \"layer\". The layer must exist.\n\
+If \"name\" is not given the currently selected item is used.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Move object from one layer to other one */
+PyObject *scribus_senttolayer(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layervisible__doc__,
+QT_TR_NOOP("setLayerVisible(\"layer\", visible)\n\
+\n\
+Sets the layer \"layer\" to be visible or not. If is the visible set to false\n\
+the layer is invisible.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_layervisible(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layerprint__doc__,
+QT_TR_NOOP("setLayerPrintable(\"layer\", printable)\n\
+\n\
+Sets the layer \"layer\" to be printable or not. If is the\n\
+printable set to false the layer won't be printed.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layerprint(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layerlock__doc__,
+QT_TR_NOOP("setLayerLocked(\"layer\", locked)\n\
+\n\
+Sets the layer \"layer\" to be locked or not. If locked is set to\n\
+true the layer will be locked.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layerlock(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layeroutline__doc__,
+QT_TR_NOOP("setLayerOutlined(\"layer\", outline)\n\
+\n\
+Sets the layer \"layer\" to be locked or not. If outline is set to\n\
+true the layer will be displayed outlined.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layeroutline(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layerflow__doc__,
+QT_TR_NOOP("setLayerFlow(\"layer\", flow)\n\
+\n\
+Sets the layers \"layer\"  flowcontrol to flow. If flow is set to\n\
+true text in layers above this one will flow around objects on this layer.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layerflow(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layerblend__doc__,
+QT_TR_NOOP("setLayerBlendmode(\"layer\", blend)\n\
+\n\
+Sets the layers \"layer\"  blendmode to blend.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layerblend(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_layertrans__doc__,
+QT_TR_NOOP("setLayerTransparency(\"layer\", trans)\n\
+\n\
+Sets the layers \"layer\"  transparency to trans.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_layertrans(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayervisib__doc__,
+QT_TR_NOOP("isLayerVisible(\"layer\") -> bool\n\
+\n\
+Returns whether the layer \"layer\" is visible or not, a value of True means\n\
+that the layer \"layer\" is visible, a value of False means that the layer\n\
+\"layer\" is invisible.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayervisib(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayerprint__doc__,
+QT_TR_NOOP("isLayerPrintable(\"layer\") -> bool\n\
+\n\
+Returns whether the layer \"layer\" is printable or not, a value of True means\n\
+that the layer \"layer\" can be printed, a value of False means that printing\n\
+the layer \"layer\" is disabled.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer printable */
+PyObject *scribus_glayerprint(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayerlock__doc__,
+QT_TR_NOOP("isLayerLocked(\"layer\") -> bool\n\
+\n\
+Returns whether the layer \"layer\" is locked or not, a value of True means\n\
+that the layer \"layer\" is editable, a value of False means that the layer\n\
+\"layer\" is locked.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayerlock(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayeroutline__doc__,
+QT_TR_NOOP("isLayerOutlined(\"layer\") -> bool\n\
+\n\
+Returns whether the layer \"layer\" is outlined or not, a value of True means\n\
+that the layer \"layer\" is outlined, a value of False means that the layer\n\
+\"layer\" is normal.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayeroutline(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayerflow__doc__,
+QT_TR_NOOP("isLayerFlow(\"layer\") -> bool\n\
+\n\
+Returns whether text flows around objects on layer \"layer\", a value of True means\n\
+that text flows around, a value of False means that the text does not flow around.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayerflow(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayerblend__doc__,
+QT_TR_NOOP("getLayerBlendmode(\"layer\") -> int\n\
+\n\
+Returns the \"layer\" layer blendmode,\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayerblend(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_glayertrans__doc__,
+QT_TR_NOOP("getLayerTransparency(\"layer\") -> float\n\
+\n\
+Returns the \"layer\" layer transparency,\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Set layer visible */
+PyObject *scribus_glayertrans(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_removelayer__doc__,
+QT_TR_NOOP("deleteLayer(\"layer\")\n\
+\n\
+Deletes the layer with the name \"layer\". Nothing happens if the layer doesn't\n\
+exists or if it's the only layer in the document.\n\
+\n\
+May raise NotFoundError if the layer can't be found.\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! Remove layer */
+PyObject *scribus_removelayer(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_createlayer__doc__,
+QT_TR_NOOP("createLayer(layer)\n\
+\n\
+Creates a new layer with the name \"name\".\n\
+\n\
+May raise ValueError if the layer name isn't acceptable.\n\
+"));
+/*! New layer */
+PyObject *scribus_createlayer(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_filequit__doc__,
+QT_TR_NOOP("fileQuit()\n\
+\n\
+Quit Scribus.\n\
+"));
+/*! Quit Scribus */
+PyObject *scribus_filequit(PyObject * /*self*/, PyObject* args);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_getlanguage__doc__,
+QT_TR_NOOP("getGuiLanguage() -> string\n\
+\n\
+Returns a string with the -lang value.\n\
+"));
+/*! Language of the GUI */
+PyObject *scribus_getlanguage(PyObject * /*self*/);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_moveselectiontofront__doc__,
+QT_TR_NOOP("moveSelectionToFront()\n\
+\n\
+Moves current selection to front.\n\
+"));
+/*! 04.01.2007 : Joachim Neu : Moves item selection to front. */
+PyObject *scribus_moveselectiontofront(PyObject*);
+
+/*! docstring */
+PyDoc_STRVAR(scribus_moveselectiontoback__doc__,
+QT_TR_NOOP("moveSelectionToFront()\n\
+\n\
+Moves current selection to back.\n\
+"));
+/*! 04.01.2007 : Joachim Neu : Moves item selection to back. */
+PyObject *scribus_moveselectiontoback(PyObject*);
+
+#endif
+
+