gtkimhtml.h File Reference

GTK+ IM/HTML rendering component

Gaim is the legal property of its developers, whose names are too numerous to list here. More...

#include <gdk/gdk.h>
#include <gtk/gtktextview.h>
#include <gtk/gtktooltips.h>
#include <gtk/gtkimage.h>

Include dependency graph for gtkimhtml.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_GtkIMHtml
struct	_GtkIMHtmlClass
struct	_GtkIMHtmlFontDetail
struct	_GtkSmileyTree
struct	_GtkIMHtmlSmiley
struct	_GtkIMHtmlScalable
struct	_GtkIMHtmlImage
struct	_GtkIMHtmlHr
struct	_GtkIMHtmlFuncs
#define	GTK_TYPE_IMHTML   (gtk_imhtml_get_type ())
#define	GTK_IMHTML(obj)   (GTK_CHECK_CAST ((obj), GTK_TYPE_IMHTML, GtkIMHtml))
#define	GTK_IMHTML_CLASS(klass)   (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_IMHTML, GtkIMHtmlClass))
#define	GTK_IS_IMHTML(obj)   (GTK_CHECK_TYPE ((obj), GTK_TYPE_IMHTML))
#define	GTK_IS_IMHTML_CLASS(klass)   (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_IMHTML))
#define	GTK_IMHTML_SCALABLE(obj)   ((GtkIMHtmlScalable *)obj)
#define	GTK_IMHTML_DND_TARGETS
typedef _GtkIMHtml	GtkIMHtml
typedef _GtkIMHtmlClass	GtkIMHtmlClass
typedef _GtkIMHtmlFontDetail	GtkIMHtmlFontDetail
typedef _GtkSmileyTree	GtkSmileyTree
typedef _GtkIMHtmlSmiley	GtkIMHtmlSmiley
typedef _GtkIMHtmlScalable	GtkIMHtmlScalable
typedef _GtkIMHtmlImage	GtkIMHtmlImage
typedef _GtkIMHtmlHr	GtkIMHtmlHr
typedef _GtkIMHtmlFuncs	GtkIMHtmlFuncs
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)
enum	GtkIMHtmlButtons {   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_LINK = 1 << 8, GTK_IMHTML_IMAGE = 1 << 9, GTK_IMHTML_SMILEY = 1 << 10, GTK_IMHTML_LINKDESC = 1 << 11,   GTK_IMHTML_STRIKE = 1 << 12, GTK_IMHTML_ALL = -1 }
enum	GtkIMHtmlOptions {   GTK_IMHTML_NO_COLOURS = 1 << 0, GTK_IMHTML_NO_FONTS = 1 << 1, GTK_IMHTML_NO_COMMENTS = 1 << 2, 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 }
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_append_text(imhtml, text, options)   gtk_imhtml_append_text_with_images(imhtml, text, options, NULL)
	Appends HTML formatted text to a GTK IM/HTML.
GType	gtk_imhtml_get_type (void)
	Returns the GType object for an IM/HTML widget.
GtkWidget *	gtk_imhtml_new (void *, void *)
	Creates and returns a new GTK IM/HTML widget.
void	gtk_imhtml_associate_smiley (GtkIMHtml *imhtml, gchar *sml, GtkIMHtmlSmiley *smiley)
	Associates a smiley with a GTK IM/HTML.
void	gtk_imhtml_remove_smileys (GtkIMHtml *imhtml)
	Removes all smileys associated with a GTK IM/HTML.
void	gtk_imhtml_set_funcs (GtkIMHtml *imhtml, GtkIMHtmlFuncs *f)
	Sets the function callbacks to use with a GTK IM/HTML instance.
void	gtk_imhtml_show_comments (GtkIMHtml *imhtml, gboolean show)
	Enables or disables showing the contents of HTML comments in a GTK IM/HTML.
void	gtk_imhtml_html_shortcuts (GtkIMHtml *imhtml, gboolean allow)
	Enables or disables formatting shortcut keys in a GTK IM/HTML.
void	gtk_imhtml_smiley_shortcuts (GtkIMHtml *imhtml, gboolean allow)
	Enables or disables smiley insertion shortcut keys in a GTK IM/HTML.
void	gtk_imhtml_set_protocol_name (GtkIMHtml *imhtml, const gchar *protocol_name)
	Associates a protocol name with a GTK IM/HTML.
void	gtk_imhtml_append_text_with_images (GtkIMHtml *imhtml, const gchar *text, GtkIMHtmlOptions options, GSList *unused)
	Appends HTML formatted text to a GTK IM/HTML.
void	gtk_imhtml_insert_html_at_iter (GtkIMHtml *imhtml, const gchar *text, GtkIMHtmlOptions options, GtkTextIter *iter)
	Inserts HTML formatted text to a GTK IM/HTML at a given iter.
void	gtk_imhtml_scroll_to_end (GtkIMHtml *imhtml)
	Scrolls a GTK IM/HTML to the end of its contents.
void	gtk_imhtml_clear (GtkIMHtml *imhtml)
	Purges the contents from a GTK IM/HTML and resets formatting.
void	gtk_imhtml_page_up (GtkIMHtml *imhtml)
	Scrolls a GTK IM/HTML up by one page.
void	gtk_imhtml_page_down (GtkIMHtml *imhtml)
	Scrolls a GTK IM/HTML down by one page.
void	gtk_imhtml_font_zoom (GtkIMHtml *imhtml, double zoom)
	Scales the font sizes in a GTK IM/HTML by a given factor.
GtkIMHtmlScalable *	gtk_imhtml_scalable_new ()
	Creates and returns an new GTK IM/HTML scalable object.
GtkIMHtmlScalable *	gtk_imhtml_image_new (GdkPixbuf *img, const gchar *filename, int id)
	Creates and returns an new GTK IM/HTML scalable object with an image.
void	gtk_imhtml_image_free (GtkIMHtmlScalable *scale)
	Destroys and frees a GTK IM/HTML scalable image.
void	gtk_imhtml_image_scale (GtkIMHtmlScalable *scale, int width, int height)
	Rescales a GTK IM/HTML scalable image to a given size.
void	gtk_imhtml_image_add_to (GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter)
	Adds a GTK IM/HTML scalable image to a given GTK IM/HTML at a given iter.
GtkIMHtmlScalable *	gtk_imhtml_hr_new ()
	Creates and returns an new GTK IM/HTML scalable with a horizontal rule.
void	gtk_imhtml_hr_free (GtkIMHtmlScalable *scale)
	Destroys and frees a GTK IM/HTML scalable horizontal rule.
void	gtk_imhtml_hr_scale (GtkIMHtmlScalable *scale, int width, int height)
	Rescales a GTK IM/HTML scalable horizontal rule to a given size.
void	gtk_imhtml_hr_add_to (GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter)
	Adds a GTK IM/HTML scalable horizontal rule to a given GTK IM/HTML at a given iter.
gboolean	gtk_imhtml_search_find (GtkIMHtml *imhtml, const gchar *text)
	Finds and highlights a given string in a GTK IM/HTML.
void	gtk_imhtml_search_clear (GtkIMHtml *imhtml)
	Clears the highlighting from a prior search in a GTK IM/HTML.
void	gtk_imhtml_set_editable (GtkIMHtml *imhtml, gboolean editable)
	Enables or disables editing in a GTK IM/HTML.
void	gtk_imhtml_set_whole_buffer_formatting_only (GtkIMHtml *imhtml, gboolean wbfo)
	Enables or disables whole buffer formatting only (wbfo) in a GTK IM/HTML.
void	gtk_imhtml_set_format_functions (GtkIMHtml *imhtml, GtkIMHtmlButtons buttons)
	Indicates which formatting functions to enable and disable in a GTK IM/HTML.
GtkIMHtmlButtons	gtk_imhtml_get_format_functions (GtkIMHtml *imhtml)
	Returns which formatting functions are enabled in a GTK IM/HTML.
void	gtk_imhtml_get_current_format (GtkIMHtml *imhtml, gboolean *bold, gboolean *italic, gboolean *underline)
	Sets each boolean to TRUE if that formatting option is enabled at the current position in a GTK IM/HTML.
char *	gtk_imhtml_get_current_fontface (GtkIMHtml *imhtml)
	Returns a string containing the selected font face at the current position in a GTK IM/HTML.
char *	gtk_imhtml_get_current_forecolor (GtkIMHtml *imhtml)
	Returns a string containing the selected foreground color at the current position in a GTK IM/HTML.
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.
gint	gtk_imhtml_get_current_fontsize (GtkIMHtml *imhtml)
	Returns a integer containing the selected HTML font size at the current position in a GTK IM/HTML.
gboolean	gtk_imhtml_get_editable (GtkIMHtml *imhtml)
	Checks whether a GTK IM/HTML is marked as editable.
gboolean	gtk_imhtml_toggle_bold (GtkIMHtml *imhtml)
	Toggles bold at the cursor location or selection in a GTK IM/HTML.
gboolean	gtk_imhtml_toggle_italic (GtkIMHtml *imhtml)
	Toggles italic at the cursor location or selection in a GTK IM/HTML.
gboolean	gtk_imhtml_toggle_underline (GtkIMHtml *imhtml)
	Toggles underline at the cursor location or selection in a GTK IM/HTML.
gboolean	gtk_imhtml_toggle_strike (GtkIMHtml *imhtml)
	Toggles strikethrough at the cursor location or selection in a GTK IM/HTML.
gboolean	gtk_imhtml_toggle_forecolor (GtkIMHtml *imhtml, const char *color)
	Toggles a foreground color at the current location or selection in a GTK IM/HTML.
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.
gboolean	gtk_imhtml_toggle_fontface (GtkIMHtml *imhtml, const char *face)
	Toggles a font face at the current location or selection in a GTK IM/HTML.
void	gtk_imhtml_toggle_link (GtkIMHtml *imhtml, const char *url)
	Toggles a link tag with the given URL at the current location or selection in a GTK IM/HTML.
void	gtk_imhtml_insert_link (GtkIMHtml *imhtml, GtkTextMark *mark, const char *url, const char *text)
	Inserts a link to the given url at the given GtkTextMark in a GTK IM/HTML.
void	gtk_imhtml_insert_smiley (GtkIMHtml *imhtml, const char *sml, char *smiley)
	Inserts a smiley at the current location or selection in a GTK IM/HTML.
void	gtk_imhtml_insert_smiley_at_iter (GtkIMHtml *imhtml, const char *sml, char *smiley, GtkTextIter *iter)
	Inserts a smiley at the given iter in a GTK IM/HTML.
void	gtk_imhtml_insert_image_at_iter (GtkIMHtml *imhtml, int id, GtkTextIter *iter)
	Inserts the IM/HTML scalable image with the given id at the given iter in a GTK IM/HTML.
void	gtk_imhtml_font_set_size (GtkIMHtml *imhtml, gint size)
	Sets the font size at the current location or selection in a GTK IM/HTML.
void	gtk_imhtml_font_shrink (GtkIMHtml *imhtml)
	Decreases the font size by 1 at the current location or selection in a GTK IM/HTML.
void	gtk_imhtml_font_grow (GtkIMHtml *imhtml)
	Increases the font size by 1 at the current location or selection in a GTK IM/HTML.
char *	gtk_imhtml_get_markup_range (GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end)
	Returns the HTML formatted contents between two iters in a GTK IM/HTML.
char *	gtk_imhtml_get_markup (GtkIMHtml *imhtml)
	Returns the entire HTML formatted contents of a GTK IM/HTML.
char **	gtk_imhtml_get_markup_lines (GtkIMHtml *imhtml)
	Returns a null terminated array of pointers to null terminated strings, each string for each line.
char *	gtk_imhtml_get_text (GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *stop)
	Returns the entire unformatted (plain text) contents of a GTK IM/HTML between two iters in a GTK IM/HTML.

---

Detailed Description

GTK+ IM/HTML rendering component

Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

---

Define Documentation

#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. Parameters: imhtml  The GTK IM/HTML. text  The formatted text to append. options  A GtkIMHtmlOptions object indicating insert behavior.

#define GTK_IMHTML_DND_TARGETS

Value: { "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 }

---

Function Documentation

void gtk_imhtml_append_text_with_images (  GtkIMHtml *  imhtml, const gchar *  text, GtkIMHtmlOptions  options, GSList *  unused )

Appends HTML formatted text to a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. text  The formatted text to append. options  A GtkIMHtmlOptions object indicating insert behavior. unused  Use NULL value.

void gtk_imhtml_associate_smiley (  GtkIMHtml *  imhtml, gchar *  sml, GtkIMHtmlSmiley *  smiley )

Associates a smiley with a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. sml  The name of the smiley category. smiley  The GtkIMSmiley to associate.

void gtk_imhtml_clear (  GtkIMHtml *  imhtml  )

Purges the contents from a GTK IM/HTML and resets formatting. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_font_grow (  GtkIMHtml *  imhtml  )

Increases the font size by 1 at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_font_set_size (  GtkIMHtml *  imhtml, gint  size )

Sets the font size at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. size  The HTML font size to use.

void gtk_imhtml_font_shrink (  GtkIMHtml *  imhtml  )

Decreases the font size by 1 at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_font_zoom (  GtkIMHtml *  imhtml, double  zoom )

Scales the font sizes in a GTK IM/HTML by a given factor. Parameters: imhtml  The GTK IM/HTML. zoom  The factor by which to scale the font sizes.

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. Parameters: imhtml  The GTK IM/HTML. Returns: A string containg the background color or NULL if none is set.

char* gtk_imhtml_get_current_fontface (  GtkIMHtml *  imhtml  )

Returns a string containing the selected font face at the current position in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: A string containg the font face or NULL if none is set.

gint gtk_imhtml_get_current_fontsize (  GtkIMHtml *  imhtml  )

Returns a integer containing the selected HTML font size at the current position in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: The HTML font size.

char* gtk_imhtml_get_current_forecolor (  GtkIMHtml *  imhtml  )

Returns a string containing the selected foreground color at the current position in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: A string containg the foreground color or NULL if none is set.

void gtk_imhtml_get_current_format (  GtkIMHtml *  imhtml, gboolean *  bold, gboolean *  italic, gboolean *  underline )

Sets each boolean to TRUE if that formatting option is enabled at the current position in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. bold  A reference to a boolean for bold. italic  A reference to a boolean for italic. underline  A reference to a boolean for underline.

gboolean gtk_imhtml_get_editable (  GtkIMHtml *  imhtml  )

Checks whether a GTK IM/HTML is marked as editable. Parameters: imhtml  The GTK IM/HTML. Returns: TRUE if the IM/HTML is editable, or FALSE otherwise.

GtkIMHtmlButtons gtk_imhtml_get_format_functions (  GtkIMHtml *  imhtml  )

Returns which formatting functions are enabled in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: A GtkIMHtmlButtons bitmask indicating which functions to are enabled.

char* gtk_imhtml_get_markup (  GtkIMHtml *  imhtml  )

Returns the entire HTML formatted contents of a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: A string containing the HTML formatted text.

char** gtk_imhtml_get_markup_lines (  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. Parameters: imhtml  The GTK IM/HTML. Returns: A null terminated array of null terminated HTML formatted strings.

char* gtk_imhtml_get_markup_range (  GtkIMHtml *  imhtml, GtkTextIter *  start, GtkTextIter *  end )

Returns the HTML formatted contents between two iters in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. start  The GtkTextIter indicating the start point in the IM/HTML. end  The GtkTextIter indicating the end point in the IM/HTML. Returns: A string containing the HTML formatted text.

char* gtk_imhtml_get_text (  GtkIMHtml *  imhtml, GtkTextIter *  start, GtkTextIter *  stop )

Returns the entire unformatted (plain text) contents of a GTK IM/HTML between two iters in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. start  The GtkTextIter indicating the start point in the IM/HTML. stop  The GtkTextIter indicating the end point in the IM/HTML. Returns: A string containing the unformatted text.

GType gtk_imhtml_get_type (  void   )

Returns the GType object for an IM/HTML widget. Returns: The GType for an IM/HTML widget.

void gtk_imhtml_hr_add_to (  GtkIMHtmlScalable *  scale, GtkIMHtml *  imhtml, GtkTextIter *  iter )

Adds a GTK IM/HTML scalable horizontal rule to a given GTK IM/HTML at a given iter. Parameters: scale  The GTK IM/HTML scalable. imhtml  The GTK IM/HTML. iter  The GtkTextIter at which to add the scalable.

void gtk_imhtml_hr_free (  GtkIMHtmlScalable *  scale  )

Destroys and frees a GTK IM/HTML scalable horizontal rule. Parameters: scale  The GTK IM/HTML scalable.

GtkIMHtmlScalable* gtk_imhtml_hr_new (   )

Creates and returns an new GTK IM/HTML scalable with a horizontal rule. Returns: A new IM/HTML Scalable object with an image.

void gtk_imhtml_hr_scale (  GtkIMHtmlScalable *  scale, int  width, int  height )

Rescales a GTK IM/HTML scalable horizontal rule to a given size. Parameters: scale  The GTK IM/HTML scalable. width  The new width. height  The new height.

void gtk_imhtml_html_shortcuts (  GtkIMHtml *  imhtml, gboolean  allow )

Enables or disables formatting shortcut keys in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. allow  TRUE if shortcut keys are allowed, or FALSE otherwise.

void gtk_imhtml_image_add_to (  GtkIMHtmlScalable *  scale, GtkIMHtml *  imhtml, GtkTextIter *  iter )

Adds a GTK IM/HTML scalable image to a given GTK IM/HTML at a given iter. Parameters: scale  The GTK IM/HTML scalable. imhtml  The GTK IM/HTML. iter  The GtkTextIter at which to add the scalable.

void gtk_imhtml_image_free (  GtkIMHtmlScalable *  scale  )

Destroys and frees a GTK IM/HTML scalable image. Parameters: scale  The GTK IM/HTML scalable.

GtkIMHtmlScalable* gtk_imhtml_image_new (  GdkPixbuf *  img, const gchar *  filename, int  id )

Creates and returns an new GTK IM/HTML scalable object with an image. Parameters: img  A GdkPixbuf of the image to add. filename  The filename to associate with the image. id  The id to associate with the image. Returns: A new IM/HTML Scalable object with an image.

void gtk_imhtml_image_scale (  GtkIMHtmlScalable *  scale, int  width, int  height )

Rescales a GTK IM/HTML scalable image to a given size. Parameters: scale  The GTK IM/HTML scalable. width  The new width. height  The new height.

void gtk_imhtml_insert_html_at_iter (  GtkIMHtml *  imhtml, const gchar *  text, GtkIMHtmlOptions  options, GtkTextIter *  iter )

Inserts HTML formatted text to a GTK IM/HTML at a given iter. Parameters: imhtml  The GTK IM/HTML. text  The formatted text to append. options  A GtkIMHtmlOptions object indicating insert behavior. iter  A GtkTextIter in the GTK IM/HTML at which to insert text.

void gtk_imhtml_insert_image_at_iter (  GtkIMHtml *  imhtml, int  id, GtkTextIter *  iter )

Inserts the IM/HTML scalable image with the given id at the given iter in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. id  The id of the IM/HTML scalable. iter  The GtkTextIter in the IM/HTML to insert the image at.

void gtk_imhtml_insert_link (  GtkIMHtml *  imhtml, GtkTextMark *  mark, const char *  url, const char *  text )

Inserts a link to the given url at the given GtkTextMark in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. mark  The GtkTextMark to insert the link at. url  The URL for the link. text  The string to use for the link description.

void gtk_imhtml_insert_smiley (  GtkIMHtml *  imhtml, const char *  sml, char *  smiley )

Inserts a smiley at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. sml  The category of the smiley. smiley  The text of the smiley to insert.

void gtk_imhtml_insert_smiley_at_iter (  GtkIMHtml *  imhtml, const char *  sml, char *  smiley, GtkTextIter *  iter )

Inserts a smiley at the given iter in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. sml  The category of the smiley. smiley  The text of the smiley to insert. iter  The GtkTextIter in the IM/HTML to insert the smiley at.

GtkWidget* gtk_imhtml_new (  void *  , void *  )

Creates and returns a new GTK IM/HTML widget. Returns: The GTK IM/HTML widget created.

void gtk_imhtml_page_down (  GtkIMHtml *  imhtml  )

Scrolls a GTK IM/HTML down by one page. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_page_up (  GtkIMHtml *  imhtml  )

Scrolls a GTK IM/HTML up by one page. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_remove_smileys (  GtkIMHtml *  imhtml  )

Removes all smileys associated with a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML.

GtkIMHtmlScalable* gtk_imhtml_scalable_new (   )

Creates and returns an new GTK IM/HTML scalable object. Returns: A new IM/HTML Scalable object.

void gtk_imhtml_scroll_to_end (  GtkIMHtml *  imhtml  )

Scrolls a GTK IM/HTML to the end of its contents. Parameters: imhtml  The GTK IM/HTML.

void gtk_imhtml_search_clear (  GtkIMHtml *  imhtml  )

Clears the highlighting from a prior search in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML.

gboolean gtk_imhtml_search_find (  GtkIMHtml *  imhtml, const gchar *  text )

Finds and highlights a given string in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. text  The string to search for. Returns: TRUE if a search was performed, or FALSE if not.

void gtk_imhtml_set_editable (  GtkIMHtml *  imhtml, gboolean  editable )

Enables or disables editing in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. editable  TRUE to make the widget editable, or FALSE otherwise.

void gtk_imhtml_set_format_functions (  GtkIMHtml *  imhtml, GtkIMHtmlButtons  buttons )

Indicates which formatting functions to enable and disable in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. buttons  A GtkIMHtmlButtons bitmask indicating which functions to use.

void gtk_imhtml_set_funcs (  GtkIMHtml *  imhtml, GtkIMHtmlFuncs *  f )

Sets the function callbacks to use with a GTK IM/HTML instance. Parameters: imhtml  The GTK IM/HTML. f  The GtkIMHTMLFuncs struct containing the functions to use.

void gtk_imhtml_set_protocol_name (  GtkIMHtml *  imhtml, const gchar *  protocol_name )

Associates a protocol name with a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. protocol_name  The protocol name to associate with the IM/HTML.

void gtk_imhtml_set_whole_buffer_formatting_only (  GtkIMHtml *  imhtml, gboolean  wbfo )

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. Parameters: imhtml  The GTK IM/HTML. wbfo  TRUE to enable the mode, or FALSE otherwise.

void gtk_imhtml_show_comments (  GtkIMHtml *  imhtml, gboolean  show )

Enables or disables showing the contents of HTML comments in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. show  TRUE if comments should be shown, or FALSE otherwise.

void gtk_imhtml_smiley_shortcuts (  GtkIMHtml *  imhtml, gboolean  allow )

Enables or disables smiley insertion shortcut keys in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. allow  TRUE if shortcut keys are allowed, or FALSE otherwise.

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. Parameters: imhtml  The GTK IM/HTML. color  The HTML-style color, or NULL or "" to clear the color. Returns: TRUE if a color was set, or FALSE if it was cleared.

gboolean gtk_imhtml_toggle_bold (  GtkIMHtml *  imhtml  )

Toggles bold at the cursor location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: TRUE if bold was turned on, or FALSE if it was turned off.

gboolean gtk_imhtml_toggle_fontface (  GtkIMHtml *  imhtml, const char *  face )

Toggles a font face at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. face  The font face name, or NULL or "" to clear the font. Returns: TRUE if a font name was set, or FALSE if it was cleared.

gboolean gtk_imhtml_toggle_forecolor (  GtkIMHtml *  imhtml, const char *  color )

Toggles a foreground color at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. color  The HTML-style color, or NULL or "" to clear the color. Returns: TRUE if a color was set, or FALSE if it was cleared.

gboolean gtk_imhtml_toggle_italic (  GtkIMHtml *  imhtml  )

Toggles italic at the cursor location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: TRUE if italic was turned on, or FALSE if it was turned off.

void gtk_imhtml_toggle_link (  GtkIMHtml *  imhtml, const char *  url )

Toggles a link tag with the given URL at the current location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. url  The URL for the link or NULL to terminate the link.

gboolean gtk_imhtml_toggle_strike (  GtkIMHtml *  imhtml  )

Toggles strikethrough at the cursor location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: TRUE if strikethrough was turned on, or FALSE if it was turned off.

gboolean gtk_imhtml_toggle_underline (  GtkIMHtml *  imhtml  )

Toggles underline at the cursor location or selection in a GTK IM/HTML. Parameters: imhtml  The GTK IM/HTML. Returns: TRUE if underline was turned on, or FALSE if it was turned off.

---