libpurple/smiley-custom.h

   1 /* purple
   2  *
   3  * Purple 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 PURPLE_SMILEY_CUSTOM_H
  23 #define PURPLE_SMILEY_CUSTOM_H
  24 /**
  25  * SECTION:smiley-custom
  26  * @include:smiley-custom.h
  27  * @section_id: libpurple-smiley-custom
  28  * @short_description: a persistent storage for user-defined smileys
  29  * @title: Custom smileys storage
  30  *
  31  * A custom smiley is a non-standard (not defined by a particular protocol)
  32  * #PurpleSmiley, defined by user. Some protocols support sending such smileys
  33  * for other buddies, that do not have such image on their machine. Protocol
  34  * that supports this feature should set the flag
  35  * @PURPLE_CONNECTION_FLAG_ALLOW_CUSTOM_SMILEY of #PurpleConnectionFlags.
  36  */
  37
  38 #include "smiley.h"
  39 #include "smiley-list.h"
  40
  41 /**
  42  * purple_smiley_custom_add:
  43  * @image: the smiley's image.
  44  * @shortcut: textual representation of a smiley.
  45  *
  46  * Adds a new smiley to the store. The @shortcut should be unique, but the
  47  * @image contents don't have to.
  48  *
  49  * Returns: (transfer none): A new #PurpleSmiley, or %NULL if error occurred.
  50  */
  51 PurpleSmiley *
  52 purple_smiley_custom_add(PurpleImage *image, const gchar *shortcut);
  53
  54 /**
  55  * purple_smiley_custom_remove:
  56  * @smiley: the smiley to be removed.
  57  *
  58  * Removes a @smiley from the store. If the @smiley file is unique (not used by
  59  * other smileys) it will be removed from a disk.
  60  */
  61 void
  62 purple_smiley_custom_remove(PurpleSmiley *smiley);
  63
  64 /**
  65  * purple_smiley_custom_get_list:
  66  *
  67  * Returns the whole list of user-configured custom smileys.
  68  *
  69  * Returns: (transfer none): A #PurpleSmileyList of custom smileys.
  70  */
  71 PurpleSmileyList *
  72 purple_smiley_custom_get_list(void);
  73
  74 /**
  75  * _purple_smiley_custom_init: (skip)
  76  *
  77  * Initializes the custom smileys storage subsystem.
  78  * Stability: Private
  79  */
  80 void
  81 _purple_smiley_custom_init(void);
  82
  83 /**
  84  * _purple_smiley_custom_uninit: (skip)
  85  *
  86  * Uninitializes the custom smileys storage subsystem.
  87  */
  88 void
  89 _purple_smiley_custom_uninit(void);
  90
  91 #endif /* PURPLE_SMILEY_CUSTOM_H */