git.maemo.org Git - modest/blob - src/modest-dimming-rules-group.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_RULES_GROUP_H__
  31 #define __MODEST_DIMMING_RULES_GROUP_H__
  32
  33 #include <glib-object.h>
  34 #include <widgets/modest-window.h>
  35
  36 G_BEGIN_DECLS
  37
  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))
  45
  46 typedef struct {
  47         const gchar     *action_path;
  48         GCallback  callback;
  49 } ModestDimmingEntry;
  50
  51 typedef struct _ModestDimmingRulesGroup      ModestDimmingRulesGroup;
  52 typedef struct _ModestDimmingRulesGroupClass ModestDimmingRulesGroupClass;
  53
  54 struct _ModestDimmingRulesGroup {
  55          GObject parent;
  56         /* insert public members, if any */
  57 };
  58
  59 struct _ModestDimmingRulesGroupClass {
  60         GObjectClass parent_class;
  61
  62         /* Signals */
  63 };
  64
  65
  66 /* member functions */
  67 GType        modest_dimming_rules_group_get_type    (void) G_GNUC_CONST;
  68
  69 /**
  70  * modest_dimming_rules_group_new:
  71  * @group_name: the name to identify new created group
  72  * @notifications_enabled: notification system status.
  73  *
  74  * Creates a new instance of class #ModestDimmingRulesGroup. The @group_name
  75  * parameter identifies uniquely new group created, so it must not be NULL.
  76  * The @notifications_enabled: parameter sets notification system status
  77  * when dimmed rule is called.
  78  *
  79  * Returns: a new #ModestDimmingRulesGroup instance, or NULL if parameters
  80  * are invalid.
  81  **/
  82 ModestDimmingRulesGroup*    modest_dimming_rules_group_new     (const gchar *group_name,
  83                                                                 gboolean notifications_enabled);
  84
  85
  86
  87 /**
  88  * modest_dimming_rules_group_add_rules:
  89  * @self: the #ModestDimmingRulesGroup object which stores dimming rules.
  90  * @modest_dimming_entries: a #ModestDimmingEntry array to define dimmed status handlers.
  91  * @n_elements: the number of elements of @modest_dimming_entries array.
  92  * @user_data: generic user data.
  93  *
  94  * Add rules to @self dimming rules group object.
  95  **/
  96 void
  97 modest_dimming_rules_group_add_rules (ModestDimmingRulesGroup *self,
  98                                       const ModestDimmingEntry modest_dimming_entries[],
  99                                       guint n_elements,
 100                                       ModestWindow *window);
 101
 102 /**
 103  * modest_dimming_rules_group_add_rules:
 104  * @self: the #ModestDimmingRulesGroup object which stores dimming rules.
 105  * @rule: a #ModestDimmingRule
 106  * @user_data: generic user data.
 107  *
 108  * Add @rule to @self dimming rules group object.
 109  **/
 110 void
 111 modest_dimming_rules_group_add_widget_rule (ModestDimmingRulesGroup *self,
 112                                             GtkWidget *widget,
 113                                             GCallback callback,
 114                                             ModestWindow *window);
 115
 116 /**
 117  * modest_dimming_rules_group_get_name:
 118  * @self: the #ModestDimmingRulesGroup object which stores dimming rules.
 119  *
 120  * Gets the name, which uniquely identifies @self dimming rules group.
 121  *
 122  * Returns: a string with group name.
 123  **/
 124 gchar *
 125 modest_dimming_rules_group_get_name (ModestDimmingRulesGroup *self);
 126
 127 G_END_DECLS
 128
 129 #endif /* __MODEST_DIMMING_RULES_GROUP_H__ */