.. highlight:: rst

:class:`DocumentAPI`
====================

.. py:class:: DocumentAPI

   :class:`DocumentAPI` provides properties and methods needed to interact with a Scribus document. An instance of DocumentAPI may be obtained from :class:`Scripter`, for eg. ::

    document = Scripter.activeDocument

:class:`DocumentAPI` Attributes
-------------------------------

.. py:attribute:: DocumentAPI.name

   Read the name of current document.::
   
       print document.name
       
   This will be empty for a new document.

   
.. py:attribute:: DocumentAPI.available

	Returns True if the document is available, else False.::
	
	    >>> document = Scripter.activeDocument
	    >>> document.available
	    True
	    >>> 

.. py:attribute:: DocumentAPI.margins

  Return an object of type :class:`Margins`

.. py:attribute:: DocumentAPI.modified

  This attribute is used to check whether the document is modified or not. It can also be used to set a document as modified.::

      >>> doc = Scripter.activeDocument
      >>> doc.modified
      False
      >>> doc.modified = True
      >>> doc.modified
      True
      >>> 

.. py:attribute:: DocumentAPI.activePage

.. py:attribute:: DocumentAPI.pageCount

.. py:attribute:: DocumentAPI.activeItem

.. py:attribute:: DocumentAPI.dimensions

.. py:attribute:: DocumentAPI.items

.. py:attribute:: DocumentAPI.selection

.. py:attribute:: DocumentAPI.selectionCount

.. py:attribute:: DocumentAPI.colors

.. py:attribute:: DocumentAPI.layers

.. py:attribute:: DocumentAPI.masterPages

.. py:attribute:: DocumentAPI.styles	

:class:`DocumentAPI` Methods
----------------------------

.. py:method:: DocumentAPI.close()

   Closes a document. Returns True is successful, else return False.
   
       >>> document = Scripter.activeDocument
       >>> document.close()
       True
       >>>
       
.. py:method:: DocumentAPI.save()

   Saves the current document, and return True is successful. If the document is a new one (i.e., you are trying to save it for the first time), calling this function will result in invocation of Save As dialog, where you can enter the name for your document.
   
       >>> document = Scripter.activeDocument
       >>> document.save()
       True
       >>>

.. py:method:: DocumentAPI.saveAs(name)

.. py:method:: DocumentAPI.setInformation(author, title, description)

.. py:method:: DocumentAPI.newLayer(name)

.. py:method:: DocumentAPI.removeLayer(name)

.. py:method:: DocumentAPI.getActiveLayer()

   Make it property
   
.. py:method:: DocumentAPI.setActiveLayer(name)

   Make it property
   
.. py:method:: DocumentAPI.getActiveLayerName()

   Make it property

.. py:method:: DocumentAPI.newColorCMYK(c, m, y, k)

.. py:method:: DocumentAPI.newColorRGB(r, g, b)

.. py:method:: DocumentAPI.getColor(name)

   Make it property
   
.. py:method:: DocumentAPI.supportedImageTypes()

.. py:method:: DocumentAPI.exportAsImages(directoryName, scale, quality, dpi, overwrite)