Mercurial > pidgin.yaz
view libpurple/smiley.h @ 24268:1335376ba33f
Allow focusing conversation history and the userlist focusable via
keyboard. We used to have this feature in older versions (2.3 and below),
thanks to the GtkPaned widget we used to use (for the resizable entry!).
The bindings are F6, or Ctrl+F6. Fixes #7148.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Wed, 29 Oct 2008 19:38:14 +0000 |
parents | 013ec6fabd3f |
children | f22ecddd3eba |
line wrap: on
line source
/** * @file smiley.h Smiley API * @ingroup core * @since 2.5.0 */ /* purple * * Purple 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 _PURPLE_SMILEY_H_ #define _PURPLE_SMILEY_H_ #include <glib-object.h> #include "imgstore.h" #include "util.h" /** * A custom smiley. * This contains everything Purple will ever need to know about a custom smiley. * Everything. * * PurpleSmiley is a GObject. */ typedef struct _PurpleSmiley PurpleSmiley; typedef struct _PurpleSmileyClass PurpleSmileyClass; #define PURPLE_TYPE_SMILEY (purple_smiley_get_type ()) #define PURPLE_SMILEY(smiley) (G_TYPE_CHECK_INSTANCE_CAST ((smiley), PURPLE_TYPE_SMILEY, PurpleSmiley)) #define PURPLE_SMILEY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) #define PURPLE_IS_SMILEY(smiley) (G_TYPE_CHECK_INSTANCE_TYPE ((smiley), PURPLE_TYPE_SMILEY)) #define PURPLE_IS_SMILEY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PURPLE_TYPE_SMILEY)) #define PURPLE_SMILEY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PURPLE_TYPE_SMILEY, PurpleSmileyClass)) #ifdef __cplusplus extern "C" { #endif /**************************************************************************/ /** @name Custom Smiley API */ /**************************************************************************/ /*@{*/ /** * GObject foo. * @internal. */ GType purple_smiley_get_type(void); /** * Creates a new custom smiley structure and populates it. * * If a custom smiley with the informed shortcut already exist, it * will be automaticaly returned. * * @param img The image associated with the smiley. * @param shortcut The custom smiley associated shortcut. * * @return The custom smiley structure filled up. */ PurpleSmiley * purple_smiley_new(PurpleStoredImage *img, const char *shortcut); /** * Creates a new custom smiley structure and populates it. * * The data is retrieved from an already existent file. * * If a custom smiley with the informed shortcut already exist, it * will be automaticaly returned. * * @param shortcut The custom smiley associated shortcut. * @param filepath The image file to be imported to a * new custom smiley. * * @return The custom smiley structure filled up. */ PurpleSmiley * purple_smiley_new_from_file(const char *shortcut, const char *filepath); /** * Destroy the custom smiley and release the associated resources. * * @param smiley The custom smiley. */ void purple_smiley_delete(PurpleSmiley *smiley); /** * Changes the custom smiley's shortcut. * * @param smiley The custom smiley. * @param shortcut The custom smiley associated shortcut. * * @return TRUE whether the shortcut is not associated with another * custom smiley and the parameters are valid. FALSE otherwise. */ gboolean purple_smiley_set_shortcut(PurpleSmiley *smiley, const char *shortcut); /** * Changes the custom smiley's data. * * When the filename controling is made outside this API, the param * #keepfilename must be TRUE. * Otherwise, the file and filename will be regenerated, and the * old one will be removed. * * @param smiley The custom smiley. * @param smiley_data The custom smiley data. * @param smiley_data_len The custom smiley data length. */ void purple_smiley_set_data(PurpleSmiley *smiley, guchar *smiley_data, size_t smiley_data_len); /** * Returns the custom smiley's associated shortcut. * * @param smiley The custom smiley. * * @return The shortcut. */ const char *purple_smiley_get_shortcut(const PurpleSmiley *smiley); /** * Returns the custom smiley data's checksum. * * @param smiley The custom smiley. * * @return The checksum. */ const char *purple_smiley_get_checksum(const PurpleSmiley *smiley); /** * Returns the PurpleStoredImage with the reference counter incremented. * * The returned PurpleStoredImage reference counter must be decremented * after use. * * @param smiley The custom smiley. * * @return A PurpleStoredImage reference. */ PurpleStoredImage *purple_smiley_get_stored_image(const PurpleSmiley *smiley); /** * Returns the custom smiley's data. * * @param smiley The custom smiley. * @param len If not @c NULL, the length of the icon data returned * will be set in the location pointed to by this. * * @return A pointer to the custom smiley data. */ gconstpointer purple_smiley_get_data(const PurpleSmiley *smiley, size_t *len); /** * Returns an extension corresponding to the custom smiley's file type. * * @param smiley The custom smiley. * * @return The custom smiley's extension, "icon" if unknown, or @c NULL if * the image data has disappeared. */ const char *purple_smiley_get_extension(const PurpleSmiley *smiley); /** * Returns a full path to an custom smiley. * * If the custom smiley has data and the file exists in the cache, this * will return a full path to the cached file. * * In general, it is not appropriate to be poking in the file cached * directly. If you find yourself wanting to use this function, think * very long and hard about it, and then don't. * * @param smiley The custom smiley. * * @return A full path to the file, or @c NULL under various conditions. * The caller should use #g_free to free the returned string. */ char *purple_smiley_get_full_path(PurpleSmiley *smiley); /*@}*/ /**************************************************************************/ /** @name Custom Smiley Subsystem API */ /**************************************************************************/ /*@{*/ /** * Returns a list of all custom smileys. The caller should free the list. * * @return A list of all custom smileys. */ GList * purple_smileys_get_all(void); /** * Returns the custom smiley given it's shortcut. * * @param shortcut The custom smiley's shortcut. * * @return The custom smiley (with a reference for the caller) if found, * or @c NULL if not found. */ PurpleSmiley * purple_smileys_find_by_shortcut(const char *shortcut); /** * Returns the custom smiley given it's checksum. * * @param checksum The custom smiley's checksum. * * @return The custom smiley (with a reference for the caller) if found, * or @c NULL if not found. */ PurpleSmiley * purple_smileys_find_by_checksum(const char *checksum); /** * Returns the directory used to store custom smiley cached files. * * The default directory is PURPLEDIR/smileys, unless otherwise specified * by purple_buddy_icons_set_cache_dir(). * * @return The directory to store custom smyles cached files to. */ const char *purple_smileys_get_storing_dir(void); /** * Initializes the custom smiley subsystem. */ void purple_smileys_init(void); /** * Uninitializes the custom smiley subsystem. */ void purple_smileys_uninit(void); /*@}*/ #ifdef __cplusplus } #endif #endif /* _PURPLE_SMILEY_H_ */