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