git.maemo.org Git - modest/blob - 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 #define MODEST_DIMMING_CALLBACK(x) ((ModestDimmingCallback) (x))
  53
  54
  55 struct _ModestDimmingRule {
  56          GObject parent;
  57         /* insert public members, if any */
  58 };
  59
  60 struct _ModestDimmingRuleClass {
  61         GObjectClass parent_class;
  62
  63         /* Signals */
  64 };
  65
  66 /* member functions */
  67 GType        modest_dimming_rule_get_type    (void) G_GNUC_CONST;
  68
  69 /**
  70  * modest_dimming_rule_new:
  71  * @win: the #ModestWindow object which executes dimming rule.
  72  * @dimming_rule: a #ModestDimmingCallback function to check dimmed status.
  73  * @action_path: full path of action registered on #GtkUIManager UIManager.
  74  *
  75  * Creates a new instance of class #ModestDimmingRule using parameters to
  76  * fill private data, required to process dimming rules. All parameters
  77  * are required and NULL will be returned if one of these parameters is
  78  * invalid or NULL.
  79  *
  80  * Returns: a new instance of #ModestDimmingRule class, or NULL, if parameters
  81  * are invalid.
  82  **/
  83 ModestDimmingRule*    modest_dimming_rule_new     (ModestWindow *win,
  84                                                    ModestDimmingCallback dimming_rule,
  85                                                    const gchar *action_path);
  86
  87
  88 /**
  89  * modest_dimming_rule_new:
  90  * @win: the #ModestWindow object which executes dimming rule.
  91  * @dimming_rule: a #ModestDimmingCallback function to check dimmed status.
  92  * @widget: the widget the rule will apply to
  93  *
  94  * Creates a new instance of class #ModestDimmingRule using parameters to
  95  * fill private data, required to process dimming rules. All parameters
  96  * are required and NULL will be returned if one of these parameters is
  97  * invalid or NULL.
  98  *
  99  * Returns: a new instance of #ModestDimmingRule class, or NULL, if parameters
 100  * are invalid.
 101  **/
 102 ModestDimmingRule*
 103 modest_dimming_rule_new_from_widget (ModestWindow *win,
 104                                      ModestDimmingCallback dimming_rule,
 105                                      GtkWidget *widget);
 106 /**
 107  * modest_dimming_rule_process:
 108  * @rule: a #ModestDimmingRule object to process.
 109  *
 110  * Process dimming rule, executing private callback defined at
 111  * instantiation time. This callback may updates notification provate field
 112  * of @rule in order to show information banners when 'insensitive-press'
 113  * events occurs.
 114  *
 115  **/
 116 void modest_dimming_rule_process (ModestDimmingRule *self);
 117
 118 /**
 119  * modest_dimming_rule_set_group:
 120  * @rule: a #ModestDimmingRule object to process.
 121  * @group: a #ModestDimmingRulesGroup object to associate.
 122  *
 123  * Creates a new reference of @group, associated to this "rule.
 124  */
 125 void modest_dimming_rule_set_group (ModestDimmingRule *rule,
 126                                     ModestDimmingRulesGroup *group);
 127
 128 /**
 129  * modest_dimming_rule_set_group:
 130  * @rule: a #ModestDimmingRule object to process.
 131  *
 132  * Gets a new reference of associated group of this @rule.
 133  *
 134  * @Returns: a new object reference of #ModestDimmingRulesGroup, or
 135  * NULL if invalid @rule.
 136  */
 137 ModestDimmingRulesGroup *
 138 modest_dimming_rule_get_group (ModestDimmingRule *rule);
 139
 140 /**
 141  * modest_dimming_rule_get_widget:
 142  * @rule: a #ModestDimmingRule
 143  *
 144  * Widget the dimming rule is referenced to
 145  *
 146  * Returns: a #GtkWidget or %NULL if the dimming rule has no widget attached
 147  */
 148 const gchar*
 149 modest_dimming_rule_get_action_path (ModestDimmingRule *rule);
 150
 151 /**
 152  * modest_dimming_rule_get_widget:
 153  * @rule: a #ModestDimmingRule
 154  *
 155  * In case the dimming rule references directly a widget, it
 156  * returns the widget.
 157  *
 158  * Returns: a #GtkWidget or %NULL if the dimming rule has no direct widget attached
 159  */
 160 GtkWidget *
 161 modest_dimming_rule_get_widget (ModestDimmingRule *rule);
 162
 163 void modest_dimming_rule_set_notification (ModestDimmingRule *rule,
 164                                            const gchar *notification);
 165
 166 gchar *modest_dimming_rule_get_notification (ModestDimmingRule *rule);
 167
 168
 169 G_END_DECLS
 170
 171 #endif /* __MODEST_DIMMING_RULE_H__ */