* check for a valid foldername
[modest] / src / modest-dimming-rule.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_DIMMING_RULE_H__
31 #define __MODEST_DIMMING_RULE_H__
32
33 #include <glib-object.h>
34 #include "widgets/modest-window.h"
35 #include "modest-dimming-rules-group.h"
36
37 G_BEGIN_DECLS
38
39 /* convenience macros */
40 #define MODEST_TYPE_DIMMING_RULE             (modest_dimming_rule_get_type())
41 #define MODEST_DIMMING_RULE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_DIMMING_RULE,ModestDimmingRule))
42 #define MODEST_DIMMING_RULE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_DIMMING_RULE,GObject))
43 #define MODEST_IS_DIMMING_RULE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_DIMMING_RULE))
44 #define MODEST_IS_DIMMING_RULE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_DIMMING_RULE))
45 #define MODEST_DIMMING_RULE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_DIMMING_RULE,ModestDimmingRuleClass))
46
47 typedef struct _ModestDimmingRule      ModestDimmingRule;
48 typedef struct _ModestDimmingRuleClass ModestDimmingRuleClass;
49
50 typedef gboolean (*ModestDimmingCallback) (ModestWindow *self, gpointer user_data);
51
52
53 struct _ModestDimmingRule {
54          GObject parent;
55         /* insert public members, if any */
56 };
57
58 struct _ModestDimmingRuleClass {
59         GObjectClass parent_class;
60
61         /* Signals */
62 };
63
64 /* member functions */
65 GType        modest_dimming_rule_get_type    (void) G_GNUC_CONST;
66
67 /**
68  * modest_dimming_rule_new:
69  * @win: the #ModestWindow object which executes dimming rule.
70  * @dimming_rule: a #ModestDimmingCallback function to check dimmed status.
71  * @action_path: full path of action registered on #GtkUIManager UIManager.
72  * 
73  * Creates a new instance of class #ModestDimmingRule using parameters to
74  * fill private data, required to process dimming rules. All parameters
75  * are required and NULL will be returned if one of these parameters is
76  * invalid or NULL.
77  * 
78  * Returns: a new instance of #ModestDimmingRule class, or NULL, if parameters
79  * are invalid.
80  **/
81 ModestDimmingRule*    modest_dimming_rule_new     (ModestWindow *win,
82                                                    ModestDimmingCallback dimming_rule,
83                                                    const gchar *action_path);
84
85 /**
86  * modest_dimming_rule_process:
87  * @rule: a #ModestDimmingRule object to process.
88  * 
89  * Process dimming rule, executing private callback defined at 
90  * instantiation time. This callback may updates notification provate field
91  * of @rule in order to show information banners when 'insensitive-press'
92  * events occurs. 
93  *
94  **/
95 void modest_dimming_rule_process (ModestDimmingRule *self);
96
97 /**
98  * modest_dimming_rule_set_group:
99  * @rule: a #ModestDimmingRule object to process.
100  * @group: a #ModestDimmingRulesGroup object to associate.
101  * 
102  * Creates a new reference of @group, associated to this "rule.
103  */
104 void modest_dimming_rule_set_group (ModestDimmingRule *rule,
105                                     ModestDimmingRulesGroup *group);
106
107 /**
108  * modest_dimming_rule_set_group:
109  * @rule: a #ModestDimmingRule object to process.
110  * 
111  * Gets a new reference of associated group of this @rule.
112  *
113  * @Returns: a new object reference of #ModestDimmingRulesGroup, or 
114  * NULL if invalid @rule.
115  */
116 ModestDimmingRulesGroup *
117 modest_dimming_rule_get_group (ModestDimmingRule *rule);
118
119 void modest_dimming_rule_set_notification (ModestDimmingRule *rule,
120                                            const gchar *notification);
121
122 gchar *modest_dimming_rule_get_notification (ModestDimmingRule *rule);
123                                            
124
125 G_END_DECLS
126
127 #endif /* __MODEST_DIMMING_RULE_H__ */