1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_WIDGET_FACTORY_H__
31 #define __MODEST_WIDGET_FACTORY_H__
33 #include <glib-object.h>
34 #include "modest-account-mgr.h"
35 #include "modest-tny-account-store.h"
37 #include "widgets/modest-header-view.h"
38 #include "widgets/modest-folder-view.h"
39 #include "widgets/modest-msg-view.h"
40 #include "widgets/modest-account-view.h"
44 /* convenience macros */
45 #define MODEST_TYPE_WIDGET_FACTORY (modest_widget_factory_get_type())
46 #define MODEST_WIDGET_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WIDGET_FACTORY,ModestWidgetFactory))
47 #define MODEST_WIDGET_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WIDGET_FACTORY,GObject))
48 #define MODEST_IS_WIDGET_FACTORY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WIDGET_FACTORY))
49 #define MODEST_IS_WIDGET_FACTORY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WIDGET_FACTORY))
50 #define MODEST_WIDGET_FACTORY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WIDGET_FACTORY,ModestWidgetFactoryClass))
52 typedef struct _ModestWidgetFactory ModestWidgetFactory;
53 typedef struct _ModestWidgetFactoryClass ModestWidgetFactoryClass;
55 struct _ModestWidgetFactory {
57 /* insert public members, if any */
60 struct _ModestWidgetFactoryClass {
61 GObjectClass parent_class;
62 /* insert signal callback declarations, eg. */
63 /* void (* my_event) (ModestWidgetFactory* obj); */
67 * modest_widget_factory_get_type
69 * get the GType for ModestWidgetFactory
73 GType modest_widget_factory_get_type (void) G_GNUC_CONST;
77 * modest_widget_factory_new
78 * @conf: a modest conf instance
79 * @acc_store: a modest account store instance
80 * @acc_mgr: a modest account mgr instance
81 * @autoconnect: should we autoconnect the widgets (ie. depedent widgets are update
84 * instantiates a ModestWidgetFactory
86 * Returns: a new ModestWidgetFactory, or NULL in case of error
88 ModestWidgetFactory* modest_widget_factory_new (ModestConf *conf,
89 ModestTnyAccountStore *acc_store,
90 ModestAccountMgr *account_mgr,
91 gboolean auto_connect);
93 * modest_widget_factory_get_folder_view
94 * @self: a ModestWidgetFactory instance
96 * return the folder tree widget (ie. the widget with the list of folders);
98 * This factory will always return the
99 * same widget, and takes care of its lifetime - users should *not* destroy it.
101 * Returns: a folder tree view, or NULL in case of error
103 ModestFolderView* modest_widget_factory_get_folder_view (ModestWidgetFactory *self);
107 * modest_widget_factory_get_header_view
108 * @self: a ModestWidgetFactory instance
110 * return the header tree widget (ie. the widget with the list of headers);
112 * This factory will always return the
113 * same widget, and takes care of its lifetime - users should *not* destroy it.
115 * Returns: a header tree view, or NULL in case of error
117 ModestHeaderView* modest_widget_factory_get_header_view (ModestWidgetFactory *self);
121 * modest_widget_factory_get_msg_preview
122 * @self: a ModestWidgetFactory instance
124 * return the message preview widget (ie. the widget with shows the currently selected message);
126 * This factory will always return the
127 * same widget, and takes care of its lifetime - users should *not* destroy it.
129 * Returns: a header tree view, or NULL in case of error
131 ModestMsgView* modest_widget_factory_get_msg_preview (ModestWidgetFactory *self);
135 * modest_widget_factory_get_account_view
136 * @self: a ModestWidgetFactory instance
138 * return an account view widget (ie. the widget that shows a list of accounts)
140 * This factory will always return the
141 * same widget, and takes care of its lifetime - users should *not* destroy it.
143 * Returns: the account view, or NULL in case of error
145 ModestAccountView* modest_widget_factory_get_account_view (ModestWidgetFactory *self);
149 * modest_widget_factory_get_progress_bar
150 * @self: a ModestWidgetFactory instance
152 * return an progress bar widget
153 * if the widget factory was created with 'auto_connect', then this progress bar
154 * will automatically update for changes in the other widgets
155 * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
157 * This factory will always return the
158 * same widget, and takes care of its lifetime - users should *not* destroy it.
160 * Returns: the progress bar widget
162 GtkWidget* modest_widget_factory_get_progress_bar (ModestWidgetFactory *self);
167 * modest_widget_factory_get_status_bar
168 * @self: a ModestWidgetFactory instance
170 * return an status bar widget
171 * if the widget factory was created with 'auto_connect', then this status bar
172 * will automatically update for changes in the other widgets
173 * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
175 * This factory will always return the
176 * same widget, and takes care of its lifetime - users should *not* destroy it.
178 * Returns: the status bar widget
180 GtkWidget* modest_widget_factory_get_status_bar (ModestWidgetFactory *self);
187 #endif /* __MODEST_WIDGET_FACTORY_H__ */