annotate pidgin/gtksmiley.h @ 30664:28df1fdba52e

Compile.

/**
 * @file gtksmiley.h GTK+ Custom Smiley API
 * @ingroup pidgin
 * @since 2.5.0
 */

/* pidgin
 *
 * Pidgin is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#ifndef PIDGIN_GTKSMILEY_H
#define PIDGIN_GTKSMILEY_H

#include "smiley.h"

typedef struct _PidginSmiley PidginSmiley;

/**
 * Add a PurpleSmiley to the GtkIMHtmlSmiley's list to be able to use it
 * in pidgin
 *
 * @param smiley	The smiley to be added.
 */
void pidgin_smiley_add_to_list(PurpleSmiley *smiley);

/**
 * Delete a PurpleSmiley from the GtkIMHtmlSmiley's list
 *
 * @param smiley	The smiley to be deleted.
 */
void pidgin_smiley_del_from_list(PurpleSmiley *smiley);

/**
 * Load the GtkIMHtml list
 */
void pidgin_smileys_init(void);

/**
 * Uninit the GtkIMHtml list
 */
void pidgin_smileys_uninit(void);

/**
 * Returns a GSList with the GtkIMHtmlSmiley of each custom smiley
 *
 * @constreturn A GtkIMHmlSmiley list
 */
GSList *pidgin_smileys_get_all(void);

/******************************************************************************
 * Smiley Manager
 *****************************************************************************/
/**
 * Displays the Smiley Manager Window
 */
void pidgin_smiley_manager_show(void);

/**
 * Shows an editor for a smiley.
 *
 * @param widget The parent widget to be linked or @c NULL
 * @param smiley The PurpleSmiley to be edited, or @c NULL for a new smiley
 * @return The smiley add dialog
 *
 * @see pidgin_smiley_editor_set_shortcut
 * @see pidgin_smiley_editor_set_image
 */
PidginSmiley *pidgin_smiley_edit(GtkWidget *widget, PurpleSmiley *smiley);

/**
 * Set the shortcut in a smiley add dialog
 *
 * @param editor A smiley editor dialog (created by pidgin_smiley_edit)
 * @param shortcut The shortcut to set
 */
void pidgin_smiley_editor_set_shortcut(PidginSmiley *editor, const gchar *shortcut);

/**
 * Set the image in a smiley add dialog
 *
 * @param editor A smiley editor dialog
 * @param image A GdkPixbuf image
 */
void pidgin_smiley_editor_set_image(PidginSmiley *editor, GdkPixbuf *image);

/**
 * Sets the image data in a smiley add dialog
 *
 * @param editor A smiley editor dialog
 * @param data A pointer to smiley's data
 * @param datasize The size of smiley's data
 *
 * @since 2.6.0
 */
void pidgin_smiley_editor_set_data(PidginSmiley *editor, gpointer data, gsize datasize);

#endif /* PIDGIN_GTKSMILEY_H */