Filled in the parameter names in the prototype of get_frame() to keep doxygen quiet...
[synfig.git] / synfig-core / trunk / src / modules / mod_ppm / mptr_ppm.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file mptr_ppm.h
3 **      \brief Template Header
4 **
5 **      \legal
6 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
7 **
8 **      This package is free software; you can redistribute it and/or
9 **      modify it under the terms of the GNU General Public License as
10 **      published by the Free Software Foundation; either version 2 of
11 **      the License, or (at your option) any later version.
12 **
13 **      This package is distributed in the hope that it will be useful,
14 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
15 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 **      General Public License for more details.
17 **      \endlegal
18 **
19 ** === N O T E S ===========================================================
20 **
21 ** ========================================================================= */
22
23 /* === S T A R T =========================================================== */
24
25 #ifndef __SYNFIG_MPTR_PPM_H
26 #define __SYNFIG_MPTR_PPM_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <synfig/importer.h>
31 #include <synfig/string.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 class ppm_mptr : public synfig::Importer
40 {
41         SYNFIG_IMPORTER_MODULE_EXT
42 private:
43         synfig::String filename;
44 public:
45         ppm_mptr(const char *filename);
46         ~ppm_mptr();
47
48         virtual bool get_frame(synfig::Surface &surface,synfig::Time time, synfig::ProgressCallback *callback);
49 }; // END of class ppm_mptr
50
51 /* === E N D =============================================================== */
52
53 #endif