GtkIconInfo

typedef struct _GtkIconInfo GtkIconInfo;

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

struct GtkIconTheme

struct GtkIconTheme;

Acts as a database of information about an icon theme. Normally, you retrieve the icon theme for a particular screen using gtk_icon_theme_get_for_screen() and it will contain information about current icon theme for that screen, but you can also create a new GtkIconTheme object and set the icon theme name explicitely using gtk_icon_theme_set_custom_theme().

enum GtkIconLookupFlags

typedef enum {
  GTK_ICON_LOOKUP_NO_SVG           = 1 << 0,
  GTK_ICON_LOOKUP_FORCE_SVG        = 1 << 1,
  GTK_ICON_LOOKUP_USE_BUILTIN      = 1 << 2,
  GTK_ICON_LOOKUP_GENERIC_FALLBACK = 1 << 3,
  GTK_ICON_LOOKUP_FORCE_SIZE       = 1 << 4
} GtkIconLookupFlags;

GTK_ICON_THEME_ERROR

#define GTK_ICON_THEME_ERROR gtk_icon_theme_error_quark ()

The GQuark used for GtkIconThemeError errors.

enum GtkIconThemeError

typedef enum {
  GTK_ICON_THEME_NOT_FOUND,
  GTK_ICON_THEME_FAILED
} GtkIconThemeError;

Error codes for GtkIconTheme operations.

gtk_icon_theme_new ()

GtkIconTheme *      gtk_icon_theme_new                  (void);

Creates a new icon theme object. Icon theme objects are used to lookup up an icon by name in a particular icon theme. Usually, you'll want to use gtk_icon_theme_get_default() or gtk_icon_theme_get_for_screen() rather than creating a new icon theme object for scratch.

Since 2.4

gtk_icon_theme_get_default ()

GtkIconTheme *      gtk_icon_theme_get_default          (void);

Gets the icon theme for the default screen. See gtk_icon_theme_get_for_screen().

Since 2.4

gtk_icon_theme_get_for_screen ()

GtkIconTheme *      gtk_icon_theme_get_for_screen       (GdkScreen *screen);

Gets the icon theme object associated with screen; if this function has not previously been called for the given screen, a new icon theme object will be created and associated with the screen. Icon theme objects are fairly expensive to create, so using this function is usually a better choice than calling than gtk_icon_theme_new() and setting the screen yourself; by using this function a single icon theme object will be shared between users.

Since 2.4

gtk_icon_theme_set_screen ()

void                gtk_icon_theme_set_screen           (GtkIconTheme *icon_theme,
                                                         GdkScreen *screen);

Sets the screen for an icon theme; the screen is used to track the user's currently configured icon theme, which might be different for different screens.

Since 2.4

gtk_icon_theme_set_search_path ()

void                gtk_icon_theme_set_search_path      (GtkIconTheme *icon_theme,
                                                         const gchar *path[],
                                                         gint n_elements);

Sets the search path for the icon theme object. When looking for an icon theme, GTK+ will search for a subdirectory of one or more of the directories in path with the same name as the icon theme. (Themes from multiple of the path elements are combined to allow themes to be extended by adding icons in the user's home directory.)

In addition if an icon found isn't found either in the current icon theme or the default icon theme, and an image file with the right name is found directly in one of the elements of path, then that image will be used for the icon name. (This is legacy feature, and new icons should be put into the default icon theme, which is called DEFAULT_THEME_NAME, rather than directly on the icon path.)

Since 2.4

gtk_icon_theme_get_search_path ()

void                gtk_icon_theme_get_search_path      (GtkIconTheme *icon_theme,
                                                         gchar **path[],
                                                         gint *n_elements);

Gets the current search path. See gtk_icon_theme_set_search_path().

Since 2.4

gtk_icon_theme_append_search_path ()

void                gtk_icon_theme_append_search_path   (GtkIconTheme *icon_theme,
                                                         const gchar *path);

Appends a directory to the search path. See gtk_icon_theme_set_search_path().

Since 2.4

gtk_icon_theme_prepend_search_path ()

void                gtk_icon_theme_prepend_search_path  (GtkIconTheme *icon_theme,
                                                         const gchar *path);

Prepends a directory to the search path. See gtk_icon_theme_set_search_path().

Since 2.4

gtk_icon_theme_set_custom_theme ()

void                gtk_icon_theme_set_custom_theme     (GtkIconTheme *icon_theme,
                                                         const gchar *theme_name);

Sets the name of the icon theme that the GtkIconTheme object uses overriding system configuration. This function cannot be called on the icon theme objects returned from gtk_icon_theme_get_default() and gtk_icon_theme_get_for_screen().

Since 2.4

gtk_icon_theme_has_icon ()

gboolean            gtk_icon_theme_has_icon             (GtkIconTheme *icon_theme,
                                                         const gchar *icon_name);

Checks whether an icon theme includes an icon for a particular name.

Since 2.4

gtk_icon_theme_lookup_icon ()

GtkIconInfo *       gtk_icon_theme_lookup_icon          (GtkIconTheme *icon_theme,
                                                         const gchar *icon_name,
                                                         gint size,
                                                         GtkIconLookupFlags flags);

Looks up a named icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.)

Since 2.4

gtk_icon_theme_choose_icon ()

GtkIconInfo *       gtk_icon_theme_choose_icon          (GtkIconTheme *icon_theme,
                                                         const gchar *icon_names[],
                                                         gint size,
                                                         GtkIconLookupFlags flags);

Looks up a named icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon(). (gtk_icon_theme_load_icon() combines these two steps if all you need is the pixbuf.)

If icon_names contains more than one name, this function tries them all in the given order before falling back to inherited icon themes.

Since 2.12

gtk_icon_theme_lookup_by_gicon ()

GtkIconInfo *       gtk_icon_theme_lookup_by_gicon      (GtkIconTheme *icon_theme,
                                                         GIcon *icon,
                                                         gint size,
                                                         GtkIconLookupFlags flags);

Looks up an icon and returns a structure containing information such as the filename of the icon. The icon can then be rendered into a pixbuf using gtk_icon_info_load_icon().

Since 2.14

gtk_icon_theme_load_icon ()

GdkPixbuf *         gtk_icon_theme_load_icon            (GtkIconTheme *icon_theme,
                                                         const gchar *icon_name,
                                                         gint size,
                                                         GtkIconLookupFlags flags,
                                                         GError **error);

Looks up an icon in an icon theme, scales it to the given size and renders it into a pixbuf. This is a convenience function; if more details about the icon are needed, use gtk_icon_theme_lookup_icon() followed by gtk_icon_info_load_icon().

Note that you probably want to listen for icon theme changes and update the icon. This is usually done by connecting to the GtkWidget::style-set signal. If for some reason you do not want to update the icon when the icon theme changes, you should consider using gdk_pixbuf_copy() to make a private copy of the pixbuf returned by this function. Otherwise GTK+ may need to keep the old icon theme loaded, which would be a waste of memory.

Since 2.4

gtk_icon_theme_list_contexts ()

GList *             gtk_icon_theme_list_contexts        (GtkIconTheme *icon_theme);

Gets the list of contexts available within the current hierarchy of icon themes

Since 2.12

gtk_icon_theme_list_icons ()

GList *             gtk_icon_theme_list_icons           (GtkIconTheme *icon_theme,
                                                         const gchar *context);

Lists the icons in the current icon theme. Only a subset of the icons can be listed by providing a context string. The set of values for the context string is system dependent, but will typically include such values as "Applications" and "MimeTypes".

Since 2.4

gtk_icon_theme_get_icon_sizes ()

gint *              gtk_icon_theme_get_icon_sizes       (GtkIconTheme *icon_theme,
                                                         const gchar *icon_name);

Returns an array of integers describing the sizes at which the icon is available without scaling. A size of -1 means that the icon is available in a scalable format. The array is zero-terminated.

Since 2.6

gtk_icon_theme_get_example_icon_name ()

char *              gtk_icon_theme_get_example_icon_name
                                                        (GtkIconTheme *icon_theme);

Gets the name of an icon that is representative of the current theme (for instance, to use when presenting a list of themes to the user.)

Since 2.4

gtk_icon_theme_rescan_if_needed ()

gboolean            gtk_icon_theme_rescan_if_needed     (GtkIconTheme *icon_theme);

Checks to see if the icon theme has changed; if it has, any currently cached information is discarded and will be reloaded next time icon_theme is accessed.

Since 2.4

gtk_icon_theme_add_builtin_icon ()

void                gtk_icon_theme_add_builtin_icon     (const gchar *icon_name,
                                                         gint size,
                                                         GdkPixbuf *pixbuf);

Registers a built-in icon for icon theme lookups. The idea of built-in icons is to allow an application or library that uses themed icons to function requiring files to be present in the file system. For instance, the default images for all of GTK+'s stock icons are registered as built-icons.

In general, if you use gtk_icon_theme_add_builtin_icon() you should also install the icon in the icon theme, so that the icon is generally available.

This function will generally be used with pixbufs loaded via gdk_pixbuf_new_from_inline().

Since 2.4

gtk_icon_info_copy ()

GtkIconInfo *       gtk_icon_info_copy                  (GtkIconInfo *icon_info);

Make a copy of a GtkIconInfo.

Since 2.4

gtk_icon_info_free ()

void                gtk_icon_info_free                  (GtkIconInfo *icon_info);

Free a GtkIconInfo and associated information

Since 2.4

gtk_icon_info_new_for_pixbuf ()

GtkIconInfo *       gtk_icon_info_new_for_pixbuf        (GtkIconTheme *icon_theme,
                                                         GdkPixbuf *pixbuf);

Creates a GtkIconInfo for a GdkPixbuf.

Since 2.14

gtk_icon_info_get_base_size ()

gint                gtk_icon_info_get_base_size         (GtkIconInfo *icon_info);

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.

Since 2.4

gtk_icon_info_get_filename ()

const gchar *       gtk_icon_info_get_filename          (GtkIconInfo *icon_info);

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().

Since 2.4

gtk_icon_info_get_builtin_pixbuf ()

GdkPixbuf *         gtk_icon_info_get_builtin_pixbuf    (GtkIconInfo *icon_info);

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().

Since 2.4

gtk_icon_info_load_icon ()

GdkPixbuf *         gtk_icon_info_load_icon             (GtkIconInfo *icon_info,
                                                         GError **error);

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.

Since 2.4

gtk_icon_info_load_icon_async ()

void                gtk_icon_info_load_icon_async       (GtkIconInfo *icon_info,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

For more details, see gtk_icon_info_load_icon() which is the synchronous version of this call.

Since 3.8

gtk_icon_info_load_icon_finish ()

GdkPixbuf *         gtk_icon_info_load_icon_finish      (GtkIconInfo *icon_info,
                                                         GAsyncResult *res,
                                                         GError **error);

Finishes an async icon load, see gtk_icon_info_load_icon_async().

Since 3.8

gtk_icon_info_load_symbolic ()

GdkPixbuf *         gtk_icon_info_load_symbolic         (GtkIconInfo *icon_info,
                                                         const GdkRGBA *fg,
                                                         const GdkRGBA *success_color,
                                                         const GdkRGBA *warning_color,
                                                         const GdkRGBA *error_color,
                                                         gboolean *was_symbolic,
                                                         GError **error);

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().

This allows loading symbolic icons that will match the system theme.

Unless you are implementing a widget, you will want to use g_themed_icon_new_with_default_fallbacks() to load the icon.

As implementation details, the icon loaded needs to be of SVG type, contain the "symbolic" term as the last component of the icon name, and use the 'fg', 'success', 'warning' and 'error' CSS styles in the SVG file itself.

See the Symbolic Icons spec for more information about symbolic icons.

Since 3.0

gtk_icon_info_load_symbolic_async ()

void                gtk_icon_info_load_symbolic_async   (GtkIconInfo *icon_info,
                                                         const GdkRGBA *fg,
                                                         const GdkRGBA *success_color,
                                                         const GdkRGBA *warning_color,
                                                         const GdkRGBA *error_color,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

For more details, see gtk_icon_info_load_symbolic() which is the synchronous version of this call.

Since 3.8

gtk_icon_info_load_symbolic_finish ()

GdkPixbuf *         gtk_icon_info_load_symbolic_finish  (GtkIconInfo *icon_info,
                                                         GAsyncResult *res,
                                                         gboolean *was_symbolic,
                                                         GError **error);

Finishes an async icon load, see gtk_icon_info_load_symbolic_async().

Since 3.8

gtk_icon_info_load_symbolic_for_style ()

GdkPixbuf *         gtk_icon_info_load_symbolic_for_style
                                                        (GtkIconInfo *icon_info,
                                                         GtkStyle *style,
                                                         GtkStateType state,
                                                         gboolean *was_symbolic,
                                                         GError **error);

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().

This allows loading symbolic icons that will match the system theme.

See gtk_icon_info_load_symbolic() for more details.

Since 3.0

gtk_icon_info_load_symbolic_for_context ()

GdkPixbuf *         gtk_icon_info_load_symbolic_for_context
                                                        (GtkIconInfo *icon_info,
                                                         GtkStyleContext *context,
                                                         gboolean *was_symbolic,
                                                         GError **error);

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.

This allows loading symbolic icons that will match the system theme.

See gtk_icon_info_load_symbolic() for more details.

Since 3.0

gtk_icon_info_load_symbolic_for_context_async ()

void                gtk_icon_info_load_symbolic_for_context_async
                                                        (GtkIconInfo *icon_info,
                                                         GtkStyleContext *context,
                                                         GCancellable *cancellable,
                                                         GAsyncReadyCallback callback,
                                                         gpointer user_data);

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

For more details, see gtk_icon_info_load_symbolic_for_context() which is the synchronous version of this call.

Since 3.8

gtk_icon_info_load_symbolic_for_context_finish ()

GdkPixbuf *         gtk_icon_info_load_symbolic_for_context_finish
                                                        (GtkIconInfo *icon_info,
                                                         GAsyncResult *res,
                                                         gboolean *was_symbolic,
                                                         GError **error);

Finishes an async icon load, see gtk_icon_info_load_symbolic_for_context_async().

Since 3.8

gtk_icon_info_set_raw_coordinates ()

void                gtk_icon_info_set_raw_coordinates   (GtkIconInfo *icon_info,
                                                         gboolean 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().

Raw coordinates are somewhat strange; they are specified to be with respect to the unscaled pixmap for PNG and XPM icons, but for SVG icons, they are in a 1000x1000 coordinate space that is scaled to the final size of the icon. You can determine if the icon is an SVG icon by using gtk_icon_info_get_filename(), and seeing if it is non-NULL and ends in '.svg'.

This function is provided primarily to allow compatibility wrappers for older API's, and is not expected to be useful for applications.

Since 2.4

gtk_icon_info_get_embedded_rect ()

gboolean            gtk_icon_info_get_embedded_rect     (GtkIconInfo *icon_info,
                                                         GdkRectangle *rectangle);

Gets the coordinates of a rectangle within the icon that can be used for display of information such as a preview of the contents of a text file. See gtk_icon_info_set_raw_coordinates() for further information about the coordinate system.

Since 2.4

gtk_icon_info_get_attach_points ()

gboolean            gtk_icon_info_get_attach_points     (GtkIconInfo *icon_info,
                                                         GdkPoint **points,
                                                         gint *n_points);

Fetches the set of attach points for an icon. An attach point is a location in the icon that can be used as anchor points for attaching emblems or overlays to the icon.

Since 2.4

gtk_icon_info_get_display_name ()

const gchar *       gtk_icon_info_get_display_name      (GtkIconInfo *icon_info);

Gets the display name for an icon. A display name is a string to be used in place of the icon name in a user visible context like a list of icons.

Since 2.4

The "changed" signal

void                user_function                      (GtkIconTheme *icon_theme,
                                                        gpointer      user_data)       : Run Last

Emitted when the current icon theme is switched or GTK+ detects that a change has occurred in the contents of the current icon theme.