Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

cmddoc.cpp File Reference

#include "cmddoc.h"
#include "cmdutil.h"
#include "units.h"
#include "documentinformation.h"
#include "scribuscore.h"

Include dependency graph for cmddoc.cpp:

Go to the source code of this file.

Functions

PyObject * scribus_newdocument (PyObject *, PyObject *args)
PyObject * scribus_newdoc (PyObject *, PyObject *args)
PyObject * scribus_setmargins (PyObject *, PyObject *args)
PyObject * scribus_closedoc (PyObject *)
PyObject * scribus_havedoc (PyObject *)
PyObject * scribus_opendoc (PyObject *, PyObject *args)
PyObject * scribus_savedoc (PyObject *)
PyObject * scribus_savedocas (PyObject *, PyObject *args)
PyObject * scribus_setinfo (PyObject *, PyObject *args)
PyObject * scribus_setunit (PyObject *, PyObject *args)
PyObject * scribus_getunit (PyObject *)
PyObject * scribus_loadstylesfromfile (PyObject *, PyObject *args)
PyObject * scribus_setdoctype (PyObject *, PyObject *args)
PyObject * scribus_closemasterpage (PyObject *)
PyObject * scribus_masterpagenames (PyObject *)
PyObject * scribus_editmasterpage (PyObject *, PyObject *args)
PyObject * scribus_createmasterpage (PyObject *, PyObject *args)
PyObject * scribus_deletemasterpage (PyObject *, PyObject *args)
void cmddocdocwarnings ()


Function Documentation

void cmddocdocwarnings (  ) 

HACK: this removes "warning: 'blah' defined but not used" compiler warnings with header files structure untouched (docstrings are kept near declarations) PV

Definition at line 362 of file cmddoc.cpp.

PyObject* scribus_closedoc ( PyObject *   ) 

PyObject* scribus_closemasterpage ( PyObject *   ) 

PyObject* scribus_createmasterpage ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_deletemasterpage ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_editmasterpage ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_getunit ( PyObject *   ) 

Returns actual unit scale.

Definition at line 228 of file cmddoc.cpp.

References checkHaveDocument(), ScribusMainWindow::doc, ScribusCore::primaryMainWindow(), ScCore, and ScribusDoc::unitIndex().

PyObject* scribus_havedoc ( PyObject *   ) 

Checks if is a document opened.

Definition at line 139 of file cmddoc.cpp.

References ScribusMainWindow::HaveDoc, ScribusCore::primaryMainWindow(), and ScCore.

PyObject* scribus_loadstylesfromfile ( PyObject *  ,
PyObject *  args 
)

Loads styles from another .sla file (craig r.)

Definition at line 235 of file cmddoc.cpp.

References checkHaveDocument(), ScribusMainWindow::doc, ScribusDoc::loadStylesFromFile(), ScribusCore::primaryMainWindow(), Py_RETURN_NONE, and ScCore.

PyObject* scribus_masterpagenames ( PyObject *   ) 

PyObject* scribus_newdoc ( PyObject *  ,
PyObject *  args 
)

Creates a new document e.g. (Paper_A4, Margins, 1, 1, 1, NoFacingPages, FirstPageLeft) first 2 args are lists (tuples)

Todo:
Obsolete! In the case of no facing pages use only firstpageleft scripter is not new-page-size ready. What is it: don't allow to use wrong FSL constant in the case of onesided document.

Definition at line 74 of file cmddoc.cpp.

References ScribusMainWindow::doFileNew(), p, ScribusCore::primaryMainWindow(), ScCore, and value2pts().

PyObject* scribus_newdocument ( PyObject *  ,
PyObject *  args 
)

Creates a new document e.g. (Paper_A4, Margins, 1, 1, 1, NoFacingPages, FirstPageLeft) first 2 args are lists (tuples)

Definition at line 16 of file cmddoc.cpp.

References ScribusMainWindow::doc, ScribusMainWindow::doFileNew(), p, ScribusDoc::pageSets, ScribusCore::primaryMainWindow(), ScCore, ScribusException, tr(), and value2pts().

PyObject* scribus_opendoc ( PyObject *  ,
PyObject *  args 
)

Opens a document with given name.

Definition at line 144 of file cmddoc.cpp.

References ScribusMainWindow::loadDoc(), ScribusCore::primaryMainWindow(), ScCore, ScribusException, and tr().

PyObject* scribus_savedoc ( PyObject *   ) 

PyObject* scribus_savedocas ( PyObject *  ,
PyObject *  args 
)

Saves active document with given name

Definition at line 171 of file cmddoc.cpp.

References checkHaveDocument(), ScribusMainWindow::DoFileSave(), ScribusCore::primaryMainWindow(), ScCore, ScribusException, and tr().

PyObject* scribus_setdoctype ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_setinfo ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_setmargins ( PyObject *  ,
PyObject *  args 
)

PyObject* scribus_setunit ( PyObject *  ,
PyObject *  args 
)

Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.