synfig-core/trunk/src/synfig/savecanvas.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file savecanvas.h
   3 **      \brief writeme
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **
  10 **      This package is free software; you can redistribute it and/or
  11 **      modify it under the terms of the GNU General Public License as
  12 **      published by the Free Software Foundation; either version 2 of
  13 **      the License, or (at your option) any later version.
  14 **
  15 **      This package is distributed in the hope that it will be useful,
  16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18 **      General Public License for more details.
  19 **      \endlegal
  20 */
  21 /* ========================================================================= */
  22
  23 /* === S T A R T =========================================================== */
  24
  25 #ifndef __SYNFIG_SAVECANVAS_H
  26 #define __SYNFIG_SAVECANVAS_H
  27
  28 /* === H E A D E R S ======================================================= */
  29
  30 #include "string.h"
  31 #include "canvas.h"
  32
  33 /* === M A C R O S ========================================================= */
  34
  35 /* === T Y P E D E F S ===================================================== */
  36
  37 /* === C L A S S E S & S T R U C T S ======================================= */
  38
  39 namespace synfig {
  40
  41 /* === E X T E R N S ======================================================= */
  42
  43 //!     Saves a canvas to \a filename
  44 /*!     \return \c true on success, \c false on error. */
  45 bool save_canvas(const String &filename, Canvas::ConstHandle canvas);
  46
  47 //! Stores a Canvas in a string in XML format
  48 String canvas_to_string(Canvas::ConstHandle canvas);
  49
  50 }; // END of namespace synfig
  51
  52 /* === E N D =============================================================== */
  53
  54 #endif