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

   1 <!-- ##### SECTION Title ##### -->
   2 Themeable Stock Images
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Manipulating stock icons
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9
  10
  11 <para>
  12 Browse the available stock icons in the list of stock IDs found <link
  13 linkend="gtk-Stock-Items">here</link>. You can also use
  14 the <application>gtk-demo</application> application for this purpose.
  15 </para>
  16
  17 <para>
  18  An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
  19  set of variants of a particular icon (i.e. a #GtkIconSet contains variants for
  20  different sizes and widget states). Icons in an icon factory are named by a
  21  stock ID, which is a simple string identifying the icon. Each #GtkStyle has a
  22  list of #GtkIconFactory derived from the current theme; those icon factories
  23  are consulted first when searching for an icon. If the theme doesn't set a
  24  particular icon, GTK+ looks for the icon in a list of default icon factories,
  25  maintained by gtk_icon_factory_add_default() and
  26  gtk_icon_factory_remove_default(). Applications with icons should add a default
  27  icon factory with their icons, which will allow themes to override the icons
  28  for the application.
  29 </para>
  30
  31 <para>
  32 To display an icon, always use gtk_style_lookup_icon_set() on the widget that
  33 will display the icon, or the convenience function
  34 gtk_widget_render_icon(). These functions take the theme into account when
  35 looking up the icon to use for a given stock ID.
  36 </para>
  37
  38 <!-- ##### SECTION See_Also ##### -->
  39 <para>
  40
  41 </para>
  42
  43 <!-- ##### SECTION Stability_Level ##### -->
  44
  45
  46 <!-- ##### STRUCT GtkIconSource ##### -->
  47 <para>
  48
  49 </para>
  50
  51
  52 <!-- ##### STRUCT GtkIconFactory ##### -->
  53 <para>
  54
  55 </para>
  56
  57
  58 <!-- ##### STRUCT GtkIconSet ##### -->
  59 <para>
  60
  61 </para>
  62
  63
  64 <!-- ##### ENUM GtkIconSize ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @GTK_ICON_SIZE_INVALID:
  70 @GTK_ICON_SIZE_MENU:
  71 @GTK_ICON_SIZE_SMALL_TOOLBAR:
  72 @GTK_ICON_SIZE_LARGE_TOOLBAR:
  73 @GTK_ICON_SIZE_BUTTON:
  74 @GTK_ICON_SIZE_DND:
  75 @GTK_ICON_SIZE_DIALOG:
  76
  77 <!-- ##### FUNCTION gtk_icon_source_copy ##### -->
  78 <para>
  79
  80 </para>
  81
  82 @source:
  83 @Returns:
  84
  85
  86 <!-- ##### FUNCTION gtk_icon_source_free ##### -->
  87 <para>
  88
  89 </para>
  90
  91 @source:
  92
  93
  94 <!-- ##### FUNCTION gtk_icon_factory_add ##### -->
  95 <para>
  96
  97 </para>
  98
  99 @factory:
 100 @stock_id:
 101 @icon_set:
 102
 103
 104 <!-- ##### FUNCTION gtk_icon_factory_add_default ##### -->
 105 <para>
 106
 107 </para>
 108
 109 @factory:
 110
 111
 112 <!-- ##### FUNCTION gtk_icon_factory_lookup ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @factory:
 118 @stock_id:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gtk_icon_factory_lookup_default ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @stock_id:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gtk_icon_factory_new ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @Returns:
 137
 138
 139 <!-- ##### FUNCTION gtk_icon_factory_remove_default ##### -->
 140 <para>
 141
 142 </para>
 143
 144 @factory:
 145
 146
 147 <!-- ##### FUNCTION gtk_icon_set_add_source ##### -->
 148 <para>
 149
 150 </para>
 151
 152 @icon_set:
 153 @source:
 154
 155
 156 <!-- ##### FUNCTION gtk_icon_set_copy ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @icon_set:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION gtk_icon_set_new ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gtk_icon_set_new_from_pixbuf ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @pixbuf:
 179 @Returns:
 180
 181
 182 <!-- ##### FUNCTION gtk_icon_set_ref ##### -->
 183 <para>
 184
 185 </para>
 186
 187 @icon_set:
 188 @Returns:
 189
 190
 191 <!-- ##### FUNCTION gtk_icon_set_render_icon ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @icon_set:
 197 @style:
 198 @direction:
 199 @state:
 200 @size:
 201 @widget:
 202 @detail:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_icon_set_unref ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @icon_set:
 212
 213
 214 <!-- ##### FUNCTION gtk_icon_size_lookup ##### -->
 215 <para>
 216
 217 </para>
 218
 219 @size:
 220 @width:
 221 @height:
 222 @Returns:
 223 <!-- # Unused Parameters # -->
 224 @alias:
 225
 226
 227 <!-- ##### FUNCTION gtk_icon_size_lookup_for_settings ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @settings:
 233 @size:
 234 @width:
 235 @height:
 236 @Returns:
 237
 238
 239 <!-- ##### FUNCTION gtk_icon_size_register ##### -->
 240 <para>
 241
 242 </para>
 243
 244 @name:
 245 @width:
 246 @height:
 247 @Returns:
 248 <!-- # Unused Parameters # -->
 249 @alias:
 250
 251
 252 <!-- ##### FUNCTION gtk_icon_size_register_alias ##### -->
 253 <para>
 254
 255 </para>
 256
 257 @alias:
 258 @target:
 259
 260
 261 <!-- ##### FUNCTION gtk_icon_size_from_name ##### -->
 262 <para>
 263
 264 </para>
 265
 266 @name:
 267 @Returns:
 268
 269
 270 <!-- ##### FUNCTION gtk_icon_size_get_name ##### -->
 271 <para>
 272
 273 </para>
 274
 275 @size:
 276 @Returns:
 277
 278
 279 <!-- ##### FUNCTION gtk_icon_set_get_sizes ##### -->
 280 <para>
 281
 282 </para>
 283
 284 @icon_set:
 285 @sizes:
 286 @n_sizes:
 287
 288
 289 <!-- ##### FUNCTION gtk_icon_source_get_direction ##### -->
 290 <para>
 291
 292 </para>
 293
 294 @source:
 295 @Returns:
 296
 297
 298 <!-- ##### FUNCTION gtk_icon_source_get_direction_wildcarded ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @source:
 304 @Returns:
 305
 306
 307 <!-- ##### FUNCTION gtk_icon_source_get_filename ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @source:
 313 @Returns:
 314
 315
 316 <!-- ##### FUNCTION gtk_icon_source_get_pixbuf ##### -->
 317 <para>
 318
 319 </para>
 320
 321 @source:
 322 @Returns:
 323
 324
 325 <!-- ##### FUNCTION gtk_icon_source_get_icon_name ##### -->
 326 <para>
 327
 328 </para>
 329
 330 @source:
 331 @Returns:
 332
 333
 334 <!-- ##### FUNCTION gtk_icon_source_get_size ##### -->
 335 <para>
 336
 337 </para>
 338
 339 @source:
 340 @Returns:
 341
 342
 343 <!-- ##### FUNCTION gtk_icon_source_get_size_wildcarded ##### -->
 344 <para>
 345
 346 </para>
 347
 348 @source:
 349 @Returns:
 350
 351
 352 <!-- ##### FUNCTION gtk_icon_source_get_state ##### -->
 353 <para>
 354
 355 </para>
 356
 357 @source:
 358 @Returns:
 359
 360
 361 <!-- ##### FUNCTION gtk_icon_source_get_state_wildcarded ##### -->
 362 <para>
 363
 364 </para>
 365
 366 @source:
 367 @Returns:
 368
 369
 370 <!-- ##### FUNCTION gtk_icon_source_new ##### -->
 371 <para>
 372
 373 </para>
 374
 375 @Returns:
 376
 377
 378 <!-- ##### FUNCTION gtk_icon_source_set_direction ##### -->
 379 <para>
 380
 381 </para>
 382
 383 @source:
 384 @direction:
 385
 386
 387 <!-- ##### FUNCTION gtk_icon_source_set_direction_wildcarded ##### -->
 388 <para>
 389
 390 </para>
 391
 392 @source:
 393 @setting:
 394
 395
 396 <!-- ##### FUNCTION gtk_icon_source_set_filename ##### -->
 397 <para>
 398
 399 </para>
 400
 401 @source:
 402 @filename:
 403
 404
 405 <!-- ##### FUNCTION gtk_icon_source_set_pixbuf ##### -->
 406 <para>
 407
 408 </para>
 409
 410 @source:
 411 @pixbuf:
 412
 413
 414 <!-- ##### FUNCTION gtk_icon_source_set_icon_name ##### -->
 415 <para>
 416
 417 </para>
 418
 419 @source:
 420 @icon_name:
 421
 422
 423 <!-- ##### FUNCTION gtk_icon_source_set_size ##### -->
 424 <para>
 425
 426 </para>
 427
 428 @source:
 429 @size:
 430
 431
 432 <!-- ##### FUNCTION gtk_icon_source_set_size_wildcarded ##### -->
 433 <para>
 434
 435 </para>
 436
 437 @source:
 438 @setting:
 439
 440
 441 <!-- ##### FUNCTION gtk_icon_source_set_state ##### -->
 442 <para>
 443
 444 </para>
 445
 446 @source:
 447 @state:
 448
 449
 450 <!-- ##### FUNCTION gtk_icon_source_set_state_wildcarded ##### -->
 451 <para>
 452
 453 </para>
 454
 455 @source:
 456 @setting:
 457
 458