pidgin/gtkicon-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_ICON_THEME_H
  23 #define PIDGIN_ICON_THEME_H
  24 /**
  25  * SECTION:gtkicon-theme
  26  * @section_id: pidgin-gtkicon-theme
  27  * @short_description: <filename>gtkicon-theme.h</filename>
  28  * @title: Icon Theme Class
  29  */
  30
  31 #include <glib.h>
  32 #include <glib-object.h>
  33 #include "theme.h"
  34
  35 #define PIDGIN_TYPE_ICON_THEME  pidgin_icon_theme_get_type()
  36
  37 struct _PidginIconThemeClass
  38 {
  39         PurpleThemeClass parent_class;
  40 };
  41
  42 /**************************************************************************/
  43 /* Pidgin Icon Theme API                                                  */
  44 /**************************************************************************/
  45 G_BEGIN_DECLS
  46
  47 /**
  48  * pidgin_icon_theme_get_type:
  49  *
  50  * Returns: The #GType for an icon theme.
  51  */
  52 G_DECLARE_DERIVABLE_TYPE(PidginIconTheme, pidgin_icon_theme, PIDGIN,
  53                 ICON_THEME, PurpleTheme)
  54
  55 /**
  56  * pidgin_icon_theme_get_icon:
  57  * @theme:     the theme
  58  * @event:              the pidgin icon event to look up
  59  *
  60  * Returns a copy of the filename for the icon event or NULL if it is not set
  61  *
  62  * Returns: the filename of the icon event
  63  */
  64 const gchar *pidgin_icon_theme_get_icon(PidginIconTheme *theme,
  65                 const gchar *event);
  66
  67 /**
  68  * pidgin_icon_theme_set_icon:
  69  * @theme:         the theme
  70  * @icon_id:            a string representing what the icon is to be used for
  71  * @filename:           the name of the file to be used for the given id
  72  *
  73  * Sets the filename for a given icon id, setting the icon to NULL will remove the icon from the theme
  74  */
  75 void pidgin_icon_theme_set_icon(PidginIconTheme *theme,
  76                 const gchar *icon_id,
  77                 const gchar *filename);
  78
  79 G_END_DECLS
  80
  81 #endif /* PIDGIN_ICON_THEME_H */