pidgin/gtksmiley.h

   1 /**
   2  * @file gtksmiley.h GTK+ Custom Smiley API
   3  * @ingroup pidgin
   4  * @since 2.5.0
   5  */
   6
   7 /* pidgin
   8  *
   9  * Pidgin is the legal property of its developers, whose names are too numerous
  10  * to list here.  Please refer to the COPYRIGHT file distributed with this
  11  * source distribution.
  12  *
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 2 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License
  24  * along with this program; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  26  */
  27
  28 #ifndef PIDGIN_GTKSMILEY_H
  29 #define PIDGIN_GTKSMILEY_H
  30
  31 #include "smiley.h"
  32
  33 typedef struct _PidginSmiley PidginSmiley;
  34
  35 /**
  36  * Add a PurpleSmiley to the GtkIMHtmlSmiley's list to be able to use it
  37  * in pidgin
  38  *
  39  * @param smiley        The smiley to be added.
  40  */
  41 void pidgin_smiley_add_to_list(PurpleSmiley *smiley);
  42
  43 /**
  44  * Delete a PurpleSmiley from the GtkIMHtmlSmiley's list
  45  *
  46  * @param smiley        The smiley to be deleted.
  47  */
  48 void pidgin_smiley_del_from_list(PurpleSmiley *smiley);
  49
  50 /**
  51  * Load the GtkIMHtml list
  52  */
  53 void pidgin_smileys_init(void);
  54
  55 /**
  56  * Uninit the GtkIMHtml list
  57  */
  58 void pidgin_smileys_uninit(void);
  59
  60 /**
  61  * Returns a GSList with the GtkIMHtmlSmiley of each custom smiley
  62  *
  63  * @constreturn A GtkIMHmlSmiley list
  64  */
  65 GSList *pidgin_smileys_get_all(void);
  66
  67 /******************************************************************************
  68  * Smiley Manager
  69  *****************************************************************************/
  70 /**
  71  * Displays the Smiley Manager Window
  72  */
  73 void pidgin_smiley_manager_show(void);
  74
  75 /**
  76  * Shows an editor for a smiley.
  77  *
  78  * @param widget The parent widget to be linked or @c NULL
  79  * @param smiley The PurpleSmiley to be edited, or @c NULL for a new smiley
  80  * @return The smiley add dialog
  81  *
  82  * @see pidgin_smiley_editor_set_shortcut
  83  * @see pidgin_smiley_editor_set_image
  84  */
  85 PidginSmiley *pidgin_smiley_edit(GtkWidget *widget, PurpleSmiley *smiley);
  86
  87 /**
  88  * Set the shortcut in a smiley add dialog
  89  *
  90  * @param editor A smiley editor dialog (created by pidgin_smiley_edit)
  91  * @param shortcut The shortcut to set
  92  */
  93 void pidgin_smiley_editor_set_shortcut(PidginSmiley *editor, const gchar *shortcut);
  94
  95 /**
  96  * Set the image in a smiley add dialog
  97  *
  98  * @param editor A smiley editor dialog
  99  * @param image A GdkPixbuf image
 100  */
 101 void pidgin_smiley_editor_set_image(PidginSmiley *editor, GdkPixbuf *image);
 102
 103 /**
 104  * Sets the image data in a smiley add dialog
 105  *
 106  * @param editor A smiley editor dialog
 107  * @param data A pointer to smiley's data
 108  * @param datasize The size of smiley's data
 109  *
 110  * @since 2.6.0
 111  */
 112 void pidgin_smiley_editor_set_data(PidginSmiley *editor, gpointer data, gsize datasize);
 113
 114 #endif /* PIDGIN_GTKSMILEY_H */