* added ModestWidgetMemory, new generic system for saving/restoring widget
[modest] / src / modest-widget-memory.h
1 /* Copyright (c) 2006, 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_WIDGET_MEMORY_H__
31 #define __MODEST_WIDGET_MEMORY_H__
32
33 #include <gtk/gtk.h>
34 #include "modest-conf.h"
35 #include "modest-conf-keys.h"
36
37 G_BEGIN_DECLS
38
39 /**
40  * modest_widget_memory_save_settings:
41  * @self: a ModestConf instance
42  * @widget: the widget to save the settings for
43  * @name: the unique name for this widget
44  * 
45  * store a the settings for a widget in the configuration system
46  * 
47  * Returns: TRUE if succeeded or FALSE in case of error.
48  */
49 gboolean modest_widget_memory_save_settings (ModestConf *conf, GtkWidget *widget,
50                                              const gchar *name);
51
52 /**
53  * modest_widget_memory_restore_settings:
54  * @self: a ModestConf instance
55  * @widget: the widget to save the settings for
56  * @name: the unique name for this widget
57  *
58  * restore the settings for a widget configuration system
59  * 
60  * Returns: TRUE if succeeded or FALSE in case of error.
61  */
62 gboolean modest_widget_memory_restore_settings (ModestConf *conf, GtkWidget *widget,
63                                                 const gchar *name);
64 G_END_DECLS
65
66 #endif /*__MODEST_WIDGET_MEMORY_H__*/