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
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_DIMMING_RULE             (modest_dimming_rule_get_type())
  40 #define MODEST_DIMMING_RULE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_DIMMING_RULE,ModestDimmingRule))
  41 #define MODEST_DIMMING_RULE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_DIMMING_RULE,GObject))
  42 #define MODEST_IS_DIMMING_RULE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_DIMMING_RULE))
  43 #define MODEST_IS_DIMMING_RULE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_DIMMING_RULE))
  44 #define MODEST_DIMMING_RULE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_DIMMING_RULE,ModestDimmingRuleClass))
  45
  46 typedef struct _ModestDimmingRule      ModestDimmingRule;
  47 typedef struct _ModestDimmingRuleClass ModestDimmingRuleClass;
  48
  49 typedef gboolean (*ModestDimmingCallback) (ModestWindow *self, gpointer user_data);
  50
  51
  52 struct _ModestDimmingRule {
  53          GObject parent;
  54         /* insert public members, if any */
  55 };
  56
  57 struct _ModestDimmingRuleClass {
  58         GObjectClass parent_class;
  59
  60         /* Signals */
  61 };
  62
  63 /* member functions */
  64 GType        modest_dimming_rule_get_type    (void) G_GNUC_CONST;
  65
  66 /**
  67  * modest_dimming_rule_new:
  68  * @win: the #ModestWindow object which executes dimming rule.
  69  * @dimming_rule: a #ModestDimmingCallback function to check dimmed status.
  70  * @action_path: full path of action registered on #GtkUIManager UIManager.
  71  *
  72  * Creates a new instance of class #ModestDimmingRule using parameters to
  73  * fill private data, required to process dimming rules. All parameters
  74  * are required and NULL will be returned if one of these parameters is
  75  * invalid or NULL.
  76  *
  77  * Returns: a new instance of #ModestDimmingRule class, or NULL, if parameters
  78  * are invalid.
  79  **/
  80 ModestDimmingRule*    modest_dimming_rule_new     (ModestWindow *win,
  81                                                    ModestDimmingCallback dimming_rule,
  82                                                    const gchar *action_path);
  83
  84 /**
  85  * modest_dimming_rule_process:
  86  * @rule: a #ModestDimmingRule object to process.
  87  *
  88  * Process dimming rule, executing private callback defined at
  89  * instantiation time. This callback may updates notification provate field
  90  * of @rule in order to show information banners when 'insensitive-press'
  91  * events occurs.
  92  *
  93  **/
  94 void modest_dimming_rule_process (ModestDimmingRule *self);
  95
  96 void modest_dimming_rule_set_notification (ModestDimmingRule *rule,
  97                                            const gchar *notification);
  98
  99 gchar *modest_dimming_rule_get_notification (ModestDimmingRule *rule);
 100
 101
 102 G_END_DECLS
 103
 104 #endif /* __MODEST_DIMMING_RULE_H__ */