git.maemo.org Git - modest/blob - src/gtk/modest-shell-banner.h

   1 /* Copyright (c) 2009 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_SHELL_BANNER_H__
  31 #define __MODEST_SHELL_BANNER_H__
  32
  33 #include <gtk/gtk.h>
  34
  35 G_BEGIN_DECLS
  36
  37 /* convenience macros */
  38 #define MODEST_TYPE_SHELL_BANNER             (modest_shell_banner_get_type())
  39 #define MODEST_SHELL_BANNER(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SHELL_BANNER,ModestShellBanner))
  40 #define MODEST_SHELL_BANNER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SHELL_BANNER,ModestBanner))
  41
  42 #define MODEST_IS_SHELL_BANNER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SHELL_BANNER))
  43 #define MODEST_IS_SHELL_BANNER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SHELL_BANNER))
  44 #define MODEST_SHELL_BANNER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SHELL_BANNER,ModestShellBannerClass))
  45
  46 typedef struct _ModestShellBanner      ModestShellBanner;
  47 typedef struct _ModestShellBannerClass ModestShellBannerClass;
  48
  49 struct _ModestShellBanner {
  50         GtkFrame parent;
  51 };
  52
  53 struct _ModestShellBannerClass {
  54         GtkFrameClass parent_class;
  55
  56 };
  57
  58 /**
  59  * modest_shell_banner_get_type:
  60  *
  61  * get the GType for the ModestShellBanner class
  62  *
  63  * Returns: a GType for ModestShellBanner
  64  */
  65 GType modest_shell_banner_get_type (void) G_GNUC_CONST;
  66
  67 GtkWidget *modest_shell_banner_new (GtkWidget *parent);
  68 GtkWidget *modest_shell_banner_new_with_timeout (GtkWidget *parent, gint timeout);
  69 void modest_shell_banner_set_icon (ModestShellBanner *self, const gchar *icon_name);
  70 void modest_shell_banner_set_text (ModestShellBanner *self, const gchar *label);
  71 void modest_shell_banner_set_animation (ModestShellBanner *self, const gchar *animation_name);
  72
  73 G_END_DECLS
  74
  75 #endif