Back to index

scribus-ng  1.3.4.dfsg+svn20071115
objimageexport.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 OBJIMGEXPORT_H
00008 #define OBJIMGEXPORT_H
00009 
00010 // Pulls in <Python.h> first
00011 #include "cmdvar.h"
00012 
00013 extern PyTypeObject ImageExport_Type;
00014 
00015 // docstrings
00016 PyDoc_STRVAR(imgexp__doc__,"Image export\n\
00017 \n\
00018 Class ImageExport() provides the bitmap graphics exporting\n\
00019 for Python scripting as you know it from Export/Save as Image\n\
00020 menu. See related class PDFfile() and procedure savePageAsEPS().\n\
00021 Example:\n\
00022 i = ImageExport()\n\
00023 i.type = 'PNG' # select one from i.allTypes list\n\
00024 i.scale = 200 # I want to have 200%\n\
00025 i.name = '/home/subik/test.png'\n\
00026 i.save()\n\
00027 \n\
00028 two last lines should be replaced with:\n\
00029 i.saveAs('/home/subik/test.png')");
00030 
00031 PyDoc_STRVAR(imgexp_dpi__doc__, "This value will be used for export as DPI. Read/write integer.");
00032 PyDoc_STRVAR(imgexp_scale__doc__, "This is the scaling of the image. 100 = 100% etc. Read/write iteger.");
00033 PyDoc_STRVAR(imgexp_quality__doc__, "Quality/compression: minimum 1 (poor), maximum 100 (qaulity). Read/write integer.");
00034 PyDoc_STRVAR(imgexp_filename__doc__, "Filename of the image. With or without path. Read/write string.");
00035 PyDoc_STRVAR(imgexp_type__doc__, "Bitmap type. See allTypes list for more info. Read/write string.");
00036 PyDoc_STRVAR(imgexp_alltypes__doc__, "Available types. Read only list of strings.");
00037 
00038 PyDoc_STRVAR(imgexp_save__doc__, "save() -> boolean\n\nSaves image under previously set 'name'.");
00039 PyDoc_STRVAR(imgexp_saveas__doc__, "saveAs('filename') -> boolean\n\nSaves image as 'filename'.");
00040 
00041 // Nest items are not needed but are here for me to exercise
00042 // writing complete python objects
00043 
00044 #define ImageExport_Check(op) ((op)->ob_type == &ImageExport_Type)
00045 
00046 #endif /* OBJIMGEXPORT_H */