pidgin/pidgin

Install our appdata file to $(datadir)/metainfo as that change was made a long time ago
release-2.x.y
2021-04-09, Gary Kramlich
a817d80eeb79
Install our appdata file to $(datadir)/metainfo as that change was made a long time ago

This patch originates from Lars Wendler from Gentoo

https://gitweb.gentoo.org/repo/gentoo.git/commit/net-im/pidgin/files/pidgin-2.13.0-metainfo.patch?id=2dd6c1852251b5b67c3045badf173be9535b97a9

Testing Done:
Installed to a prefix and verified the file ended up in `$prefix/share/metainfo`

Reviewed at https://reviews.imfreedom.org/r/607/
/**
* @file gtkimhtml.h GTK+ IM/HTML rendering component
* @ingroup pidgin
* @see @ref gtkimhtml-signals
*/
/* 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
* 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 _PIDGINIMHTML_H_
#define _PIDGINIMHTML_H_
#include <gdk/gdk.h>
#include <gtk/gtk.h>
#include "gtksourceundomanager.h"
#include "connection.h"
#ifdef __cplusplus
extern "C" {
#endif
/**************************************************************************
* @name Structures
**************************************************************************/
/*@{*/
#define GTK_TYPE_IMHTML (gtk_imhtml_get_type())
#define GTK_IMHTML(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GTK_TYPE_IMHTML, GtkIMHtml))
#define GTK_IMHTML_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GTK_TYPE_IMHTML, GtkIMHtmlClass))
#define GTK_IS_IMHTML(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GTK_TYPE_IMHTML))
#define GTK_IS_IMHTML_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GTK_TYPE_IMHTML))
#define GTK_IMHTML_SCALABLE(obj) ((GtkIMHtmlScalable *)obj)
#define GTK_IMHTML_ANIMATION(obj) ((GtkIMHtmlAnimation *)obj)
typedef struct _GtkIMHtml GtkIMHtml;
typedef struct _GtkIMHtmlClass GtkIMHtmlClass;
#if !(defined PIDGIN_DISABLE_DEPRECATED) && !(defined _PIDGIN_GTKIMHTML_C_)
typedef struct _GtkIMHtmlFontDetail GtkIMHtmlFontDetail; /* The five elements contained in a FONT tag */
#endif
typedef struct _GtkSmileyTree GtkSmileyTree;
typedef struct _GtkIMHtmlSmiley GtkIMHtmlSmiley;
typedef struct _GtkIMHtmlScalable GtkIMHtmlScalable;
typedef struct _GtkIMHtmlImage GtkIMHtmlImage;
typedef struct _GtkIMHtmlAnimation GtkIMHtmlAnimation;
typedef struct _GtkIMHtmlHr GtkIMHtmlHr;
typedef struct _GtkIMHtmlFuncs GtkIMHtmlFuncs;
/**
* @since 2.6.0
*/
typedef struct _GtkIMHtmlLink GtkIMHtmlLink;
typedef enum {
GTK_IMHTML_BOLD = 1 << 0,
GTK_IMHTML_ITALIC = 1 << 1,
GTK_IMHTML_UNDERLINE = 1 << 2,
GTK_IMHTML_GROW = 1 << 3,
GTK_IMHTML_SHRINK = 1 << 4,
GTK_IMHTML_FACE = 1 << 5,
GTK_IMHTML_FORECOLOR = 1 << 6,
GTK_IMHTML_BACKCOLOR = 1 << 7,
GTK_IMHTML_BACKGROUND = 1 << 8,
GTK_IMHTML_LINK = 1 << 9,
GTK_IMHTML_IMAGE = 1 << 10,
GTK_IMHTML_SMILEY = 1 << 11,
GTK_IMHTML_LINKDESC = 1 << 12,
GTK_IMHTML_STRIKE = 1 << 13,
/** Show custom smileys when appropriate. @since 2.5.0 */
GTK_IMHTML_CUSTOM_SMILEY = 1 << 14,
GTK_IMHTML_ALL = -1
} GtkIMHtmlButtons;
typedef enum {
GTK_IMHTML_SMILEY_CUSTOM = 1 << 0
} GtkIMHtmlSmileyFlags;
struct _GtkIMHtml {
GtkTextView text_view;
GtkTextBuffer *text_buffer;
GdkCursor *hand_cursor;
GdkCursor *arrow_cursor;
GdkCursor *text_cursor;
GHashTable *smiley_data;
GtkSmileyTree *default_smilies;
char *protocol_name;
guint scroll_src;
GTimer *scroll_time;
GQueue *animations;
int num_animations;
gboolean show_comments;
GtkWidget *tip_window;
char *tip;
guint tip_timer;
GtkTextTag *prelit_tag;
GList *scalables;
GdkRectangle old_rect;
gchar *search_string;
gboolean editable;
GtkIMHtmlButtons format_functions;
gboolean wbfo; /* Whole buffer formatting only. */
gint insert_offset;
struct {
gboolean bold:1;
gboolean italic:1;
gboolean underline:1;
gboolean strike:1;
gchar *forecolor;
gchar *backcolor;
gchar *background;
gchar *fontface;
int fontsize;
GtkTextTag *link;
} edit;
#if !(defined PIDGIN_DISABLE_DEPRECATED) || (defined _PIDGIN_GTKIMHTML_C_)
/** @deprecated */
char *clipboard_text_string;
/** @deprecated */
char *clipboard_html_string;
#else
char *depr1;
char *depr2;
#endif
GSList *im_images;
GtkIMHtmlFuncs *funcs;
GtkSourceUndoManager *undo_manager;
};
struct _GtkIMHtmlClass {
GtkTextViewClass parent_class;
void (*url_clicked)(GtkIMHtml *, const gchar *);
void (*buttons_update)(GtkIMHtml *, GtkIMHtmlButtons);
void (*toggle_format)(GtkIMHtml *, GtkIMHtmlButtons);
void (*clear_format)(GtkIMHtml *);
void (*update_format)(GtkIMHtml *);
gboolean (*message_send)(GtkIMHtml *);
void (*undo)(GtkIMHtml *);
void (*redo)(GtkIMHtml *);
GList *protocols; /* List of GtkIMHtmlProtocol's */
};
#if !(defined PIDGIN_DISABLE_DEPRECATED) && !(defined _PIDGIN_GTKIMHTML_C_)
/** @deprecated as of 2.7.10 */
struct _GtkIMHtmlFontDetail {
gushort size;
gchar *face;
gchar *fore;
gchar *back;
gchar *bg;
gchar *sml;
gboolean underline;
gshort bold;
};
#endif
struct _GtkSmileyTree {
GString *values;
GtkSmileyTree **children;
GtkIMHtmlSmiley *image;
};
struct _GtkIMHtmlSmiley {
gchar *smile;
gchar *file;
GdkPixbufAnimation *icon;
gboolean hidden;
GdkPixbufLoader *loader;
GSList *anchors;
GtkIMHtmlSmileyFlags flags;
GtkIMHtml *imhtml;
gpointer data; /** @since 2.6.0 */
gsize datasize; /** @since 2.6.0 */
};
struct _GtkIMHtmlScalable {
void (*scale)(struct _GtkIMHtmlScalable *, int, int);
void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
void (*free)(struct _GtkIMHtmlScalable *);
};
struct _GtkIMHtmlImage {
GtkIMHtmlScalable scalable;
GtkImage *image; /**< Contains the scaled version of this pixbuf. */
GdkPixbuf *pixbuf; /**< The original pixbuf, before any scaling. */
GtkTextMark *mark;
gchar *filename;
int width;
int height;
int id;
GtkWidget *filesel;
};
struct _GtkIMHtmlAnimation {
GtkIMHtmlImage imhtmlimage;
GdkPixbufAnimation *anim; /**< The original animation, before any scaling. */
GdkPixbufAnimationIter *iter;
guint timer;
};
struct _GtkIMHtmlHr {
GtkIMHtmlScalable scalable;
GtkWidget *sep;
};
typedef enum {
GTK_IMHTML_NO_COLOURS = 1 << 0,
GTK_IMHTML_NO_FONTS = 1 << 1,
GTK_IMHTML_NO_COMMENTS = 1 << 2, /* Remove */
GTK_IMHTML_NO_TITLE = 1 << 3,
GTK_IMHTML_NO_NEWLINE = 1 << 4,
GTK_IMHTML_NO_SIZES = 1 << 5,
GTK_IMHTML_NO_SCROLL = 1 << 6,
GTK_IMHTML_RETURN_LOG = 1 << 7,
GTK_IMHTML_USE_POINTSIZE = 1 << 8,
GTK_IMHTML_NO_FORMATTING = 1 << 9,
GTK_IMHTML_USE_SMOOTHSCROLLING = 1 << 10,
GTK_IMHTML_NO_SMILEY = 1 << 11
} GtkIMHtmlOptions;
enum {
GTK_IMHTML_DRAG_URL = 0,
GTK_IMHTML_DRAG_HTML,
GTK_IMHTML_DRAG_UTF8_STRING,
GTK_IMHTML_DRAG_COMPOUND_TEXT,
GTK_IMHTML_DRAG_STRING,
GTK_IMHTML_DRAG_TEXT,
GTK_IMHTML_DRAG_NUM
};
#define GTK_IMHTML_DND_TARGETS \
{ "text/uri-list", 0, GTK_IMHTML_DRAG_URL }, \
{ "_NETSCAPE_URL", 0, GTK_IMHTML_DRAG_URL }, \
{ "text/html", 0, GTK_IMHTML_DRAG_HTML }, \
{ "x-url/ftp", 0, GTK_IMHTML_DRAG_URL }, \
{ "x-url/http", 0, GTK_IMHTML_DRAG_URL }, \
{ "UTF8_STRING", 0, GTK_IMHTML_DRAG_UTF8_STRING }, \
{ "COMPOUND_TEXT", 0, GTK_IMHTML_DRAG_COMPOUND_TEXT }, \
{ "STRING", 0, GTK_IMHTML_DRAG_STRING }, \
{ "text/plain", 0, GTK_IMHTML_DRAG_TEXT }, \
{ "TEXT", 0, GTK_IMHTML_DRAG_TEXT }
typedef gpointer (*GtkIMHtmlGetImageFunc) (int id);
typedef gpointer (*GtkIMHtmlGetImageDataFunc) (gpointer i);
typedef size_t (*GtkIMHtmlGetImageSizeFunc) (gpointer i);
typedef const char *(*GtkIMHtmlGetImageFilenameFunc)(gpointer i);
typedef void (*GtkIMHtmlImageRefFunc) (int id);
typedef void (*GtkIMHtmlImageUnrefFunc) (int id);
struct _GtkIMHtmlFuncs {
GtkIMHtmlGetImageFunc image_get;
GtkIMHtmlGetImageDataFunc image_get_data;
GtkIMHtmlGetImageSizeFunc image_get_size;
GtkIMHtmlGetImageFilenameFunc image_get_filename;
GtkIMHtmlImageRefFunc image_ref;
GtkIMHtmlImageUnrefFunc image_unref;
};
/*@}*/
/**************************************************************************
* @name GTK+ IM/HTML rendering component API
**************************************************************************/
/*@{*/
/**
* Returns the GType object for an IM/HTML widget.
*
* @return The GType for an IM/HTML widget.
*/
GType gtk_imhtml_get_type(void);
/**
* Creates and returns a new GTK+ IM/HTML widget.
*
* @return The GTK+ IM/HTML widget created.
*/
GtkWidget *gtk_imhtml_new(void *, void *);
/**
* Returns the smiley object associated with the text.
*
* @param imhtml The GTK+ IM/HTML.
* @param sml The name of the smiley category.
* @param text The text associated with the smiley.
*/
GtkIMHtmlSmiley *gtk_imhtml_smiley_get(GtkIMHtml * imhtml,
const gchar * sml, const gchar * text);
/**
* Associates a smiley with a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param sml The name of the smiley category.
* @param smiley The GtkIMSmiley to associate.
*/
void gtk_imhtml_associate_smiley(GtkIMHtml *imhtml, const gchar *sml, GtkIMHtmlSmiley *smiley);
/**
* Removes all smileys associated with a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_remove_smileys(GtkIMHtml *imhtml);
/**
* Sets the function callbacks to use with a GTK+ IM/HTML instance.
*
* @param imhtml The GTK+ IM/HTML.
* @param f The GtkIMHTMLFuncs struct containing the functions to use.
*/
void gtk_imhtml_set_funcs(GtkIMHtml *imhtml, GtkIMHtmlFuncs *f);
/**
* Enables or disables showing the contents of HTML comments in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param show @c TRUE if comments should be shown, or @c FALSE otherwise.
*/
void gtk_imhtml_show_comments(GtkIMHtml *imhtml, gboolean show);
/**
* Gets the protocol name associated with this GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML
*/
const char *gtk_imhtml_get_protocol_name(GtkIMHtml *imhtml);
/**
* Associates a protocol name with a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param protocol_name The protocol name to associate with the IM/HTML.
*/
void gtk_imhtml_set_protocol_name(GtkIMHtml *imhtml, const gchar *protocol_name);
/**
* Appends HTML formatted text to a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param text The formatted text to append.
* @param options A GtkIMHtmlOptions object indicating insert behavior.
*/
#define gtk_imhtml_append_text(imhtml, text, options) \
gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
/**
* Appends HTML formatted text to a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param text The formatted text to append.
* @param options A GtkIMHtmlOptions object indicating insert behavior.
* @param unused Use @c NULL value.
*/
void gtk_imhtml_append_text_with_images(GtkIMHtml *imhtml,
const gchar *text,
GtkIMHtmlOptions options,
GSList *unused);
/**
* Inserts HTML formatted text to a GTK+ IM/HTML at a given iter.
*
* @param imhtml The GTK+ IM/HTML.
* @param text The formatted text to append.
* @param options A GtkIMHtmlOptions object indicating insert behavior.
* @param iter A GtkTextIter in the GTK+ IM/HTML at which to insert text.
*/
void gtk_imhtml_insert_html_at_iter(GtkIMHtml *imhtml,
const gchar *text,
GtkIMHtmlOptions options,
GtkTextIter *iter);
/**
* Scrolls a GTK+ IM/HTML to the end of its contents.
*
* @param imhtml The GTK+ IM/HTML.
* @param smooth A boolean indicating if smooth scrolling should be used.
*/
void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml, gboolean smooth);
/**
* Delete the contents of a GTK+ IM/HTML between start and end.
*
* @param imhtml The GTK+ IM/HTML.
* @param start a postition in the imhtml's buffer
* @param end another postition in the imhtml's buffer
*/
void gtk_imhtml_delete(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
/**
* Purges the contents from a GTK+ IM/HTML and resets formatting.
*
* @param imhtml The GTK+ IM/HTML.
*/
#define gtk_imhtml_clear(imhtml) \
gtk_imhtml_delete(imhtml, NULL, NULL)
/**
* Scrolls a GTK+ IM/HTML up by one page.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_page_up(GtkIMHtml *imhtml);
/**
* Scrolls a GTK+ IM/HTML down by one page.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_page_down(GtkIMHtml *imhtml);
/**
* Creates and returns an new GTK+ IM/HTML scalable object.
*
* @return A new IM/HTML Scalable object.
*/
GtkIMHtmlScalable *gtk_imhtml_scalable_new(void);
/**
* Creates and returns a new GTK+ IM/HTML scalable object with an image.
*
* @param img A GdkPixbuf of the image to add.
* @param filename The filename to associate with the image.
* @param id The id to associate with the image.
*
* @return A new IM/HTML Scalable object with an image.
*/
GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id);
/**
* Creates and returns a new GTK+ IM/HTML scalable object with an
* animated image.
*
* @param img A GdkPixbufAnimation of the image to add.
* @param filename The filename to associate with the image.
* @param id The id to associate with the image.
*
* @return A new IM/HTML Scalable object with an image.
*
* @since 2.1.0
*/
/*
* TODO: All this animation code could be combined much better with
* the image code. It couldn't be done when it was written
* because it requires breaking backward compatibility. It
* would be good to do it for 3.0.0.
*/
GtkIMHtmlScalable *gtk_imhtml_animation_new(GdkPixbufAnimation *img, const gchar *filename, int id);
/**
* Destroys and frees a GTK+ IM/HTML scalable image.
*
* @param scale The GTK+ IM/HTML scalable.
*/
/* TODO: Is there any reason this isn't private? */
void gtk_imhtml_image_free(GtkIMHtmlScalable *scale);
/**
* Destroys and frees a GTK+ IM/HTML scalable animation.
*
* @param scale The GTK+ IM/HTML scalable.
*/
/* TODO: Is there any reason this isn't private? */
void gtk_imhtml_animation_free(GtkIMHtmlScalable *scale);
/**
* Rescales a GTK+ IM/HTML scalable image to a given size.
*
* @param scale The GTK+ IM/HTML scalable.
* @param width The new width.
* @param height The new height.
*/
/* TODO: Is there any reason this isn't private? */
void gtk_imhtml_image_scale(GtkIMHtmlScalable *scale, int width, int height);
/**
* Adds a GTK+ IM/HTML scalable image to a given GTK+ IM/HTML at a given iter.
*
* @param scale The GTK+ IM/HTML scalable.
* @param imhtml The GTK+ IM/HTML.
* @param iter The GtkTextIter at which to add the scalable.
*/
/* TODO: Is there any reason this isn't private? */
void gtk_imhtml_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
/**
* Creates and returns an new GTK+ IM/HTML scalable with a horizontal rule.
*
* @return A new IM/HTML Scalable object with an image.
*/
GtkIMHtmlScalable *gtk_imhtml_hr_new(void);
/**
* Destroys and frees a GTK+ IM/HTML scalable horizontal rule.
*
* @param scale The GTK+ IM/HTML scalable.
*/
void gtk_imhtml_hr_free(GtkIMHtmlScalable *scale);
/**
* Rescales a GTK+ IM/HTML scalable horizontal rule to a given size.
*
* @param scale The GTK+ IM/HTML scalable.
* @param width The new width.
* @param height The new height.
*/
void gtk_imhtml_hr_scale(GtkIMHtmlScalable *scale, int width, int height);
/**
* Adds a GTK+ IM/HTML scalable horizontal rule to a given GTK+ IM/HTML at
* a given iter.
*
* @param scale The GTK+ IM/HTML scalable.
* @param imhtml The GTK+ IM/HTML.
* @param iter The GtkTextIter at which to add the scalable.
*/
void gtk_imhtml_hr_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter);
/**
* Finds and highlights a given string in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param text The string to search for.
*
* @return @c TRUE if a search was performed, or @c FALSE if not.
*/
gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text);
/**
* Clears the highlighting from a prior search in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_search_clear(GtkIMHtml *imhtml);
/**
* Enables or disables editing in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param editable @c TRUE to make the widget editable, or @c FALSE otherwise.
*/
void gtk_imhtml_set_editable(GtkIMHtml *imhtml, gboolean editable);
/**
* Enables or disables whole buffer formatting only (wbfo) in a GTK+ IM/HTML.
* In this mode formatting options to the buffer take effect for the entire
* buffer instead of specific text.
*
* @param imhtml The GTK+ IM/HTML.
* @param wbfo @c TRUE to enable the mode, or @c FALSE otherwise.
*/
void gtk_imhtml_set_whole_buffer_formatting_only(GtkIMHtml *imhtml, gboolean wbfo);
/**
* Indicates which formatting functions to enable and disable in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param buttons A GtkIMHtmlButtons bitmask indicating which functions to use.
*/
void gtk_imhtml_set_format_functions(GtkIMHtml *imhtml, GtkIMHtmlButtons buttons);
/**
* Returns which formatting functions are enabled in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A GtkIMHtmlButtons bitmask indicating which functions to are enabled.
*/
GtkIMHtmlButtons gtk_imhtml_get_format_functions(GtkIMHtml *imhtml);
/**
* Sets each boolean to @c TRUE or @c FALSE to indicate if that formatting option
* is enabled at the current position in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param bold The boolean to set for bold or @c NULL.
* @param italic The boolean to set for italic or @c NULL.
* @param underline The boolean to set for underline or @c NULL.
*/
void gtk_imhtml_get_current_format(GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline);
/**
* Returns a string containing the selected font face at the current position
* in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A string containg the font face or @c NULL if none is set.
*/
char *gtk_imhtml_get_current_fontface(GtkIMHtml *imhtml);
/**
* Returns a string containing the selected foreground color at the current
* position in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A string containg the foreground color or @c NULL if none is set.
*/
char *gtk_imhtml_get_current_forecolor(GtkIMHtml *imhtml);
/**
* Returns a string containing the selected font background color at the current
* position in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A string containg the font background color or @c NULL if none is set.
*/
char *gtk_imhtml_get_current_backcolor(GtkIMHtml *imhtml);
/**
* Returns a string containing the selected background color at the current
* position in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A string containg the background color or @c NULL if none is set.
*/
char *gtk_imhtml_get_current_background(GtkIMHtml *imhtml);
/**
* Returns a integer containing the selected HTML font size at the current
* position in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return The HTML font size.
*/
gint gtk_imhtml_get_current_fontsize(GtkIMHtml *imhtml);
/**
* Checks whether a GTK+ IM/HTML is marked as editable.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return @c TRUE if the IM/HTML is editable, or @c FALSE otherwise.
*/
gboolean gtk_imhtml_get_editable(GtkIMHtml *imhtml);
/**
* Clear all the formatting on a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_clear_formatting(GtkIMHtml *imhtml);
/**
* Toggles bold at the cursor location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_toggle_bold(GtkIMHtml *imhtml);
/**
* Toggles italic at the cursor location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_toggle_italic(GtkIMHtml *imhtml);
/**
* Toggles underline at the cursor location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_toggle_underline(GtkIMHtml *imhtml);
/**
* Toggles strikethrough at the cursor location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_toggle_strike(GtkIMHtml *imhtml);
/**
* Toggles a foreground color at the current location or selection in a GTK
* IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param color The HTML-style color, or @c NULL or "" to clear the color.
*
* @return @c TRUE if a color was set, or @c FALSE if it was cleared.
*/
gboolean gtk_imhtml_toggle_forecolor(GtkIMHtml *imhtml, const char *color);
/**
* Toggles a background color at the current location or selection in a GTK
* IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param color The HTML-style color, or @c NULL or "" to clear the color.
*
* @return @c TRUE if a color was set, or @c FALSE if it was cleared.
*/
gboolean gtk_imhtml_toggle_backcolor(GtkIMHtml *imhtml, const char *color);
/**
* Toggles a background color at the current location or selection in a GTK
* IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param color The HTML-style color, or @c NULL or "" to clear the color.
*
* @return @c TRUE if a color was set, or @c FALSE if it was cleared.
*/
gboolean gtk_imhtml_toggle_background(GtkIMHtml *imhtml, const char *color);
/**
* Toggles a font face at the current location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param face The font face name, or @c NULL or "" to clear the font.
*
* @return @c TRUE if a font name was set, or @c FALSE if it was cleared.
*/
gboolean gtk_imhtml_toggle_fontface(GtkIMHtml *imhtml, const char *face);
/**
* Toggles a link tag with the given URL at the current location or selection
* in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param url The URL for the link or @c NULL to terminate the link.
*/
void gtk_imhtml_toggle_link(GtkIMHtml *imhtml, const char *url);
/**
* Inserts a link to the given url at the given GtkTextMark in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param mark The GtkTextMark to insert the link at.
* @param url The URL for the link.
* @param text The string to use for the link description.
*/
void gtk_imhtml_insert_link(GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text);
/**
* Inserts a smiley at the current location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param sml The category of the smiley.
* @param smiley The text of the smiley to insert.
*/
void gtk_imhtml_insert_smiley(GtkIMHtml *imhtml, const char *sml, char *smiley);
/**
* Inserts a smiley at the given iter in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param sml The category of the smiley.
* @param smiley The text of the smiley to insert.
* @param iter The GtkTextIter in the IM/HTML to insert the smiley at.
*/
void gtk_imhtml_insert_smiley_at_iter(GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter);
/**
* Inserts the IM/HTML scalable image with the given id at the given iter in a
* GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param id The id of the IM/HTML scalable.
* @param iter The GtkTextIter in the IM/HTML to insert the image at.
*/
void gtk_imhtml_insert_image_at_iter(GtkIMHtml *imhtml, int id, GtkTextIter *iter);
/**
* Sets the font size at the current location or selection in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param size The HTML font size to use.
*/
void gtk_imhtml_font_set_size(GtkIMHtml *imhtml, gint size);
/**
* Decreases the font size by 1 at the current location or selection in a GTK
* IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_font_shrink(GtkIMHtml *imhtml);
/**
* Increases the font size by 1 at the current location or selection in a GTK
* IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*/
void gtk_imhtml_font_grow(GtkIMHtml *imhtml);
/**
* Returns the HTML formatted contents between two iters in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param start The GtkTextIter indicating the start point in the IM/HTML.
* @param end The GtkTextIter indicating the end point in the IM/HTML.
*
* @return A string containing the HTML formatted text.
*/
char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end);
/**
* Returns the entire HTML formatted contents of a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A string containing the HTML formatted text.
*/
char *gtk_imhtml_get_markup(GtkIMHtml *imhtml);
/**
* Returns a null terminated array of pointers to null terminated strings, each
* string for each line. g_strfreev() should be called to free it when done.
*
* @param imhtml The GTK+ IM/HTML.
*
* @return A null terminated array of null terminated HTML formatted strings.
*/
char **gtk_imhtml_get_markup_lines(GtkIMHtml *imhtml);
/**
* Returns the entire unformatted (plain text) contents of a GTK+ IM/HTML
* between two iters in a GTK+ IM/HTML.
*
* @param imhtml The GTK+ IM/HTML.
* @param start The GtkTextIter indicating the start point in the IM/HTML.
* @param stop The GtkTextIter indicating the end point in the IM/HTML.
*
* @return A string containing the unformatted text.
*/
char *gtk_imhtml_get_text(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop);
/**
* Setup formatting for an imhtml depending on the flags specified.
*
* @param imhtml The GTK+ IM/HTML.
* @param flags The connection flag which describes the allowed types of formatting.
*
* @since 2.1.0
*/
void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
/**
* Create a new GtkIMHtmlSmiley.
*
* @param file The image file for the smiley
* @param shortcut The key shortcut for the smiley
* @param hide @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise
* @param flags The smiley flags
*
* @return The newly created smiley
* @since 2.5.0
*/
GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
GtkIMHtmlSmileyFlags flags);
/**
* Reload the image data for the smiley.
*
* @param smiley The smiley to reload
*
* @since 2.5.0
*/
void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
/**
* Destroy a GtkIMHtmlSmiley.
*
* @param smiley The smiley to destroy
*
* @since 2.5.0
*/
void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
/**
* Register a protocol with the GtkIMHtml widget. Registering a protocol would
* allow certain text to be clickable.
*
* @param name The name of the protocol (e.g. http://)
* @param activate The callback to trigger when the protocol text is clicked.
* Removes any current protocol definition if @c NULL. The
* callback should return @c TRUE if the link was activated
* properly, @c FALSE otherwise.
* @param context_menu The callback to trigger when the context menu is popped
* up on the protocol text. The callback should return
* @c TRUE if the request for context menu was processed
* successfully, @c FALSE otherwise.
*
* @return @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL)
*
* @since 2.6.0
*/
gboolean gtk_imhtml_class_register_protocol(const char *name,
gboolean (*activate)(GtkIMHtml *imhtml, GtkIMHtmlLink *link),
gboolean (*context_menu)(GtkIMHtml *imhtml, GtkIMHtmlLink *link, GtkWidget *menu));
/**
* Get the URL associated with a link. This should be used by the IMHtml protocol-callbacks.
*
* @param link The GtkIMHtmlLink object sent to the callback functions
*
* @return The URL
*
* @since 2.6.0
*/
const char *gtk_imhtml_link_get_url(GtkIMHtmlLink *link);
/**
* Get the GtkTextTag object (if any) associated with a particular link.
*
* @param link The GtkIMHtmlLink object sent to the callback functions
*
* @return The GtkTextTag object, or @c NULL
*
* @since 2.6.0
*/
const GtkTextTag *gtk_imhtml_link_get_text_tag(GtkIMHtmlLink *link);
/**
* Activates a GtkIMHtmlLink object. This triggers the 'url-clicked' signal, marks the
* link as visited (when possible).
*
* @param link The GtkIMHtmlLink object sent to the callback functions
*
* @return @c TRUE if 'url-clicked' signal was emitted, @c FALSE otherwise.
*
* @since 2.6.0
*/
gboolean gtk_imhtml_link_activate(GtkIMHtmlLink *link);
/**
* By default this widget intercepts presses of the "return" key and
* emits the "message_send" signal instead. If you don't want this
* behavior, and you want the standard GtkTextView behavior of
* inserting a newline into the buffer, then call this function.
*
* @param imhtml The GtkIMHtml where you want the "return" key to add
* newline and not emit the "message_send" signal.
*/
void gtk_imhtml_set_return_inserts_newline(GtkIMHtml *imhtml);
/**
* By default this widget populates the PRIMARY clipboard with any selected
* text (as you would expect). For scenarios (e.g. select-on-focus) where this
* would be problematic, this function can disable the PRIMARY population.
*
* @param imhtml The GtkIMHtml to enable/disable populating PRIMARY
* @param populate enable/disable PRIMARY population
*/
void gtk_imhtml_set_populate_primary_clipboard(GtkIMHtml *imhtml, gboolean populate);
/*@}*/
#ifdef __cplusplus
}
#endif
#endif /* _PIDGINIMHTML_H_ */