pidgin/gtksmiley.h

branch
gtkdoc-conversion
changeset 35393
00f876b129bc
parent 32790
b95c7c504118
child 35394
38facb8226d4
child 37035
e85ed7f4d6e3
equal deleted inserted replaced
35392:cc123f0d84af 35393:00f876b129bc
35 35
36 /** 36 /**
37 * Add a PurpleSmiley to the GtkIMHtmlSmiley's list to be able to use it 37 * Add a PurpleSmiley to the GtkIMHtmlSmiley's list to be able to use it
38 * in pidgin 38 * in pidgin
39 * 39 *
40 * @param smiley The smiley to be added. 40 * @smiley: The smiley to be added.
41 */ 41 */
42 void pidgin_smiley_add_to_list(PurpleSmiley *smiley); 42 void pidgin_smiley_add_to_list(PurpleSmiley *smiley);
43 43
44 /** 44 /**
45 * Delete a PurpleSmiley from the GtkIMHtmlSmiley's list 45 * Delete a PurpleSmiley from the GtkIMHtmlSmiley's list
46 * 46 *
47 * @param smiley The smiley to be deleted. 47 * @smiley: The smiley to be deleted.
48 */ 48 */
49 void pidgin_smiley_del_from_list(PurpleSmiley *smiley); 49 void pidgin_smiley_del_from_list(PurpleSmiley *smiley);
50 50
51 /** 51 /**
52 * Load the GtkIMHtml list 52 * Load the GtkIMHtml list
59 void pidgin_smileys_uninit(void); 59 void pidgin_smileys_uninit(void);
60 60
61 /** 61 /**
62 * Returns a GSList with the GtkIMHtmlSmiley of each custom smiley 62 * Returns a GSList with the GtkIMHtmlSmiley of each custom smiley
63 * 63 *
64 * @constreturn A GtkIMHmlSmiley list 64 * Returns: (TODO const): A GtkIMHmlSmiley list
65 */ 65 */
66 GSList *pidgin_smileys_get_all(void); 66 GSList *pidgin_smileys_get_all(void);
67 67
68 /****************************************************************************** 68 /******************************************************************************
69 * Smiley Manager 69 * Smiley Manager
74 void pidgin_smiley_manager_show(void); 74 void pidgin_smiley_manager_show(void);
75 75
76 /** 76 /**
77 * Shows an editor for a smiley. 77 * Shows an editor for a smiley.
78 * 78 *
79 * @param widget The parent widget to be linked or @c NULL 79 * @widget: The parent widget to be linked or %NULL
80 * @param smiley The PurpleSmiley to be edited, or @c NULL for a new smiley 80 * @smiley: The PurpleSmiley to be edited, or %NULL for a new smiley
81 * @return The smiley add dialog 81 * Returns: The smiley add dialog
82 * 82 *
83 * @see pidgin_smiley_editor_set_shortcut 83 * @see pidgin_smiley_editor_set_shortcut
84 * @see pidgin_smiley_editor_set_image 84 * @see pidgin_smiley_editor_set_image
85 */ 85 */
86 PidginSmiley *pidgin_smiley_edit(GtkWidget *widget, PurpleSmiley *smiley); 86 PidginSmiley *pidgin_smiley_edit(GtkWidget *widget, PurpleSmiley *smiley);
87 87
88 /** 88 /**
89 * Set the shortcut in a smiley add dialog 89 * Set the shortcut in a smiley add dialog
90 * 90 *
91 * @param editor A smiley editor dialog (created by pidgin_smiley_edit) 91 * @editor: A smiley editor dialog (created by pidgin_smiley_edit)
92 * @param shortcut The shortcut to set 92 * @shortcut: The shortcut to set
93 */ 93 */
94 void pidgin_smiley_editor_set_shortcut(PidginSmiley *editor, const gchar *shortcut); 94 void pidgin_smiley_editor_set_shortcut(PidginSmiley *editor, const gchar *shortcut);
95 95
96 /** 96 /**
97 * Set the image in a smiley add dialog 97 * Set the image in a smiley add dialog
98 * 98 *
99 * @param editor A smiley editor dialog 99 * @editor: A smiley editor dialog
100 * @param image A GdkPixbuf image 100 * @image: A GdkPixbuf image
101 */ 101 */
102 void pidgin_smiley_editor_set_image(PidginSmiley *editor, GdkPixbuf *image); 102 void pidgin_smiley_editor_set_image(PidginSmiley *editor, GdkPixbuf *image);
103 103
104 /** 104 /**
105 * Sets the image data in a smiley add dialog 105 * Sets the image data in a smiley add dialog
106 * 106 *
107 * @param editor A smiley editor dialog 107 * @editor: A smiley editor dialog
108 * @param data A pointer to smiley's data 108 * @data: A pointer to smiley's data
109 * @param datasize The size of smiley's data 109 * @datasize: The size of smiley's data
110 */ 110 */
111 void pidgin_smiley_editor_set_data(PidginSmiley *editor, gpointer data, gsize datasize); 111 void pidgin_smiley_editor_set_data(PidginSmiley *editor, gpointer data, gsize datasize);
112 112
113 G_END_DECLS 113 G_END_DECLS
114 114

mercurial