Class

GtkIconInfo

Description [src]

final class Gtk.IconInfo : GObject.Object {
  /* No available fields */
}

Contains information found when looking up an icon in an icon theme.

Hierarchy

hierarchy this GtkIconInfo ancestor_0 GObject ancestor_0--this

Ancestors

Constructors

gtk_icon_info_new_for_pixbuf

Creates a GtkIconInfo for a GdkPixbuf.

Available since: 2.14

Instance methods

gtk_icon_info_copy

Make a copy of a GtkIconInfo.

Available since: 2.4

Deprecated since: 3.8

gtk_icon_info_free

Free a GtkIconInfo and associated information.

Available since: 2.4

Deprecated since: 3.8

gtk_icon_info_get_attach_points

This function is deprecated and always returns FALSE.

Available since: 2.4

Deprecated since: 3.14

gtk_icon_info_get_base_scale

Gets the base scale for the icon. The base scale is a scale for the icon that was specified by the icon theme creator. For instance an icon drawn for a high-dpi screen with window scale 2 for a base size of 32 will be 64 pixels tall and have a base scale of 2.

Available since: 3.10

gtk_icon_info_get_base_size

Gets the base size for the icon. The base size is a size for the icon that was specified by the icon theme creator. This may be different than the actual size of image; an example of this is small emblem icons that can be attached to a larger icon. These icons will be given the same base size as the larger icons to which they are attached.

Available since: 2.4

gtk_icon_info_get_builtin_pixbuf

Gets the built-in image for this icon, if any. To allow GTK+ to use built in icon images, you must pass the GTK_ICON_LOOKUP_USE_BUILTIN to gtk_icon_theme_lookup_icon().

Available since: 2.4

Deprecated since: 3.14

gtk_icon_info_get_display_name

This function is deprecated and always returns NULL.

Available since: 2.4

Deprecated since: 3.14

gtk_icon_info_get_embedded_rect

This function is deprecated and always returns FALSE.

Available since: 2.4

Deprecated since: 3.14

gtk_icon_info_get_filename

Gets the filename for the icon. If the GTK_ICON_LOOKUP_USE_BUILTIN flag was passed to gtk_icon_theme_lookup_icon(), there may be no filename if a builtin icon is returned; in this case, you should use gtk_icon_info_get_builtin_pixbuf().

Available since: 2.4

gtk_icon_info_is_symbolic

Checks if the icon is symbolic or not. This currently uses only the file name and not the file contents for determining this. This behaviour may change in the future.

Available since: 3.12

gtk_icon_info_load_icon

Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). Note that the resulting pixbuf may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining the GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.

Available since: 2.4

gtk_icon_info_load_icon_async

Asynchronously load, render and scale an icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon().

Available since: 3.8

gtk_icon_info_load_icon_finish

Finishes an async icon load, see gtk_icon_info_load_icon_async().

Available since: 3.8

gtk_icon_info_load_surface

Renders an icon previously looked up in an icon theme using gtk_icon_theme_lookup_icon(); the size will be based on the size passed to gtk_icon_theme_lookup_icon(). Note that the resulting surface may not be exactly this size; an icon theme may have icons that differ slightly from their nominal sizes, and in addition GTK+ will avoid scaling icons that it considers sufficiently close to the requested size or for which the source image would have to be scaled up too far. (This maintains sharpness.). This behaviour can be changed by passing the GTK_ICON_LOOKUP_FORCE_SIZE flag when obtaining the GtkIconInfo. If this flag has been specified, the pixbuf returned by this function will be scaled to the exact size.

Available since: 3.10

gtk_icon_info_load_symbolic

Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon().

Available since: 3.0

gtk_icon_info_load_symbolic_async

Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon().

Available since: 3.8

gtk_icon_info_load_symbolic_finish

Finishes an async icon load, see gtk_icon_info_load_symbolic_async().

Available since: 3.8

gtk_icon_info_load_symbolic_for_context

Loads an icon, modifying it to match the system colors for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon(). This function uses the regular foreground color and the symbolic colors with the names “success_color”, “warning_color” and “error_color” from the context.

Available since: 3.0

gtk_icon_info_load_symbolic_for_context_async

Asynchronously load, render and scale a symbolic icon previously looked up from the icon theme using gtk_icon_theme_lookup_icon().

Available since: 3.8

gtk_icon_info_load_symbolic_for_context_finish

Finishes an async icon load, see gtk_icon_info_load_symbolic_for_context_async().

Available since: 3.8

gtk_icon_info_load_symbolic_for_style

Loads an icon, modifying it to match the system colours for the foreground, success, warning and error colors provided. If the icon is not a symbolic one, the function will return the result from gtk_icon_info_load_icon().

Available since: 3.0

Deprecated since: 3.0

gtk_icon_info_set_raw_coordinates

Sets whether the coordinates returned by gtk_icon_info_get_embedded_rect() and gtk_icon_info_get_attach_points() should be returned in their original form as specified in the icon theme, instead of scaled appropriately for the pixbuf returned by gtk_icon_info_load_icon().

Available since: 2.4

Deprecated since: 3.14

Methods inherited from GObject (42)

Signals

Signals inherited from GObject (1)

Class structure

struct GtkIconInfoClass {
  /* no available fields */
}