Mercurial > pidgin.yaz

comparison pidgin/gtkimhtml.h @ 32687:02a2e8183b1d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clean the API documentation in preparation for 3.0.0 by removing all the old @since tags.
author andrew.victor@mxit.com
date Sun, 25 Sep 2011 18:56:58 +0000
parents 3340d322c8f8
children 1cec4425d0cc
comparison
equal deleted inserted replaced
32685:9d5b87e1a4d0 32687:02a2e8183b1d
56 typedef struct _GtkIMHtmlImage GtkIMHtmlImage; 56 typedef struct _GtkIMHtmlImage GtkIMHtmlImage;
57 typedef struct _GtkIMHtmlAnimation GtkIMHtmlAnimation; 57 typedef struct _GtkIMHtmlAnimation GtkIMHtmlAnimation;
58 typedef struct _GtkIMHtmlHr GtkIMHtmlHr; 58 typedef struct _GtkIMHtmlHr GtkIMHtmlHr;
59 typedef struct _GtkIMHtmlFuncs GtkIMHtmlFuncs; 59 typedef struct _GtkIMHtmlFuncs GtkIMHtmlFuncs;
60 60
61 /**
62 * @since 2.6.0
63 */
64 typedef struct _GtkIMHtmlLink GtkIMHtmlLink; 61 typedef struct _GtkIMHtmlLink GtkIMHtmlLink;
65 62
66 typedef enum { 63 typedef enum {
67 GTK_IMHTML_BOLD = 1 << 0, 64 GTK_IMHTML_BOLD = 1 << 0,
68 GTK_IMHTML_ITALIC = 1 << 1, 65 GTK_IMHTML_ITALIC = 1 << 1,
76 GTK_IMHTML_LINK = 1 << 9, 73 GTK_IMHTML_LINK = 1 << 9,
77 GTK_IMHTML_IMAGE = 1 << 10, 74 GTK_IMHTML_IMAGE = 1 << 10,
78 GTK_IMHTML_SMILEY = 1 << 11, 75 GTK_IMHTML_SMILEY = 1 << 11,
79 GTK_IMHTML_LINKDESC = 1 << 12, 76 GTK_IMHTML_LINKDESC = 1 << 12,
80 GTK_IMHTML_STRIKE = 1 << 13, 77 GTK_IMHTML_STRIKE = 1 << 13,
81 /** Show custom smileys when appropriate. @since 2.5.0 */ 78 /** Show custom smileys when appropriate. */
82 GTK_IMHTML_CUSTOM_SMILEY = 1 << 14, 79 GTK_IMHTML_CUSTOM_SMILEY = 1 << 14,
83 GTK_IMHTML_ALL = -1 80 GTK_IMHTML_ALL = -1
84 } GtkIMHtmlButtons; 81 } GtkIMHtmlButtons;
85 82
86 typedef enum { 83 typedef enum {
164 gboolean hidden; 161 gboolean hidden;
165 GdkPixbufLoader *loader; 162 GdkPixbufLoader *loader;
166 GSList *anchors; 163 GSList *anchors;
167 GtkIMHtmlSmileyFlags flags; 164 GtkIMHtmlSmileyFlags flags;
168 GtkIMHtml *imhtml; 165 GtkIMHtml *imhtml;
169 gpointer data; /** @since 2.6.0 */ 166 gpointer data;
170 gsize datasize; /** @since 2.6.0 */ 167 gsize datasize;
171 }; 168 };
172 169
173 struct _GtkIMHtmlScalable { 170 struct _GtkIMHtmlScalable {
174 void (*scale)(struct _GtkIMHtmlScalable *, int, int); 171 void (*scale)(struct _GtkIMHtmlScalable *, int, int);
175 void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *); 172 void (*add_to)(struct _GtkIMHtmlScalable *, GtkIMHtml *, GtkTextIter *);
764 /** 761 /**
765 * Setup formatting for an imhtml depending on the flags specified. 762 * Setup formatting for an imhtml depending on the flags specified.
766 * 763 *
767 * @param imhtml The GTK+ IM/HTML. 764 * @param imhtml The GTK+ IM/HTML.
768 * @param flags The connection flag which describes the allowed types of formatting. 765 * @param flags The connection flag which describes the allowed types of formatting.
769 *
770 * @since 2.1.0
771 */ 766 */
772 void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags); 767 void gtk_imhtml_setup_entry(GtkIMHtml *imhtml, PurpleConnectionFlags flags);
773 768
774 /** 769 /**
775 * Create a new GtkIMHtmlSmiley. 770 * Create a new GtkIMHtmlSmiley.
778 * @param shortcut The key shortcut for the smiley 773 * @param shortcut The key shortcut for the smiley
779 * @param hide @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise 774 * @param hide @c TRUE if the smiley should be hidden in the smiley dialog, @c FALSE otherwise
780 * @param flags The smiley flags 775 * @param flags The smiley flags
781 * 776 *
782 * @return The newly created smiley 777 * @return The newly created smiley
783 * @since 2.5.0
784 */ 778 */
785 GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide, 779 GtkIMHtmlSmiley *gtk_imhtml_smiley_create(const char *file, const char *shortcut, gboolean hide,
786 GtkIMHtmlSmileyFlags flags); 780 GtkIMHtmlSmileyFlags flags);
787 781
788 /** 782 /**
789 * Reload the image data for the smiley. 783 * Reload the image data for the smiley.
790 * 784 *
791 * @param smiley The smiley to reload 785 * @param smiley The smiley to reload
792 *
793 * @since 2.5.0
794 */ 786 */
795 void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley); 787 void gtk_imhtml_smiley_reload(GtkIMHtmlSmiley *smiley);
796 788
797 /** 789 /**
798 * Destroy a GtkIMHtmlSmiley. 790 * Destroy a GtkIMHtmlSmiley.
799 * 791 *
800 * @param smiley The smiley to destroy 792 * @param smiley The smiley to destroy
801 *
802 * @since 2.5.0
803 */ 793 */
804 void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley); 794 void gtk_imhtml_smiley_destroy(GtkIMHtmlSmiley *smiley);
805 795
806 /** 796 /**
807 * Register a protocol with the GtkIMHtml widget. Registering a protocol would 797 * Register a protocol with the GtkIMHtml widget. Registering a protocol would
816 * up on the protocol text. The callback should return 806 * up on the protocol text. The callback should return
817 * @c TRUE if the request for context menu was processed 807 * @c TRUE if the request for context menu was processed
818 * successfully, @c FALSE otherwise. 808 * successfully, @c FALSE otherwise.
819 * 809 *
820 * @return @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL) 810 * @return @c TRUE if the protocol was successfully registered (or unregistered, when \a activate is @c NULL)
821 *
822 * @since 2.6.0
823 */ 811 */
824 gboolean gtk_imhtml_class_register_protocol(const char *name, 812 gboolean gtk_imhtml_class_register_protocol(const char *name,
825 gboolean (*activate)(GtkIMHtml *imhtml, GtkIMHtmlLink *link), 813 gboolean (*activate)(GtkIMHtml *imhtml, GtkIMHtmlLink *link),
826 gboolean (*context_menu)(GtkIMHtml *imhtml, GtkIMHtmlLink *link, GtkWidget *menu)); 814 gboolean (*context_menu)(GtkIMHtml *imhtml, GtkIMHtmlLink *link, GtkWidget *menu));
827 815
829 * Get the URL associated with a link. This should be used by the IMHtml protocol-callbacks. 817 * Get the URL associated with a link. This should be used by the IMHtml protocol-callbacks.
830 * 818 *
831 * @param link The GtkIMHtmlLink object sent to the callback functions 819 * @param link The GtkIMHtmlLink object sent to the callback functions
832 * 820 *
833 * @return The URL 821 * @return The URL
834 *
835 * @since 2.6.0
836 */ 822 */
837 const char *gtk_imhtml_link_get_url(GtkIMHtmlLink *link); 823 const char *gtk_imhtml_link_get_url(GtkIMHtmlLink *link);
838 824
839 /** 825 /**
840 * Get the GtkTextTag object (if any) associated with a particular link. 826 * Get the GtkTextTag object (if any) associated with a particular link.
841 * 827 *
842 * @param link The GtkIMHtmlLink object sent to the callback functions 828 * @param link The GtkIMHtmlLink object sent to the callback functions
843 * 829 *
844 * @return The GtkTextTag object, or @c NULL 830 * @return The GtkTextTag object, or @c NULL
845 *
846 * @since 2.6.0
847 */ 831 */
848 const GtkTextTag *gtk_imhtml_link_get_text_tag(GtkIMHtmlLink *link); 832 const GtkTextTag *gtk_imhtml_link_get_text_tag(GtkIMHtmlLink *link);
849 833
850 /** 834 /**
851 * Activates a GtkIMHtmlLink object. This triggers the 'url-clicked' signal, marks the 835 * Activates a GtkIMHtmlLink object. This triggers the 'url-clicked' signal, marks the
852 * link as visited (when possible). 836 * link as visited (when possible).
853 * 837 *
854 * @param link The GtkIMHtmlLink object sent to the callback functions 838 * @param link The GtkIMHtmlLink object sent to the callback functions
855 * 839 *
856 * @return @c TRUE if 'url-clicked' signal was emitted, @c FALSE otherwise. 840 * @return @c TRUE if 'url-clicked' signal was emitted, @c FALSE otherwise.
857 *
858 * @since 2.6.0
859 */ 841 */
860 gboolean gtk_imhtml_link_activate(GtkIMHtmlLink *link); 842 gboolean gtk_imhtml_link_activate(GtkIMHtmlLink *link);
861 843
862 /** 844 /**
863 * By default this widget intercepts presses of the "return" key and 845 * By default this widget intercepts presses of the "return" key and