Use always the #define to refer to the signature separator
[modest] / src / modest-plugin-factory.h
1 /* Copyright (c) 2008, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * * Redistributions of source code must retain the above copyright
9  *   notice, this list of conditions and the following disclaimer.
10  * * Redistributions in binary form must reproduce the above copyright
11  *   notice, this list of conditions and the following disclaimer in the
12  *   documentation and/or other materials provided with the distribution.
13  * * Neither the name of the Nokia Corporation nor the names of its
14  *   contributors may be used to endorse or promote products derived from
15  *   this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #ifndef __MODEST_PLUGIN_FACTORY_H__
31 #define __MODEST_PLUGIN_FACTORY_H__
32
33 #include <glib-object.h>
34 /* other include files */
35
36 G_BEGIN_DECLS
37
38 /* convenience macros */
39 #define MODEST_TYPE_PLUGIN_FACTORY             (modest_plugin_factory_get_type())
40 #define MODEST_PLUGIN_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PLUGIN_FACTORY,ModestPluginFactory))
41 #define MODEST_PLUGIN_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PLUGIN_FACTORY,GObjectClass))
42 #define MODEST_IS_PLUGIN_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PLUGIN_FACTORY))
43 #define MODEST_IS_PLUGIN_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PLUGIN_FACTORY))
44 #define MODEST_PLUGIN_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PLUGIN_FACTORY,ModestPluginFactoryClass))
45
46 typedef struct _ModestPluginFactory      ModestPluginFactory;
47 typedef struct _ModestPluginFactoryClass ModestPluginFactoryClass;
48
49 struct _ModestPluginFactory {
50          GObject parent;
51 };
52
53 struct _ModestPluginFactoryClass {
54         GObjectClass parent_class;
55 };
56
57 /* member functions */
58 GType        modest_plugin_factory_get_type    (void) G_GNUC_CONST;
59
60 ModestPluginFactory*    modest_plugin_factory_new         (void);
61
62 void     modest_plugin_factory_load_all (ModestPluginFactory *self);
63
64 G_END_DECLS
65
66 #endif /* __MODEST_PLUGIN_FACTORY_H__ */
67