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 <para>
  10  An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a
  11  set of variants of a particular icon (i.e. a #GtkIconSet contains variants for
  12  different sizes and widget states). Icons in an icon factory are named by a
  13  stock ID, which is a simple string identifying the icon. Each #GtkStyle has a
  14  list of #GtkIconFactory derived from the current theme; those icon factories
  15  are consulted first when searching for an icon. If the theme doesn't set a
  16  particular icon, GTK+ looks for the icon in a list of default icon factories,
  17  maintained by gtk_icon_factory_add_default() and
  18  gtk_icon_factory_remove_default(). Applications with icons should add a default
  19  icon factory with their icons, which will allow themes to override the icons
  20  for the application.
  21 </para>
  22
  23 <para>
  24 To display an icon, always use gtk_style_lookup_icon_set() on the widget that
  25 will display the icon, or the convenience function
  26 gtk_widget_render_icon(). These functions take the theme into account when
  27 looking up the icon to use for a given stock ID.
  28 </para>
  29
  30 <!-- ##### SECTION See_Also ##### -->
  31 <para>
  32
  33 </para>
  34
  35 <!-- ##### STRUCT GtkIconSource ##### -->
  36 <para>
  37
  38 </para>
  39
  40 @filename:
  41 @pixbuf:
  42 @direction:
  43 @state:
  44 @size:
  45 @any_direction:
  46 @any_state:
  47 @any_size:
  48
  49 <!-- ##### STRUCT GtkIconFactory ##### -->
  50 <para>
  51
  52 </para>
  53
  54 @parent_instance:
  55 @icons:
  56
  57 <!-- ##### STRUCT GtkIconSet ##### -->
  58 <para>
  59
  60 </para>
  61
  62
  63 <!-- ##### FUNCTION gtk_icon_source_copy ##### -->
  64 <para>
  65
  66 </para>
  67
  68 @source:
  69 @Returns:
  70
  71
  72 <!-- ##### FUNCTION gtk_icon_source_free ##### -->
  73 <para>
  74
  75 </para>
  76
  77 @source:
  78
  79
  80 <!-- ##### FUNCTION gtk_icon_factory_add ##### -->
  81 <para>
  82
  83 </para>
  84
  85 @factory:
  86 @stock_id:
  87 @icon_set:
  88
  89
  90 <!-- ##### FUNCTION gtk_icon_factory_add_default ##### -->
  91 <para>
  92
  93 </para>
  94
  95 @factory:
  96
  97
  98 <!-- ##### FUNCTION gtk_icon_factory_lookup ##### -->
  99 <para>
 100
 101 </para>
 102
 103 @factory:
 104 @stock_id:
 105 @Returns:
 106
 107
 108 <!-- ##### FUNCTION gtk_icon_factory_lookup_default ##### -->
 109 <para>
 110
 111 </para>
 112
 113 @stock_id:
 114 @Returns:
 115
 116
 117 <!-- ##### FUNCTION gtk_icon_factory_new ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @Returns:
 123
 124
 125 <!-- ##### FUNCTION gtk_icon_factory_remove_default ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @factory:
 131
 132
 133 <!-- ##### FUNCTION gtk_icon_set_add_source ##### -->
 134 <para>
 135
 136 </para>
 137
 138 @icon_set:
 139 @source:
 140
 141
 142 <!-- ##### FUNCTION gtk_icon_set_copy ##### -->
 143 <para>
 144
 145 </para>
 146
 147 @icon_set:
 148 @Returns:
 149
 150
 151 <!-- ##### FUNCTION gtk_icon_set_new ##### -->
 152 <para>
 153
 154 </para>
 155
 156 @Returns:
 157
 158
 159 <!-- ##### FUNCTION gtk_icon_set_ref ##### -->
 160 <para>
 161
 162 </para>
 163
 164 @icon_set:
 165 @Returns:
 166
 167
 168 <!-- ##### FUNCTION gtk_icon_set_render_icon ##### -->
 169 <para>
 170
 171 </para>
 172
 173 @icon_set:
 174 @style:
 175 @direction:
 176 @state:
 177 @size:
 178 @widget:
 179 @detail:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION gtk_icon_set_unref ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @icon_set:
 189
 190
 191 <!-- ##### MACRO GTK_ICON_SIZE_MENU ##### -->
 192 <para>
 193
 194 </para>
 195
 196
 197
 198 <!-- ##### MACRO GTK_ICON_SIZE_BUTTON ##### -->
 199 <para>
 200
 201 </para>
 202
 203
 204
 205 <!-- ##### MACRO GTK_ICON_SIZE_SMALL_TOOLBAR ##### -->
 206 <para>
 207
 208 </para>
 209
 210
 211
 212 <!-- ##### MACRO GTK_ICON_SIZE_LARGE_TOOLBAR ##### -->
 213 <para>
 214
 215 </para>
 216
 217
 218
 219 <!-- ##### MACRO GTK_ICON_SIZE_DIALOG ##### -->
 220 <para>
 221
 222 </para>
 223
 224
 225
 226 <!-- ##### FUNCTION gtk_icon_size_lookup ##### -->
 227 <para>
 228
 229 </para>
 230
 231 @alias:
 232 @width:
 233 @height:
 234 @Returns:
 235
 236
 237 <!-- ##### FUNCTION gtk_icon_size_register ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @alias:
 243 @width:
 244 @height:
 245
 246
 247 <!-- ##### FUNCTION gtk_icon_size_register_alias ##### -->
 248 <para>
 249
 250 </para>
 251
 252 @alias:
 253 @target:
 254
 255