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
  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 /**
  87  * modest_dimming_rule_new:
  88  * @win: the #ModestWindow object which executes dimming rule.
  89  * @dimming_rule: a #ModestDimmingCallback function to check dimmed status.
  90  * @widget: the widget the rule will apply to
  91  *
  92  * Creates a new instance of class #ModestDimmingRule using parameters to
  93  * fill private data, required to process dimming rules. All parameters
  94  * are required and NULL will be returned if one of these parameters is
  95  * invalid or NULL.
  96  *
  97  * Returns: a new instance of #ModestDimmingRule class, or NULL, if parameters
  98  * are invalid.
  99  **/
 100 ModestDimmingRule*
 101 modest_dimming_rule_new_from_widget (ModestWindow *win,
 102                                      ModestDimmingCallback dimming_rule,
 103                                      GtkWidget *widget);
 104 /**
 105  * modest_dimming_rule_process:
 106  * @rule: a #ModestDimmingRule object to process.
 107  *
 108  * Process dimming rule, executing private callback defined at
 109  * instantiation time. This callback may updates notification provate field
 110  * of @rule in order to show information banners when 'insensitive-press'
 111  * events occurs.
 112  *
 113  **/
 114 void modest_dimming_rule_process (ModestDimmingRule *self);
 115
 116 /**
 117  * modest_dimming_rule_set_group:
 118  * @rule: a #ModestDimmingRule object to process.
 119  * @group: a #ModestDimmingRulesGroup object to associate.
 120  *
 121  * Creates a new reference of @group, associated to this "rule.
 122  */
 123 void modest_dimming_rule_set_group (ModestDimmingRule *rule,
 124                                     ModestDimmingRulesGroup *group);
 125
 126 /**
 127  * modest_dimming_rule_set_group:
 128  * @rule: a #ModestDimmingRule object to process.
 129  *
 130  * Gets a new reference of associated group of this @rule.
 131  *
 132  * @Returns: a new object reference of #ModestDimmingRulesGroup, or
 133  * NULL if invalid @rule.
 134  */
 135 ModestDimmingRulesGroup *
 136 modest_dimming_rule_get_group (ModestDimmingRule *rule);
 137
 138 /**
 139  * modest_dimming_rule_get_widget:
 140  * @rule: a #ModestDimmingRule
 141  *
 142  * Widget the dimming rule is referenced to
 143  *
 144  * Returns: a #GtkWidget or %NULL if the dimming rule has no widget attached
 145  */
 146 const gchar*
 147 modest_dimming_rule_get_action_path (ModestDimmingRule *rule);
 148
 149 /**
 150  * modest_dimming_rule_get_widget:
 151  * @rule: a #ModestDimmingRule
 152  *
 153  * In case the dimming rule references directly a widget, it
 154  * returns the widget.
 155  *
 156  * Returns: a #GtkWidget or %NULL if the dimming rule has no direct widget attached
 157  */
 158 GtkWidget *
 159 modest_dimming_rule_get_widget (ModestDimmingRule *rule);
 160
 161 void modest_dimming_rule_set_notification (ModestDimmingRule *rule,
 162                                            const gchar *notification);
 163
 164 gchar *modest_dimming_rule_get_notification (ModestDimmingRule *rule);
 165
 166
 167 G_END_DECLS
 168
 169 #endif /* __MODEST_DIMMING_RULE_H__ */