pidgin/gtksmiley-theme.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
  20  */
  21
  22 #ifndef _PIDGIN_SMILEY_THEME_H_
  23 #define _PIDGIN_SMILEY_THEME_H_
  24 /**
  25  * SECTION:gtksmiley-theme
  26  * @include:gtksmiley-theme.h
  27  * @section_id: pidgin-smiley-theme
  28  * @short_description: a per-protocol categorized sets of standard smileys
  29  * @title: Pidgin's smiley themes
  30  *
  31  * This class implements a per-protocol based #PurpleSmileyTheme.
  32  */
  33
  34 #include <glib-object.h>
  35 #include <gdk-pixbuf/gdk-pixbuf.h>
  36
  37 #include "conversation.h"
  38 #include "smiley-theme.h"
  39
  40 G_BEGIN_DECLS
  41
  42 #define PIDGIN_TYPE_SMILEY_THEME  pidgin_smiley_theme_get_type()
  43
  44 /**
  45  * pidgin_smiley_theme_get_type:
  46  *
  47  * Returns: the #GType for a smiley list.
  48  */
  49 G_DECLARE_FINAL_TYPE(PidginSmileyTheme, pidgin_smiley_theme, PIDGIN,
  50                 SMILEY_THEME, PurpleSmileyTheme)
  51
  52 /**
  53  * pidgin_smiley_theme_get_name:
  54  * @theme: the smiley theme.
  55  *
  56  * Returns the name for a @theme. Valid themes always have the name set.
  57  *
  58  * Returns: (transfer none): the name string, or %NULL if error occured.
  59  */
  60 const gchar *
  61 pidgin_smiley_theme_get_name(PidginSmileyTheme *theme);
  62
  63 /**
  64  * pidgin_smiley_theme_get_description:
  65  * @theme: the smiley theme.
  66  *
  67  * Returns the description for a @theme.
  68  *
  69  * Returns: (transfer none): the description string, or %NULL if it's not
  70  *          set or error occured.
  71  */
  72 const gchar *
  73 pidgin_smiley_theme_get_description(PidginSmileyTheme *theme);
  74
  75 /**
  76  * pidgin_smiley_theme_get_icon:
  77  * @theme: the smiley theme.
  78  *
  79  * Returns the @theme's icon image, possibly loading it from the disk (and
  80  * adding it to the cache).
  81  *
  82  * Returns: (transfer none): the @theme's icon image.
  83  */
  84 GdkPixbuf *
  85 pidgin_smiley_theme_get_icon(PidginSmileyTheme *theme);
  86
  87 /**
  88  * pidgin_smiley_theme_get_author:
  89  * @theme: the smiley theme.
  90  *
  91  * Returns the autor of @theme.
  92  *
  93  * Returns: (transfer none): the author string, or %NULL if it's not
  94  *          set or error occured.
  95  */
  96 const gchar *
  97 pidgin_smiley_theme_get_author(PidginSmileyTheme *theme);
  98
  99 /**
 100  * pidgin_smiley_theme_for_conv:
 101  * @conv: the conversation.
 102  *
 103  * Gets the smiley list for a @conv based on current theme.
 104  *
 105  * Returns: (transfer none): the smiley list, or %NULL if there
 106  *          is no smiley theme set.
 107  */
 108 PurpleSmileyList *
 109 pidgin_smiley_theme_for_conv(PurpleConversation *conv);
 110
 111 /**
 112  * pidgin_smiley_theme_get_all:
 113  *
 114  * Returns the list of currently available smiley themes.
 115  *
 116  * Returns: (transfer none) (element-type PidginSmileyTheme): the #GList of #PidginSmileyTheme's.
 117  */
 118 GList *
 119 pidgin_smiley_theme_get_all(void);
 120
 121 /**
 122  * _pidgin_smiley_theme_init: (skip)
 123  *
 124  * Initializes the Pidgin's smiley theme subsystem.
 125  */
 126 void
 127 _pidgin_smiley_theme_init(void);
 128
 129 /**
 130  * _pidgin_smiley_theme_uninit: (skip)
 131  *
 132  * Unitializes the Pidgin's smiley theme subsystem.
 133  */
 134 void
 135 _pidgin_smiley_theme_uninit(void);
 136
 137 G_END_DECLS
 138
 139 #endif /* _PIDGIN_SMILEY_THEME_H_ */