Class IconTheme

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.gtk.IconTheme
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class IconTheme extends GObject

Loads themed icons.

The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what “icon theme” is selected by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification There is a fallback icon theme, named hicolor, where applications should install their icons, but additional icon themes can be installed as operating system vendors and users choose.

In many cases, named themes are used indirectly, via Image rather than directly, but looking up icons directly is also simple. The GtkIconTheme object acts as a database of all the icons in the current theme. You can create new GtkIconTheme objects, but it’s much more efficient to use the standard icon theme of the GtkWidget so that the icon information is shared with other people looking up icons.

GtkIconTheme *icon_theme;
GtkIconPaintable *icon;
GdkPaintable *paintable;

icon_theme = gtk_icon_theme_get_for_display (gtk_widget_get_display (my_widget));
icon = gtk_icon_theme_lookup_icon (icon_theme,
                                   "my-icon-name", // icon name
                                   48, // icon size
                                   1,  // scale
                                   0,  // flags);
paintable = GDK_PAINTABLE (icon);
// Use the paintable
g_object_unref (icon);

  • Constructor Details

    • IconTheme

      public IconTheme(MemorySegment address)
      Create a IconTheme instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • IconTheme

      public IconTheme()
      Create a new IconTheme.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the IconTheme class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected IconTheme asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • getForDisplay

      public static IconTheme getForDisplay(Display display)

      Gets the icon theme object associated with display.

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

      Parameters:
      display - a GdkDisplay
      Returns:
      A unique GtkIconTheme associated with the given display. This icon theme is associated with the display and can be used as long as the display is open. Do not ref or unref it.

    • addResourcePath

      public void addResourcePath(String path)

      Adds a resource path that will be looked at when looking for icons, similar to search paths.

      See setResourcePath(String[]).

      This function should be used to make application-specific icons available as part of the icon theme.

      Parameters:
      path - a resource path

    • addSearchPath

      public void addSearchPath(String path)

      Appends a directory to the search path.

      See setSearchPath(String[]).

      Parameters:
      path - directory name to append to the icon path

    • getDisplay

      public @Nullable Display getDisplay()
      Returns the display that the GtkIconTheme object was created for.
      Returns:
      the display of iconTheme

    • getIconNames

      public String[] getIconNames()
      Lists the names of icons in the current icon theme.
      Returns:
      a string array holding the names of all the icons in the theme. You must free the array using g_strfreev().

    • getIconSizes

      public int[] getIconSizes(String iconName)

      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.

      Parameters:
      iconName - the name of an icon
      Returns:
      A 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.

    • getResourcePath

      public @Nullable String @Nullable [] getResourcePath()

      Gets the current resource path.

      See setResourcePath(String[]).

      Returns:
      A list of resource paths

    • getSearchPath

      public @Nullable String @Nullable [] getSearchPath()

      Gets the current search path.

      See setSearchPath(String[]).

      Returns:
      a list of icon theme path directories

    • getThemeName

      public String getThemeName()
      Gets the current icon theme name.
      Returns:
      the current icon theme name,

    • hasGicon

      public boolean hasGicon(Icon gicon)
      Checks whether an icon theme includes an icon for a particular GIcon.
      Parameters:
      gicon - a GIcon
      Returns:
      true if this IconTheme includes an icon for gicon
      Since:
      4.2

    • hasIcon

      public boolean hasIcon(String iconName)
      Checks whether an icon theme includes an icon for a particular name.
      Parameters:
      iconName - the name of an icon
      Returns:
      true if this IconTheme includes an icon for iconName.

    • lookupByGicon

      public IconPaintable lookupByGicon(Icon icon, int size, int scale, TextDirection direction, Set<IconLookupFlags> flags)

      Looks up a icon for a desired size and window scale.

      The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

      Parameters:
      icon - the GIcon to look up
      size - desired icon size, in application pixels
      scale - the desired scale
      direction - text direction the icon will be displayed in
      flags - flags modifying the behavior of the icon lookup
      Returns:
      a GtkIconPaintable containing information about the icon. Unref with g_object_unref()

    • lookupByGicon

      public IconPaintable lookupByGicon(Icon icon, int size, int scale, TextDirection direction, IconLookupFlags... flags)

      Looks up a icon for a desired size and window scale.

      The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

      Parameters:
      icon - the GIcon to look up
      size - desired icon size, in application pixels
      scale - the desired scale
      direction - text direction the icon will be displayed in
      flags - flags modifying the behavior of the icon lookup
      Returns:
      a GtkIconPaintable containing information about the icon. Unref with g_object_unref()

    • lookupIcon

      public IconPaintable lookupIcon(String iconName, @Nullable String @Nullable [] fallbacks, int size, int scale, TextDirection direction, Set<IconLookupFlags> flags)

      Looks up a named icon for a desired size and window scale, returning a GtkIconPaintable.

      The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

      If the available iconName is not available and fallbacks are provided, they will be tried in order.

      If no matching icon is found, then a paintable that renders the "missing icon" icon is returned. If you need to do something else for missing icons you need to use hasIcon(String).

      Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.

      Parameters:
      iconName - the name of the icon to lookup
      fallbacks - fallback names
      size - desired icon size, in application pixels
      scale - the window scale this will be displayed on
      direction - text direction the icon will be displayed in
      flags - flags modifying the behavior of the icon lookup
      Returns:
      a GtkIconPaintable object containing the icon.

    • lookupIcon

      public IconPaintable lookupIcon(String iconName, @Nullable String @Nullable [] fallbacks, int size, int scale, TextDirection direction, IconLookupFlags... flags)

      Looks up a named icon for a desired size and window scale, returning a GtkIconPaintable.

      The icon can then be rendered by using it as a GdkPaintable, or you can get information such as the filename and size.

      If the available iconName is not available and fallbacks are provided, they will be tried in order.

      If no matching icon is found, then a paintable that renders the "missing icon" icon is returned. If you need to do something else for missing icons you need to use hasIcon(String).

      Note that you probably want to listen for icon theme changes and update the icon. This is usually done by overriding the GtkWidgetClass.css-changed() function.

      Parameters:
      iconName - the name of the icon to lookup
      fallbacks - fallback names
      size - desired icon size, in application pixels
      scale - the window scale this will be displayed on
      direction - text direction the icon will be displayed in
      flags - flags modifying the behavior of the icon lookup
      Returns:
      a GtkIconPaintable object containing the icon.

    • setResourcePath

      public void setResourcePath(@Nullable String @Nullable [] path)

      Sets the resource paths that will be looked at when looking for icons, similar to search paths.

      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 or @path/scalable/actions/run.svg.

      Icons that are directly placed in the resource path instead of a subdirectory are also considered as ultimate fallback, but they are treated like unthemed icons.

      Parameters:
      path - NULL-terminated array of resource paths that are searched for icons

    • setSearchPath

      public void setSearchPath(@Nullable String @Nullable [] path)

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

      Parameters:
      path - NULL-terminated array of directories that are searched for icon themes

    • setThemeName

      public void setThemeName(@Nullable String themeName)

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

      Parameters:
      themeName - name of icon theme to use instead of configured theme, or null to unset a previously set custom theme

    • onChanged

      public SignalConnection<IconTheme.ChangedCallback> onChanged(IconTheme.ChangedCallback handler)

      Emitted when the icon theme changes.

      This can happen because current icon theme is switched or because GTK detects that a change has occurred in the contents of the current icon theme.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitChanged

      public void emitChanged()
      Emits the "changed" signal. See onChanged(IconTheme.ChangedCallback).

    • builder

      public static IconTheme.Builder<? extends IconTheme.Builder> builder()
      A IconTheme.Builder object constructs a IconTheme with the specified properties. Use the various set...() methods to set properties, and finish construction with IconTheme.Builder.build().
      Returns:
      the builder object