Mercurial > pidgin.yaz

comparison pidgin/gtkblist-theme.h @ 26751:b1c8ffbd48f9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix more `make docs` warnings
author Paul Aurich <paul@darkrain42.org>
date Thu, 12 Mar 2009 03:54:11 +0000
parents 0c7b74fc558e
children 872d30754311
comparison
equal deleted inserted replaced
26750:f916afb91566 26751:b1c8ffbd48f9
100 /* get methods */ 100 /* get methods */
101 101
102 /** 102 /**
103 * Returns the background color of the buddy list. 103 * Returns the background color of the buddy list.
104 * 104 *
105 * @param theme The theme.
106 *
105 * @returns A gdk color. 107 * @returns A gdk color.
106 */ 108 */
107 GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme); 109 GdkColor *pidgin_blist_theme_get_background_color(PidginBlistTheme *theme);
108 110
109 /** 111 /**
110 * Returns the opacity of the buddy list window 112 * Returns the opacity of the buddy list window
111 * (0.0 or clear to 1.0 fully opaque). 113 * (0.0 or clear to 1.0 fully opaque).
112 * 114 *
115 * @param theme The theme.
116 *
113 * @returns The opacity 117 * @returns The opacity
114 */ 118 */
115 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme); 119 gdouble pidgin_blist_theme_get_opacity(PidginBlistTheme *theme);
116 120
117 /** 121 /**
118 * Returns the layout to be used with the buddy list. 122 * Returns the layout to be used with the buddy list.
119 * 123 *
124 * @param theme The theme.
125 *
120 * @returns The buddy list layout. 126 * @returns The buddy list layout.
121 */ 127 */
122 PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme); 128 PidginBlistLayout *pidgin_blist_theme_get_layout(PidginBlistTheme *theme);
123 129
124 /** 130 /**
125 * Returns the background color to be used with expanded groups. 131 * Returns the background color to be used with expanded groups.
126 * 132 *
133 * @param theme The theme.
134 *
127 * @returns A gdk color. 135 * @returns A gdk color.
128 */ 136 */
129 GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme); 137 GdkColor *pidgin_blist_theme_get_expanded_background_color(PidginBlistTheme *theme);
130 138
131 /** 139 /**
132 * Returns the text font and color to be used with expanded groups. 140 * Returns the text font and color to be used with expanded groups.
133 * 141 *
142 * @param theme The theme.
143 *
134 * @returns A font and color pair. 144 * @returns A font and color pair.
135 */ 145 */
136 FontColorPair *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme); 146 FontColorPair *pidgin_blist_theme_get_expanded_text_info(PidginBlistTheme *theme);
137 147
138 /** 148 /**
139 * Returns the background color to be used with collapsed groups. 149 * Returns the background color to be used with collapsed groups.
140 * 150 *
151 * @param theme The theme.
152 *
141 * @returns A gdk color. 153 * @returns A gdk color.
142 */ 154 */
143 GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme); 155 GdkColor *pidgin_blist_theme_get_collapsed_background_color(PidginBlistTheme *theme);
144 156
145 /** 157 /**
146 * Returns the text font and color to be used with collapsed groups. 158 * Returns the text font and color to be used with collapsed groups.
147 * 159 *
160 * @param theme The theme.
161 *
148 * @returns A font and color pair. 162 * @returns A font and color pair.
149 */ 163 */
150 FontColorPair *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme); 164 FontColorPair *pidgin_blist_theme_get_collapsed_text_info(PidginBlistTheme *theme);
151 165
152 /** 166 /**
153 * Returns the colors to be used for contacts and chats. 167 * Returns the colors to be used for contacts and chats.
154 * 168 *
169 * @param theme The theme.
170 *
155 * @returns A gdkcolor for contacts and chats. 171 * @returns A gdkcolor for contacts and chats.
156 */ 172 */
157 GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme); 173 GdkColor *pidgin_blist_theme_get_contact_color(PidginBlistTheme *theme);
158 174
159 /** 175 /**
160 * Returns the text font and color to be used for expanded contacts. 176 * Returns the text font and color to be used for expanded contacts.
161 * 177 *
178 * @param theme The theme.
179 *
162 * @returns A font and color pair. 180 * @returns A font and color pair.
163 */ 181 */
164 FontColorPair *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme); 182 FontColorPair *pidgin_blist_theme_get_contact_text_info(PidginBlistTheme *theme);
165 183
166 /** 184 /**
167 * Returns the text font and color to be used for online buddies. 185 * Returns the text font and color to be used for online buddies.
168 * 186 *
187 * @param theme The theme.
188 *
169 * @returns A font and color pair. 189 * @returns A font and color pair.
170 */ 190 */
171 FontColorPair *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme); 191 FontColorPair *pidgin_blist_theme_get_online_text_info(PidginBlistTheme *theme);
172 192
173 /** 193 /**
174 * Returns the text font and color to be used for away and idle buddies. 194 * Returns the text font and color to be used for away and idle buddies.
175 * 195 *
196 * @param theme The theme.
197 *
176 * @returns A font and color pair. 198 * @returns A font and color pair.
177 */ 199 */
178 FontColorPair *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme); 200 FontColorPair *pidgin_blist_theme_get_away_text_info(PidginBlistTheme *theme);
179 201
180 /** 202 /**
181 * Returns the text font and color to be used for offline buddies. 203 * Returns the text font and color to be used for offline buddies.
182 * 204 *
205 * @param theme The theme.
206 *
183 * @returns A font and color pair. 207 * @returns A font and color pair.
184 */ 208 */
185 FontColorPair *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme); 209 FontColorPair *pidgin_blist_theme_get_offline_text_info(PidginBlistTheme *theme);
186 210
187 /** 211 /**
188 * Returns the text font and color to be used for idle buddies. 212 * Returns the text font and color to be used for idle buddies.
189 * 213 *
214 * @param theme The theme.
215 *
190 * @returns A font and color pair. 216 * @returns A font and color pair.
191 */ 217 */
192 FontColorPair *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme); 218 FontColorPair *pidgin_blist_theme_get_idle_text_info(PidginBlistTheme *theme);
193 219
194 /** 220 /**
195 * Returns the text font and color to be used for buddies with unread messages. 221 * Returns the text font and color to be used for buddies with unread messages.
222 *
223 * @param theme The theme.
196 * 224 *
197 * @returns A font and color pair. 225 * @returns A font and color pair.
198 */ 226 */
199 FontColorPair *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme); 227 FontColorPair *pidgin_blist_theme_get_unread_message_text_info(PidginBlistTheme *theme);
200 228
201 /** 229 /**
202 * Returns the text font and color to be used for chats with unread messages 230 * Returns the text font and color to be used for chats with unread messages
203 * that mention your nick. 231 * that mention your nick.
204 * 232 *
233 * @param theme The theme.
234 *
205 * @returns A font and color pair. 235 * @returns A font and color pair.
206 */ 236 */
207 FontColorPair *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme); 237 FontColorPair *pidgin_blist_theme_get_unread_message_nick_said_text_info(PidginBlistTheme *theme);
208 238
209 /** 239 /**
210 * Returns the text font and color to be used for a buddy's status message. 240 * Returns the text font and color to be used for a buddy's status message.
211 * 241 *
242 * @param theme The theme.
243 *
212 * @returns A font and color pair. 244 * @returns A font and color pair.
213 */ 245 */
214 FontColorPair *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme); 246 FontColorPair *pidgin_blist_theme_get_status_text_info(PidginBlistTheme *theme);
215 247
216 /* Set Methods */ 248 /* Set Methods */
217 249
218 /** 250 /**
219 * Sets the background color to be used for this buddy list theme. 251 * Sets the background color to be used for this buddy list theme.
220 * 252 *
253 * @param theme The theme.
221 * @param color The new background color. 254 * @param color The new background color.
222 */ 255 */
223 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, GdkColor *color); 256 void pidgin_blist_theme_set_background_color(PidginBlistTheme *theme, GdkColor *color);
224 257
225 /** 258 /**
226 * Sets the opacity to be used for this buddy list theme. 259 * Sets the opacity to be used for this buddy list theme.
227 * 260 *
261 * @param theme The theme.
228 * @param opacity The new opacity setting. 262 * @param opacity The new opacity setting.
229 */ 263 */
230 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity); 264 void pidgin_blist_theme_set_opacity(PidginBlistTheme *theme, gdouble opacity);
231 265
232 /** 266 /**
233 * Sets the buddy list layout to be used for this buddy list theme. 267 * Sets the buddy list layout to be used for this buddy list theme.
234 * 268 *
269 * @param theme The theme.
235 * @param layout The new layout. 270 * @param layout The new layout.
236 */ 271 */
237 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, PidginBlistLayout *layout); 272 void pidgin_blist_theme_set_layout(PidginBlistTheme *theme, PidginBlistLayout *layout);
238 273
239 /** 274 /**
240 * Sets the background color to be used for expanded groups. 275 * Sets the background color to be used for expanded groups.
241 * 276 *
277 * @param theme The theme.
242 * @param color The new background color. 278 * @param color The new background color.
243 */ 279 */
244 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, GdkColor *color); 280 void pidgin_blist_theme_set_expanded_background_color(PidginBlistTheme *theme, GdkColor *color);
245 281
246 /** 282 /**
247 * Sets the text color and font to be used for expanded groups. 283 * Sets the text color and font to be used for expanded groups.
248 * 284 *
249 * @param pair The new text font at color pair. 285 * @param theme The theme.
286 * @param pair The new text font and color pair.
250 */ 287 */
251 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, FontColorPair *pair); 288 void pidgin_blist_theme_set_expanded_text_info(PidginBlistTheme *theme, FontColorPair *pair);
252 289
253 /** 290 /**
254 * Sets the background color to be used for collapsed groups. 291 * Sets the background color to be used for collapsed groups.
255 * 292 *
293 * @param theme The theme.
256 * @param color The new background color. 294 * @param color The new background color.
257 */ 295 */
258 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, GdkColor *color); 296 void pidgin_blist_theme_set_collapsed_background_color(PidginBlistTheme *theme, GdkColor *color);
259 297
260 /** 298 /**
261 * Sets the text color and font to be used for expanded groups. 299 * Sets the text color and font to be used for expanded groups.
262 * 300 *
263 * @param pair The new text font at color pair. 301 * @param theme The theme.
302 * @param pair The new text font and color pair.
264 */ 303 */
265 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, FontColorPair *pair); 304 void pidgin_blist_theme_set_collapsed_text_info(PidginBlistTheme *theme, FontColorPair *pair);
266 305
267 /** 306 /**
268 * Sets the background color to be used for contacts and chats. 307 * Sets the background color to be used for contacts and chats.
269 * 308 *
309 * @param theme The theme.
270 * @param color The color to use for contacts and chats. 310 * @param color The color to use for contacts and chats.
271 */ 311 */
272 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, GdkColor *color); 312 void pidgin_blist_theme_set_contact_color(PidginBlistTheme *theme, GdkColor *color);
273 313
274 /** 314 /**
275 * Sets the text color and font to be used for expanded contacts. 315 * Sets the text color and font to be used for expanded contacts.
276 * 316 *
277 * @param pair The new text font at color pair. 317 * @param theme The theme.
318 * @param pair The new text font and color pair.
278 */ 319 */
279 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, FontColorPair *pair); 320 void pidgin_blist_theme_set_contact_text_info(PidginBlistTheme *theme, FontColorPair *pair);
280 321
281 /** 322 /**
282 * Sets the text color and font to be used for online buddies. 323 * Sets the text color and font to be used for online buddies.
283 * 324 *
284 * @param pair The new text font at color pair. 325 * @param theme The theme.
326 * @param pair The new text font and color pair.
285 */ 327 */
286 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, FontColorPair *pair); 328 void pidgin_blist_theme_set_online_text_info(PidginBlistTheme *theme, FontColorPair *pair);
287 329
288 /** 330 /**
289 * Sets the text color and font to be used for away and idle buddies. 331 * Sets the text color and font to be used for away and idle buddies.
290 * 332 *
291 * @param pair The new text font at color pair. 333 * @param theme The theme.
334 * @param pair The new text font and color pair.
292 */ 335 */
293 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, FontColorPair *pair); 336 void pidgin_blist_theme_set_away_text_info(PidginBlistTheme *theme, FontColorPair *pair);
294 337
295 /** 338 /**
296 * Sets the text color and font to be used for offline buddies. 339 * Sets the text color and font to be used for offline buddies.
297 * 340 *
298 * @param pair The new text font at color pair. 341 * @param theme The theme.
342 * @param pair The new text font and color pair.
299 */ 343 */
300 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, FontColorPair *pair); 344 void pidgin_blist_theme_set_offline_text_info(PidginBlistTheme *theme, FontColorPair *pair);
301 345
302 /** 346 /**
303 * Sets the text color and font to be used for idle buddies. 347 * Sets the text color and font to be used for idle buddies.
304 * 348 *
305 * @param pair The new text font at color pair. 349 * @param theme The theme.
350 * @param pair The new text font and color pair.
306 */ 351 */
307 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, FontColorPair *pair); 352 void pidgin_blist_theme_set_idle_text_info(PidginBlistTheme *theme, FontColorPair *pair);
308 353
309 /** 354 /**
310 * Sets the text color and font to be used for buddies with unread messages. 355 * Sets the text color and font to be used for buddies with unread messages.
311 * 356 *
312 * @param pair The new text font at color pair. 357 * @param theme The theme.
358 * @param pair The new text font and color pair.
313 */ 359 */
314 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, FontColorPair *pair); 360 void pidgin_blist_theme_set_unread_message_text_info(PidginBlistTheme *theme, FontColorPair *pair);
315 361
316 /** 362 /**
317 * Sets the text color and font to be used for a chat with unread messages 363 * Sets the text color and font to be used for a chat with unread messages
318 * that mention your nick. 364 * that mention your nick.
319 * 365 *
320 * @param pair The new text font at color pair. 366 * @param theme The theme.
367 * @param pair The new text font and color pair.
321 */ 368 */
322 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, FontColorPair *pair); 369 void pidgin_blist_theme_set_unread_message_nick_said_text_info(PidginBlistTheme *theme, FontColorPair *pair);
323 370
324 /** 371 /**
325 * Sets the text color and font to be used for buddy status messages. 372 * Sets the text color and font to be used for buddy status messages.
326 * 373 *
327 * @param pair The new text font at color pair. 374 * @param theme The theme.
375 * @param pair The new text font and color pair.
328 */ 376 */
329 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, FontColorPair *pair); 377 void pidgin_blist_theme_set_status_text_info(PidginBlistTheme *theme, FontColorPair *pair);
330 378
331 G_END_DECLS 379 G_END_DECLS
332 #endif /* PIDGIN_BLIST_THEME_H */ 380 #endif /* PIDGIN_BLIST_THEME_H */