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_DIMMING_RULES_GROUP_H__
31 #define __MODEST_DIMMING_RULES_GROUP_H__
33 #include <glib-object.h>
34 #include <widgets/modest-window.h>
38 /* convenience macros */
39 #define MODEST_TYPE_DIMMING_RULES_GROUP (modest_dimming_rules_group_get_type())
40 #define MODEST_DIMMING_RULES_GROUP(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_DIMMING_RULES_GROUP,ModestDimmingRulesGroup))
41 #define MODEST_DIMMING_RULES_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_DIMMING_RULES_GROUP,GObject))
42 #define MODEST_IS_DIMMING_RULES_GROUP(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_DIMMING_RULES_GROUP))
43 #define MODEST_IS_DIMMING_RULES_GROUP_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_DIMMING_RULES_GROUP))
44 #define MODEST_DIMMING_RULES_GROUP_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_DIMMING_RULES_GROUP,ModestDimmingRulesGroupClass))
47 const gchar *action_path;
51 typedef struct _ModestDimmingRulesGroup ModestDimmingRulesGroup;
52 typedef struct _ModestDimmingRulesGroupClass ModestDimmingRulesGroupClass;
54 struct _ModestDimmingRulesGroup {
56 /* insert public members, if any */
59 struct _ModestDimmingRulesGroupClass {
60 GObjectClass parent_class;
66 /* member functions */
67 GType modest_dimming_rules_group_get_type (void) G_GNUC_CONST;
70 * modest_dimming_rules_group_new:
71 * @group_name: the name to identify new created group
73 * Creates a new instance of class #ModestDimmingRulesGroup. The @group_name
74 * parameter identifies uniquely new group created, so it must not be NULL.
76 * Returns: a new #ModestDimmingRulesGroup instance, or NULL if parameters
79 ModestDimmingRulesGroup* modest_dimming_rules_group_new (const gchar *group_name);
84 * modest_dimming_rules_group_add_rules:
85 * @self: the #ModestDimmingRulesGroup object which stores dimming rules.
86 * @modest_dimming_entries: a #ModestDimmingEntry array to define dimmed status handlers.
87 * @n_elements: the number of elements of @modest_dimming_entries array.
88 * @user_data: generic user data.
90 * Add rules to @self dimming rules group object.
93 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
94 const ModestDimmingEntry modest_dimming_entries[],
99 * modest_dimming_rules_group_get_name:
100 * @self: the #ModestDimmingRulesGroup object which stores dimming rules.
102 * Gets the name, which uniquely identifies @self dimming rules group.
104 * Returns: a string with group name.
107 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self);
111 #endif /* __MODEST_DIMMING_RULES_GROUP_H__ */