Mercurial > pidgin.yaz
comparison pidgin/gtkwebview.h @ 32746:6fb2b4b44934
Clean up documentation.
author | Elliott Sales de Andrade <qulogic@pidgin.im> |
---|---|
date | Sat, 15 Oct 2011 23:25:32 +0000 |
parents | 68fe7b5211a7 |
children |
comparison
equal
deleted
inserted
replaced
32745:1cec4425d0cc | 32746:6fb2b4b44934 |
---|---|
62 | 62 |
63 | 63 |
64 /** | 64 /** |
65 * Returns the GType for a GtkWebView widget | 65 * Returns the GType for a GtkWebView widget |
66 * | 66 * |
67 * @return the GType for GtkWebView widget | 67 * @return The GType for GtkWebView widget |
68 */ | 68 */ |
69 GType gtk_webview_get_type(void); | 69 GType gtk_webview_get_type(void); |
70 | 70 |
71 /** | 71 /** |
72 * Create a new GtkWebView object | 72 * Create a new GtkWebView object |
73 * | 73 * |
74 * @return a GtkWidget corresponding to the GtkWebView object | 74 * @return A GtkWidget corresponding to the GtkWebView object |
75 */ | 75 */ |
76 GtkWidget *gtk_webview_new(void); | 76 GtkWidget *gtk_webview_new(void); |
77 | 77 |
78 /** | 78 /** |
79 * Set the vertical adjustment for the GtkWebView. | 79 * Set the vertical adjustment for the GtkWebView. |
80 * | 80 * |
81 * @param webview The GtkWebView. | 81 * @param webview The GtkWebView object |
82 * @param vadj The GtkAdjustment that control the webview. | 82 * @param vadj The GtkAdjustment that control the webview |
83 */ | 83 */ |
84 void gtk_webview_set_vadjustment(GtkWebView *webview, GtkAdjustment *vadj); | 84 void gtk_webview_set_vadjustment(GtkWebView *webview, GtkAdjustment *vadj); |
85 | 85 |
86 /** | 86 /** |
87 * A very basic routine to append html, which can be considered | 87 * A very basic routine to append html, which can be considered |
107 * since the last clear or since the Widget was created. So it does not | 107 * since the last clear or since the Widget was created. So it does not |
108 * test for load_string's called in between. | 108 * test for load_string's called in between. |
109 * | 109 * |
110 * @param webview The GtkWebView object | 110 * @param webview The GtkWebView object |
111 * | 111 * |
112 * @return gboolean indicating whether the webview is empty. | 112 * @return gboolean indicating whether the webview is empty |
113 */ | 113 */ |
114 gboolean gtk_webview_is_empty(GtkWebView *webview); | 114 gboolean gtk_webview_is_empty(GtkWebView *webview); |
115 | 115 |
116 /** | 116 /** |
117 * Execute the JavaScript only after the webkit_webview_load_string | 117 * Execute the JavaScript only after the webkit_webview_load_string |
118 * loads completely. We also guarantee that the scripts are executed | 118 * loads completely. We also guarantee that the scripts are executed |
119 * in the order they are called here. This is useful to avoid race | 119 * in the order they are called here. This is useful to avoid race |
120 * conditions when calling JS functions immediately after opening the | 120 * conditions when calling JS functions immediately after opening the |
121 * page. | 121 * page. |
122 * | 122 * |
123 * @param webview the GtkWebView object | 123 * @param webview The GtkWebView object |
124 * @param script the script to execute | 124 * @param script The script to execute |
125 */ | 125 */ |
126 void gtk_webview_safe_execute_script(GtkWebView *webview, const char *script); | 126 void gtk_webview_safe_execute_script(GtkWebView *webview, const char *script); |
127 | 127 |
128 /** | 128 /** |
129 * A convenience routine to quote a string for use as a JavaScript | 129 * A convenience routine to quote a string for use as a JavaScript |
130 * string. For instance, "hello 'world'" becomes "'hello \\'world\\''" | 130 * string. For instance, "hello 'world'" becomes "'hello \\'world\\''" |
131 * | 131 * |
132 * @param str The string to escape and quote | 132 * @param str The string to escape and quote |
133 * | 133 * |
134 * @return the quoted string. | 134 * @return The quoted string |
135 */ | 135 */ |
136 char *gtk_webview_quote_js_string(const char *str); | 136 char *gtk_webview_quote_js_string(const char *str); |
137 | 137 |
138 /** | 138 /** |
139 * Scrolls the Webview to the end of its contents. | 139 * Scrolls the Webview to the end of its contents. |
140 * | 140 * |
141 * @param webview The GtkWebView. | 141 * @param webview The GtkWebView object |
142 * @param smooth A boolean indicating if smooth scrolling should be used. | 142 * @param smooth A boolean indicating if smooth scrolling should be used |
143 */ | 143 */ |
144 void gtk_webview_scroll_to_end(GtkWebView *webview, gboolean smooth); | 144 void gtk_webview_scroll_to_end(GtkWebView *webview, gboolean smooth); |
145 | 145 |
146 #endif /* _PIDGIN_WEBVIEW_H_ */ | 146 #endif /* _PIDGIN_WEBVIEW_H_ */ |
147 | 147 |