Mercurial > pidgin
diff src/gtkimhtml.h @ 10814:364a2ef907ae
[gaim-migrate @ 12468]
same thing here, changing to consistently using GTK+, by rlaager
committer: Tailor Script <tailor@pidgin.im>
| author | Luke Schierer <lschiere@pidgin.im> |
|---|---|
| date | Mon, 11 Apr 2005 12:24:47 +0000 |
| parents | 6f67d4088da0 |
| children | 409d6a11da51 |
line wrap: on
line diff
--- a/src/gtkimhtml.h Mon Apr 11 12:11:11 2005 +0000 +++ b/src/gtkimhtml.h Mon Apr 11 12:24:47 2005 +0000 @@ -245,16 +245,16 @@ GType gtk_imhtml_get_type(void); /** - * Creates and returns a new GTK IM/HTML widget. + * Creates and returns a new GTK+ IM/HTML widget. * - * @return The GTK IM/HTML widget created. + * @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 imhtml The GTK+ IM/HTML. * @param sml The name of the smiley category. * @param text The text associated with the smiley. */ @@ -264,49 +264,49 @@ /** - * Associates a smiley with a GTK IM/HTML. + * Associates a smiley with a GTK+ IM/HTML. * - * @param imhtml The 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. + * Removes all smileys associated with a GTK+ IM/HTML. * - * @param imhtml The 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. + * Sets the function callbacks to use with a GTK+ IM/HTML instance. * - * @param imhtml The GTK IM/HTML. + * @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. + * Enables or disables showing the contents of HTML comments in a GTK+ IM/HTML. * - * @param imhtml The 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); /** - * Associates a protocol name with a GTK IM/HTML. + * Associates a protocol name with a GTK+ IM/HTML. * - * @param imhtml The 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. + * Appends HTML formatted text to a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * @param text The formatted text to append. * @param options A GtkIMHtmlOptions object indicating insert behavior. */ @@ -314,9 +314,9 @@ gtk_imhtml_append_text_with_images(imhtml, text, options, NULL) /** - * Appends HTML formatted text to a GTK IM/HTML. + * Appends HTML formatted text to a GTK+ IM/HTML. * - * @param imhtml The 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. @@ -327,12 +327,12 @@ GSList *unused); /** - * Inserts HTML formatted text to a GTK IM/HTML at a given iter. + * Inserts HTML formatted text to a GTK+ IM/HTML at a given iter. * - * @param imhtml The 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 iter A GtkTextIter in the GTK IM/HTML at which to insert text. + * @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, @@ -340,42 +340,42 @@ GtkTextIter *iter); /** - * Scrolls a GTK IM/HTML to the end of its contents. + * Scrolls a GTK+ IM/HTML to the end of its contents. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. */ void gtk_imhtml_scroll_to_end(GtkIMHtml *imhtml); /** - * Purges the contents from a GTK IM/HTML and resets formatting. + * Purges the contents from a GTK+ IM/HTML and resets formatting. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. */ void gtk_imhtml_clear(GtkIMHtml *imhtml); /** - * Scrolls a GTK IM/HTML up by one page. + * Scrolls a GTK+ IM/HTML up by one page. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. */ void gtk_imhtml_page_up(GtkIMHtml *imhtml); /** - * Scrolls a GTK IM/HTML down by one page. + * Scrolls a GTK+ IM/HTML down by one page. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. */ void gtk_imhtml_page_down(GtkIMHtml *imhtml); /** - * Creates and returns an new GTK IM/HTML scalable object. + * Creates and returns an new GTK+ IM/HTML scalable object. * * @return A new IM/HTML Scalable object. */ GtkIMHtmlScalable *gtk_imhtml_scalable_new(); /** - * Creates and returns an new GTK IM/HTML scalable object with an image. + * Creates and returns an 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. @@ -386,67 +386,67 @@ GtkIMHtmlScalable *gtk_imhtml_image_new(GdkPixbuf *img, const gchar *filename, int id); /** - * Destroys and frees a GTK IM/HTML scalable image. + * Destroys and frees a GTK+ IM/HTML scalable image. * - * @param scale The GTK IM/HTML scalable. + * @param scale The GTK+ IM/HTML scalable. */ void gtk_imhtml_image_free(GtkIMHtmlScalable *scale); /** - * Rescales a GTK IM/HTML scalable image to a given size. + * Rescales a GTK+ IM/HTML scalable image to a given size. * - * @param scale The GTK IM/HTML scalable. + * @param scale The GTK+ IM/HTML scalable. * @param width The new width. * @param height The new height. */ 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. + * 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 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_image_add_to(GtkIMHtmlScalable *scale, GtkIMHtml *imhtml, GtkTextIter *iter); /** - * Creates and returns an new GTK IM/HTML scalable with a horizontal rule. + * 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(); /** - * Destroys and frees a GTK IM/HTML scalable horizontal rule. + * Destroys and frees a GTK+ IM/HTML scalable horizontal rule. * - * @param scale The GTK IM/HTML scalable. + * @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. + * Rescales a GTK+ IM/HTML scalable horizontal rule to a given size. * - * @param scale The GTK IM/HTML scalable. + * @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 + * 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 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. + * Finds and highlights a given string in a GTK+ IM/HTML. * - * @param imhtml The 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. @@ -454,42 +454,42 @@ gboolean gtk_imhtml_search_find(GtkIMHtml *imhtml, const gchar *text); /** - * Clears the highlighting from a prior search in a GTK IM/HTML. + * Clears the highlighting from a prior search in a GTK+ IM/HTML. * - * @param imhtml The 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. + * Enables or disables editing in a GTK+ IM/HTML. * - * @param imhtml The 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. + * 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 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. + * Indicates which formatting functions to enable and disable in a GTK+ IM/HTML. * - * @param imhtml The 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. + * Returns which formatting functions are enabled in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A GtkIMHtmlButtons bitmask indicating which functions to are enabled. */ @@ -497,9 +497,9 @@ /** * Sets each boolean to TRUE if that formatting option is enabled at the - * current position in a GTK IM/HTML. + * current position in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * @param bold A reference to a boolean for bold. * @param italic A reference to a boolean for italic. * @param underline A reference to a boolean for underline. @@ -508,9 +508,9 @@ /** * Returns a string containing the selected font face at the current position - * in a GTK IM/HTML. + * in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A string containg the font face or @c NULL if none is set. */ @@ -518,9 +518,9 @@ /** * Returns a string containing the selected foreground color at the current - * position in a GTK IM/HTML. + * position in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A string containg the foreground color or @c NULL if none is set. */ @@ -528,9 +528,9 @@ /** * Returns a string containing the selected font background color at the current - * position in a GTK IM/HTML. + * position in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A string containg the font background color or @c NULL if none is set. */ @@ -538,9 +538,9 @@ /** * Returns a string containing the selected background color at the current - * position in a GTK IM/HTML. + * position in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A string containg the background color or @c NULL if none is set. */ @@ -548,54 +548,54 @@ /** * Returns a integer containing the selected HTML font size at the current - * position in a GTK IM/HTML. + * position in a GTK+ IM/HTML. * - * @param imhtml The 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. + * Checks whether a GTK+ IM/HTML is marked as editable. * - * @param imhtml The GTK IM/HTML. + * @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); /** - * Toggles bold at the cursor location or selection in a GTK IM/HTML. + * Toggles bold at the cursor location or selection in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return @c TRUE if bold was turned on, or @c FALSE if it was turned off. */ gboolean gtk_imhtml_toggle_bold(GtkIMHtml *imhtml); /** - * Toggles italic at the cursor location or selection in a GTK IM/HTML. + * Toggles italic at the cursor location or selection in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return @c TRUE if italic was turned on, or @c FALSE if it was turned off. */ gboolean gtk_imhtml_toggle_italic(GtkIMHtml *imhtml); /** - * Toggles underline at the cursor location or selection in a GTK IM/HTML. + * Toggles underline at the cursor location or selection in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return @c TRUE if underline was turned on, or @c FALSE if it was turned off. */ gboolean gtk_imhtml_toggle_underline(GtkIMHtml *imhtml); /** - * Toggles strikethrough at the cursor location or selection in a GTK IM/HTML. + * Toggles strikethrough at the cursor location or selection in a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return @c TRUE if strikethrough was turned on, or @c FALSE if it was turned off. */ @@ -605,7 +605,7 @@ * Toggles a foreground color at the current location or selection in a GTK * IM/HTML. * - * @param imhtml The 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. @@ -616,7 +616,7 @@ * Toggles a background color at the current location or selection in a GTK * IM/HTML. * - * @param imhtml The 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. @@ -627,7 +627,7 @@ * Toggles a background color at the current location or selection in a GTK * IM/HTML. * - * @param imhtml The 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. @@ -635,9 +635,9 @@ 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. + * Toggles a font face at the current location or selection in a GTK+ IM/HTML. * - * @param imhtml The 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. @@ -646,17 +646,17 @@ /** * Toggles a link tag with the given URL at the current location or selection - * in a GTK IM/HTML. + * in a GTK+ IM/HTML. * - * @param imhtml The 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. + * Inserts a link to the given url at the given GtkTextMark in a GTK+ IM/HTML. * - * @param imhtml The 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. @@ -664,17 +664,17 @@ 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. + * Inserts a smiley at the current location or selection in a GTK+ IM/HTML. * - * @param imhtml The 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. + * Inserts a smiley at the given iter in a GTK+ IM/HTML. * - * @param imhtml The 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. @@ -683,18 +683,18 @@ /** * Inserts the IM/HTML scalable image with the given id at the given iter in a - * GTK IM/HTML. + * GTK+ IM/HTML. * - * @param imhtml The 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. + * Sets the font size at the current location or selection in a GTK+ IM/HTML. * - * @param imhtml The 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); @@ -703,7 +703,7 @@ * Decreases the font size by 1 at the current location or selection in a GTK * IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. */ void gtk_imhtml_font_shrink(GtkIMHtml *imhtml); @@ -711,14 +711,14 @@ * Increases the font size by 1 at the current location or selection in a GTK * IM/HTML. * - * @param imhtml The 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. + * Returns the HTML formatted contents between two iters in a GTK+ IM/HTML. * - * @param imhtml The 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. * @@ -727,9 +727,9 @@ char *gtk_imhtml_get_markup_range(GtkIMHtml *imhtml, GtkTextIter *start, GtkTextIter *end); /** - * Returns the entire HTML formatted contents of a GTK IM/HTML. + * Returns the entire HTML formatted contents of a GTK+ IM/HTML. * - * @param imhtml The GTK IM/HTML. + * @param imhtml The GTK+ IM/HTML. * * @return A string containing the HTML formatted text. */ @@ -739,17 +739,17 @@ * 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. + * @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. + * 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 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. *