Added a few comments and increase some code readability.
[synfig.git] / synfig-studio / trunk / src / gtkmm / mod_palette / mod_palette.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file mod_palette.h
3 **      \brief Template Header
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_MOD_PALETTE_H
26 #define __SYNFIG_MOD_PALETTE_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <ETL/handle>
31 #include "../module.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 studio {
40
41 class Dock_PalEdit;
42 class Dock_PalBrowse;
43
44 class ModPalette : public Module
45 {
46         friend class Dock_PalEdit;
47         friend class Dock_PalBrowse;
48
49         Dock_PalEdit*   dock_pal_edit;
50         Dock_PalBrowse* dock_pal_browse;
51
52 protected:
53         virtual bool start_vfunc();
54         virtual bool stop_vfunc();
55
56 public:
57         virtual ~ModPalette() { stop(); }
58 };
59
60 }; // END of namespace studio
61
62 /* === E N D =============================================================== */
63
64 #endif