Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkstatusicon.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkStatusIcon
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Display an icon in the system tray
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The "system tray" or notification area is normally used for transient icons
  10 that indicate some special state. For example, a system tray icon might
  11 appear to tell the user that they have new mail, or have an incoming instant
  12 message, or something along those lines. The basic idea is that creating an
  13 icon in the notification area is less annoying than popping up a dialog.
  14 </para>
  15
  16 <para>
  17 A #GtkStatusIcon object can be used to display an icon in a "system tray".
  18 The icon can have a tooltip, and the user can interact with it by
  19 activating it or popping up a context menu. Critical information should
  20 not solely be displayed in a #GtkStatusIcon, since it may not be
  21 visible (e.g. when the user doesn't have a notification area on his panel).
  22 This can be checked with gtk_status_icon_is_embedded().
  23 </para>
  24
  25 <para>
  26 On X11, the implementation follows the freedesktop.org "System Tray"
  27 <ulink url="http://www.freedesktop.org/wiki/Standards/systemtray-spec">specification</ulink>. Implementations of the "tray" side of this specification can
  28 be found e.g. in the GNOME and KDE panel applications.
  29 </para>
  30
  31 <para>
  32 Note that a GtkStatusIcon is <emphasis>not</emphasis> a widget, but just
  33 a #GObject. Making it a widget would be impractical, since the system tray
  34 on Win32 doesn't allow to embed arbitrary widgets.
  35 </para>
  36
  37 <!-- ##### SECTION See_Also ##### -->
  38 <para>
  39
  40 </para>
  41
  42 <!-- ##### SECTION Stability_Level ##### -->
  43
  44
  45 <!-- ##### STRUCT GtkStatusIcon ##### -->
  46 <para>
  47
  48 </para>
  49
  50
  51 <!-- ##### SIGNAL GtkStatusIcon::activate ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @statusicon: the object which received the signal.
  57
  58 <!-- ##### SIGNAL GtkStatusIcon::button-press-event ##### -->
  59 <para>
  60
  61 </para>
  62
  63 @statusicon: the object which received the signal.
  64 @event:
  65 @Returns:
  66
  67 <!-- ##### SIGNAL GtkStatusIcon::button-release-event ##### -->
  68 <para>
  69
  70 </para>
  71
  72 @statusicon: the object which received the signal.
  73 @event:
  74 @Returns:
  75
  76 <!-- ##### SIGNAL GtkStatusIcon::popup-menu ##### -->
  77 <para>
  78
  79 </para>
  80
  81 @statusicon: the object which received the signal.
  82 @arg1:
  83 @arg2:
  84
  85 <!-- ##### SIGNAL GtkStatusIcon::query-tooltip ##### -->
  86 <para>
  87
  88 </para>
  89
  90 @statusicon: the object which received the signal.
  91 @arg1:
  92 @arg2:
  93 @arg3:
  94 @arg4:
  95 @Returns:
  96
  97 <!-- ##### SIGNAL GtkStatusIcon::scroll-event ##### -->
  98 <para>
  99
 100 </para>
 101
 102 @statusicon: the object which received the signal.
 103 @event:
 104 @Returns:
 105
 106 <!-- ##### SIGNAL GtkStatusIcon::size-changed ##### -->
 107 <para>
 108
 109 </para>
 110
 111 @statusicon: the object which received the signal.
 112 @arg1:
 113 @Returns:
 114
 115 <!-- ##### ARG GtkStatusIcon:blinking ##### -->
 116 <para>
 117
 118 </para>
 119
 120 <!-- ##### ARG GtkStatusIcon:embedded ##### -->
 121 <para>
 122
 123 </para>
 124
 125 <!-- ##### ARG GtkStatusIcon:file ##### -->
 126 <para>
 127
 128 </para>
 129
 130 <!-- ##### ARG GtkStatusIcon:gicon ##### -->
 131 <para>
 132
 133 </para>
 134
 135 <!-- ##### ARG GtkStatusIcon:has-tooltip ##### -->
 136 <para>
 137
 138 </para>
 139
 140 <!-- ##### ARG GtkStatusIcon:icon-name ##### -->
 141 <para>
 142
 143 </para>
 144
 145 <!-- ##### ARG GtkStatusIcon:orientation ##### -->
 146 <para>
 147
 148 </para>
 149
 150 <!-- ##### ARG GtkStatusIcon:pixbuf ##### -->
 151 <para>
 152
 153 </para>
 154
 155 <!-- ##### ARG GtkStatusIcon:screen ##### -->
 156 <para>
 157
 158 </para>
 159
 160 <!-- ##### ARG GtkStatusIcon:size ##### -->
 161 <para>
 162
 163 </para>
 164
 165 <!-- ##### ARG GtkStatusIcon:stock ##### -->
 166 <para>
 167
 168 </para>
 169
 170 <!-- ##### ARG GtkStatusIcon:storage-type ##### -->
 171 <para>
 172
 173 </para>
 174
 175 <!-- ##### ARG GtkStatusIcon:title ##### -->
 176 <para>
 177
 178 </para>
 179
 180 <!-- ##### ARG GtkStatusIcon:tooltip-markup ##### -->
 181 <para>
 182
 183 </para>
 184
 185 <!-- ##### ARG GtkStatusIcon:tooltip-text ##### -->
 186 <para>
 187
 188 </para>
 189
 190 <!-- ##### ARG GtkStatusIcon:visible ##### -->
 191 <para>
 192
 193 </para>
 194
 195 <!-- ##### FUNCTION gtk_status_icon_new ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @Returns:
 201
 202
 203 <!-- ##### FUNCTION gtk_status_icon_new_from_pixbuf ##### -->
 204 <para>
 205
 206 </para>
 207
 208 @pixbuf:
 209 @Returns:
 210
 211
 212 <!-- ##### FUNCTION gtk_status_icon_new_from_file ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @filename:
 218 @Returns:
 219
 220
 221 <!-- ##### FUNCTION gtk_status_icon_new_from_stock ##### -->
 222 <para>
 223
 224 </para>
 225
 226 @stock_id:
 227 @Returns:
 228
 229
 230 <!-- ##### FUNCTION gtk_status_icon_new_from_icon_name ##### -->
 231 <para>
 232
 233 </para>
 234
 235 @icon_name:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION gtk_status_icon_new_from_gicon ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @icon:
 245 @Returns:
 246
 247
 248 <!-- ##### FUNCTION gtk_status_icon_set_from_pixbuf ##### -->
 249 <para>
 250
 251 </para>
 252
 253 @status_icon:
 254 @pixbuf:
 255
 256
 257 <!-- ##### FUNCTION gtk_status_icon_set_from_file ##### -->
 258 <para>
 259
 260 </para>
 261
 262 @status_icon:
 263 @filename:
 264
 265
 266 <!-- ##### FUNCTION gtk_status_icon_set_from_stock ##### -->
 267 <para>
 268
 269 </para>
 270
 271 @status_icon:
 272 @stock_id:
 273
 274
 275 <!-- ##### FUNCTION gtk_status_icon_set_from_icon_name ##### -->
 276 <para>
 277
 278 </para>
 279
 280 @status_icon:
 281 @icon_name:
 282
 283
 284 <!-- ##### FUNCTION gtk_status_icon_set_from_gicon ##### -->
 285 <para>
 286
 287 </para>
 288
 289 @status_icon:
 290 @icon:
 291
 292
 293 <!-- ##### FUNCTION gtk_status_icon_get_storage_type ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @status_icon:
 299 @Returns:
 300
 301
 302 <!-- ##### FUNCTION gtk_status_icon_get_pixbuf ##### -->
 303 <para>
 304
 305 </para>
 306
 307 @status_icon:
 308 @Returns:
 309
 310
 311 <!-- ##### FUNCTION gtk_status_icon_get_stock ##### -->
 312 <para>
 313
 314 </para>
 315
 316 @status_icon:
 317 @Returns:
 318
 319
 320 <!-- ##### FUNCTION gtk_status_icon_get_icon_name ##### -->
 321 <para>
 322
 323 </para>
 324
 325 @status_icon:
 326 @Returns:
 327
 328
 329 <!-- ##### FUNCTION gtk_status_icon_get_gicon ##### -->
 330 <para>
 331
 332 </para>
 333
 334 @status_icon:
 335 @Returns:
 336
 337
 338 <!-- ##### FUNCTION gtk_status_icon_get_size ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @status_icon:
 344 @Returns:
 345
 346
 347 <!-- ##### FUNCTION gtk_status_icon_set_screen ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @status_icon:
 353 @screen:
 354
 355
 356 <!-- ##### FUNCTION gtk_status_icon_get_screen ##### -->
 357 <para>
 358
 359 </para>
 360
 361 @status_icon:
 362 @Returns:
 363
 364
 365 <!-- ##### FUNCTION gtk_status_icon_set_tooltip ##### -->
 366 <para>
 367
 368 </para>
 369
 370 @status_icon:
 371 @tooltip_text:
 372
 373
 374 <!-- ##### FUNCTION gtk_status_icon_set_tooltip_text ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @status_icon:
 380 @text:
 381
 382
 383 <!-- ##### FUNCTION gtk_status_icon_get_tooltip_text ##### -->
 384 <para>
 385
 386 </para>
 387
 388 @status_icon:
 389 @Returns:
 390
 391
 392 <!-- ##### FUNCTION gtk_status_icon_set_tooltip_markup ##### -->
 393 <para>
 394
 395 </para>
 396
 397 @status_icon:
 398 @markup:
 399
 400
 401 <!-- ##### FUNCTION gtk_status_icon_get_tooltip_markup ##### -->
 402 <para>
 403
 404 </para>
 405
 406 @status_icon:
 407 @Returns:
 408
 409
 410 <!-- ##### FUNCTION gtk_status_icon_set_has_tooltip ##### -->
 411 <para>
 412
 413 </para>
 414
 415 @status_icon:
 416 @has_tooltip:
 417
 418
 419 <!-- ##### FUNCTION gtk_status_icon_get_has_tooltip ##### -->
 420 <para>
 421
 422 </para>
 423
 424 @status_icon:
 425 @Returns:
 426
 427
 428 <!-- ##### FUNCTION gtk_status_icon_set_title ##### -->
 429 <para>
 430
 431 </para>
 432
 433 @status_icon:
 434 @title:
 435
 436
 437 <!-- ##### FUNCTION gtk_status_icon_get_title ##### -->
 438 <para>
 439
 440 </para>
 441
 442 @status_icon:
 443 @Returns:
 444
 445
 446 <!-- ##### FUNCTION gtk_status_icon_set_name ##### -->
 447 <para>
 448
 449 </para>
 450
 451 @status_icon:
 452 @name:
 453
 454
 455 <!-- ##### FUNCTION gtk_status_icon_set_visible ##### -->
 456 <para>
 457
 458 </para>
 459
 460 @status_icon:
 461 @visible:
 462
 463
 464 <!-- ##### FUNCTION gtk_status_icon_get_visible ##### -->
 465 <para>
 466
 467 </para>
 468
 469 @status_icon:
 470 @Returns:
 471
 472
 473 <!-- ##### FUNCTION gtk_status_icon_set_blinking ##### -->
 474 <para>
 475
 476 </para>
 477
 478 @status_icon:
 479 @blinking:
 480
 481
 482 <!-- ##### FUNCTION gtk_status_icon_get_blinking ##### -->
 483 <para>
 484
 485 </para>
 486
 487 @status_icon:
 488 @Returns:
 489
 490
 491 <!-- ##### FUNCTION gtk_status_icon_is_embedded ##### -->
 492 <para>
 493
 494 </para>
 495
 496 @status_icon:
 497 @Returns:
 498
 499
 500 <!-- ##### FUNCTION gtk_status_icon_position_menu ##### -->
 501 <para>
 502
 503 </para>
 504
 505 @menu:
 506 @x:
 507 @y:
 508 @push_in:
 509 @user_data:
 510
 511
 512 <!-- ##### FUNCTION gtk_status_icon_get_geometry ##### -->
 513 <para>
 514
 515 </para>
 516
 517 @status_icon:
 518 @screen:
 519 @area:
 520 @orientation:
 521 @Returns:
 522
 523
 524 <!-- ##### FUNCTION gtk_status_icon_get_x11_window_id ##### -->
 525 <para>
 526
 527 </para>
 528
 529 @status_icon:
 530 @Returns:
 531
 532