git.maemo.org Git - modest/blob - src/modest-ui-dimming-manager.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
  31 #ifndef __MODEST_UI_DIMMING_MANAGER_H__
  32 #define __MODEST_UI_DIMMING_MANAGER_H__
  33
  34 #include <glib-object.h>
  35 #include "modest-dimming-rules-group.h"
  36
  37 G_BEGIN_DECLS
  38
  39 /* convenience macros */
  40 #define MODEST_TYPE_UI_DIMMING_MANAGER             (modest_ui_dimming_manager_get_type())
  41 #define MODEST_UI_DIMMING_MANAGER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_UI_DIMMING_MANAGER,ModestUIDimmingManager))
  42 #define MODEST_UI_DIMMING_MANAGER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_UI_DIMMING_MANAGER,GObject))
  43 #define MODEST_IS_UI_DIMMING_MANAGER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_UI_DIMMING_MANAGER))
  44 #define MODEST_IS_UI_DIMMING_MANAGER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_UI_DIMMING_MANAGER))
  45 #define MODEST_UI_DIMMING_MANAGER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_UI_DIMMING_MANAGER,ModestUIDimmingManagerClass))
  46
  47 typedef struct _ModestUIDimmingManager      ModestUIDimmingManager;
  48 typedef struct _ModestUIDimmingManagerClass ModestUIDimmingManagerClass;
  49
  50 struct _ModestUIDimmingManager {
  51          GObject parent;
  52         /* insert public members, if any */
  53 };
  54
  55 struct _ModestUIDimmingManagerClass {
  56         GObjectClass parent_class;
  57
  58         /* Signals */
  59 };
  60
  61 typedef enum {
  62         MODEST_UI_DIMMING_MODE_DIM = 0,
  63         MODEST_UI_DIMMING_MODE_HIDE,
  64 } ModestUIDimmingMode;
  65
  66 ModestUIDimmingManager* modest_ui_dimming_manager_new(void);
  67
  68
  69 void
  70 modest_ui_dimming_manager_insert_rules_group (ModestUIDimmingManager *self,
  71                                                  ModestDimmingRulesGroup *group);
  72
  73 void
  74 modest_ui_dimming_manager_process_dimming_rules (ModestUIDimmingManager *self);
  75
  76
  77 void
  78 modest_ui_dimming_manager_process_dimming_rules_group (ModestUIDimmingManager *self,
  79                                                        const gchar *group_name);
  80
  81 void
  82 modest_ui_dimming_manager_set_widget_dimming_mode (GtkWidget *widget,
  83                                                    ModestUIDimmingMode mode);
  84
  85 ModestUIDimmingMode
  86 modest_ui_dimming_manager_get_widget_dimming_mode (GtkWidget *widget);
  87
  88
  89
  90 G_END_DECLS
  91
  92 #endif