Functions
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().
Returns
A unique GtkIconTheme associated with
the default screen. This icon theme is associated with
the screen and can be used as long as the screen
is open. Do not ref or unref it.
[transfer none]
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.
Returns
A unique GtkIconTheme associated with
the given screen. This icon theme is associated with
the screen and can be used as long as the screen
is open. Do not ref or unref it.
[transfer none]
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 containing an index.theme file. (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 fallback icon theme, which is called hicolor,
rather than directly on the icon path.)
Since: 2.4
gtk_icon_theme_add_resource_path ()
void
gtk_icon_theme_add_resource_path (GtkIconTheme *icon_theme,
const gchar *path);
Adds a resource path that will be looked at when looking
for icons, similar to search paths.
This function should be used to make application-specific icons
available as part of the icon theme.
The resources are considered as part of the hicolor icon theme
and must be located in subdirectories that are defined in the
hicolor icon theme, such as @path/16x16/actions/run.png.
Icons that are directly placed in the resource path instead
of a subdirectory are also considered as ultimate fallback.
Since: 3.14
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.
Returns
TRUE if icon_theme
includes an
icon for icon_name
.
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 GtkIconInfo 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.
Returns
a GtkIconInfo object
containing information about the icon, or NULL if the icon wasn’t
found.
[nullable][transfer full]
Since: 2.12
gtk_icon_theme_choose_icon_for_scale ()
GtkIconInfo *
gtk_icon_theme_choose_icon_for_scale (GtkIconTheme *icon_theme,
const gchar *icon_names[],
gint size,
gint scale,
GtkIconLookupFlags flags);
Looks up a named icon for a particular window scale and returns
a GtkIconInfo 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.
Returns
a GtkIconInfo object
containing information about the icon, or NULL if the
icon wasn’t found.
[nullable][transfer full]
Since: 3.10
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.
Returns
the rendered icon; this may be
a newly created icon or a new reference to an internal icon, so
you must not modify the icon. Use g_object_unref() to release
your reference to the icon. NULL if the icon isn’t found.
[nullable][transfer full]
Since: 2.4
gtk_icon_theme_load_icon_for_scale ()
GdkPixbuf *
gtk_icon_theme_load_icon_for_scale (GtkIconTheme *icon_theme,
const gchar *icon_name,
gint size,
gint scale,
GtkIconLookupFlags flags,
GError **error);
Looks up an icon in an icon theme for a particular window scale,
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.
Returns
the rendered icon; this may be
a newly created icon or a new reference to an internal icon, so
you must not modify the icon. Use g_object_unref() to release
your reference to the icon. NULL if the icon isn’t found.
[nullable][transfer full]
Since: 3.10
gtk_icon_theme_load_surface ()
cairo_surface_t *
gtk_icon_theme_load_surface (GtkIconTheme *icon_theme,
const gchar *icon_name,
gint size,
gint scale,
GdkWindow *for_window,
GtkIconLookupFlags flags,
GError **error);
Looks up an icon in an icon theme for a particular window scale,
scales it to the given size and renders it into a cairo surface. 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_surface().
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.
Returns
the rendered icon; this may be
a newly created icon or a new reference to an internal icon, so
you must not modify the icon. Use cairo_surface_destroy() to
release your reference to the icon. NULL if the icon isn’t
found.
[nullable][transfer full]
Since: 3.10
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.
See gtk_icon_theme_list_icons() for details about contexts.
Returns
a GList list
holding the names of all the contexts in the theme. You must first
free each element in the list with g_free(), then free the list
itself with g_list_free().
[element-type utf8][transfer full]
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”. Contexts are explained in the
Icon Theme Specification.
The standard contexts are listed in the
Icon Naming Specification.
Also see gtk_icon_theme_list_contexts().
Returns
a GList list
holding the names of all the icons in the theme. You must
first free each element in the list with g_free(), then
free the list itself with g_list_free().
[element-type utf8][transfer full]
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.
Returns
An newly
allocated array describing the sizes at which the icon is
available. The array should be freed with g_free() when it is no
longer needed.
[array zero-terminated=1][transfer full]
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.)
Returns
the name of an example icon or NULL.
Free with g_free().
[nullable]
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.
Returns
TRUE if the icon theme has changed and needed
to be reloaded.
Since: 2.4
gtk_icon_theme_add_builtin_icon ()
void
gtk_icon_theme_add_builtin_icon (const gchar *icon_name,
gint size,
GdkPixbuf *pixbuf);
gtk_icon_theme_add_builtin_icon has been deprecated since version 3.14 and should not be used in newly-written code.
Use gtk_icon_theme_add_resource_path()
to add application-specific icons to the icon theme.
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);
gtk_icon_info_copy has been deprecated since version 3.8 and should not be used in newly-written code.
Use g_object_ref()
Make a copy of a GtkIconInfo.
[skip]
Returns
the new GtkIconInfo.
[transfer full]
Since: 2.4
gtk_icon_info_free ()
void
gtk_icon_info_free (GtkIconInfo *icon_info);
gtk_icon_info_free has been deprecated since version 3.8 and should not be used in newly-written code.
Use g_object_unref()
Free a GtkIconInfo and associated information
[skip]
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.
Note that for scaled icons the base size does
not include the base scale.
Returns
the base size, or 0, if no base
size is known for the icon.
Since: 2.4
gtk_icon_info_get_base_scale ()
gint
gtk_icon_info_get_base_scale (GtkIconInfo *icon_info);
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.
Since: 3.10
gtk_icon_info_get_builtin_pixbuf ()
GdkPixbuf *
gtk_icon_info_get_builtin_pixbuf (GtkIconInfo *icon_info);
gtk_icon_info_get_builtin_pixbuf has been deprecated since version 3.14 and should not be used in newly-written code.
This function is deprecated, use
gtk_icon_theme_add_resource_path() instead of builtin icons.
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().
Returns
the built-in image pixbuf, or NULL.
No extra reference is added to the returned pixbuf, so if
you want to keep it around, you must use g_object_ref().
The returned image must not be modified.
[nullable][transfer none]
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.
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use g_object_unref() to release your reference
to the icon.
[transfer full]
Since: 2.4
gtk_icon_info_load_surface ()
cairo_surface_t *
gtk_icon_info_load_surface (GtkIconInfo *icon_info,
GdkWindow *for_window,
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
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.
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use cairo_surface_destroy() to release your
reference to the icon.
[transfer full]
Since: 3.10
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().
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use g_object_unref() to release your reference
to the icon.
[transfer full]
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 Specification
for more information about symbolic icons.
Returns
a GdkPixbuf representing the loaded icon.
[transfer full]
Since: 3.0
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().
Returns
the rendered icon; this may be a newly
created icon or a new reference to an internal icon, so you must
not modify the icon. Use g_object_unref() to release your reference
to the icon.
[transfer full]
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.
Returns
a GdkPixbuf representing the loaded icon.
[transfer full]
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.
Returns
a GdkPixbuf representing the loaded icon.
[transfer full]
Since: 3.0
gtk_icon_info_set_raw_coordinates ()
void
gtk_icon_info_set_raw_coordinates (GtkIconInfo *icon_info,
gboolean raw_coordinates);
gtk_icon_info_set_raw_coordinates has been deprecated since version 3.14 and should not be used in newly-written code.
Embedded rectangles and attachment points are deprecated
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);
gtk_icon_info_get_embedded_rect has been deprecated since version 3.14 and should not be used in newly-written code.
Embedded rectangles are deprecated
This function is deprecated and always returns FALSE.
Since: 2.4
gtk_icon_info_get_attach_points ()
gboolean
gtk_icon_info_get_attach_points (GtkIconInfo *icon_info,
GdkPoint **points,
gint *n_points);
gtk_icon_info_get_attach_points has been deprecated since version 3.14 and should not be used in newly-written code.
Attachment points are deprecated
This function is deprecated and always returns FALSE.
Since: 2.4
gtk_icon_info_get_display_name ()
const gchar *
gtk_icon_info_get_display_name (GtkIconInfo *icon_info);
gtk_icon_info_get_display_name has been deprecated since version 3.14 and should not be used in newly-written code.
Display names are deprecated
This function is deprecated and always returns NULL.
Since: 2.4
gtk_icon_info_is_symbolic ()
gboolean
gtk_icon_info_is_symbolic (GtkIconInfo *icon_info);
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.
Returns
TRUE if the icon is symbolic, FALSE otherwise
Since: 3.12