Package ch.bailu.gtk.gtk

Class IconTheme

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.gtk.IconTheme
All Implemented Interfaces:
PointerInterface
public class IconTheme extends Object
`GtkIconTheme` provides a facility for loading 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](http://www.freedesktop.org/Standards/icon-theme-spec)
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 [class@Gtk.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.

```c
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);
```

https://docs.gtk.org/gtk4/class.IconTheme.html

  • Field Details

  • Constructor Details

    • IconTheme

      public IconTheme(PointerContainer pointer)

    • IconTheme

      public IconTheme()
      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
      [func@Gtk.IconTheme.get_for_display] rather than creating
      a new icon theme object for scratch.

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • addResourcePath

      public void addResourcePath(@Nonnull Str path)
      Adds a resource path that will be looked at when looking
      for icons, similar to search paths.

      See [method@Gtk.IconTheme.set_resource_path].

      This function should be used to make application-specific icons
      available as part of the icon theme.
      Parameters:
      path - a resource path

    • addResourcePath

      public void addResourcePath(String path)
      Adds a resource path that will be looked at when looking
      for icons, similar to search paths.

      See [method@Gtk.IconTheme.set_resource_path].

      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(@Nonnull Str path)
      Appends a directory to the search path.

      See [method@Gtk.IconTheme.set_search_path].
      Parameters:
      path - directory name to append to the icon path

    • addSearchPath

      public void addSearchPath(String path)
      Appends a directory to the search path.

      See [method@Gtk.IconTheme.set_search_path].
      Parameters:
      path - directory name to append to the icon path

    • getDisplay

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

    • getIconNames

      public Strs 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(@Nonnull Str 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.
      Parameters:
      icon_name - 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.

    • getIconSizes

      public Int getIconSizes(String 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.
      Parameters:
      icon_name - 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 Strs getResourcePath()
      Gets the current resource path.

      See [method@Gtk.IconTheme.set_resource_path].
      Returns:
      A list of resource paths

    • getSearchPath

      public Strs getSearchPath()
      Gets the current search path.

      See [method@Gtk.IconTheme.set_search_path].
      Returns:
      a list of icon theme path directories

    • getThemeName

      public Str getThemeName()
      Gets the current icon theme name.

      Returns (transfer full): the current icon theme name,
      Returns:

    • hasGicon

      public boolean hasGicon(@Nonnull Icon gicon)
      Checks whether an icon theme includes an icon
      for a particular `GIcon`.
      Parameters:
      gicon - a `GIcon`
      Returns:
      %TRUE if @self includes an icon for @gicon

    • hasIcon

      public boolean hasIcon(@Nonnull Str icon_name)
      Checks whether an icon theme includes an icon
      for a particular name.
      Parameters:
      icon_name - the name of an icon
      Returns:
      %TRUE if @self includes an icon for @icon_name.

    • hasIcon

      public boolean hasIcon(String icon_name)
      Checks whether an icon theme includes an icon
      for a particular name.
      Parameters:
      icon_name - the name of an icon
      Returns:
      %TRUE if @self includes an icon for @icon_name.

    • lookupByGicon

      public IconPaintable lookupByGicon(@Nonnull Icon icon, int size, int scale, int direction, int 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
      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(@Nonnull Str icon_name, @Nullable Strs fallbacks, int size, int scale, int direction, int 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 @icon_name 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 [method@Gtk.IconTheme.has_icon].

      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:
      icon_name - the name of the icon to lookup
      fallbacks -
      size - desired icon size.
      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 icon_name, @Nullable Strs fallbacks, int size, int scale, int direction, int 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 @icon_name 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 [method@Gtk.IconTheme.has_icon].

      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:
      icon_name - the name of the icon to lookup
      fallbacks -
      size - desired icon size.
      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 Strs 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 Strs 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 Str 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 [func@Gtk.IconTheme.get_for_display].
      Parameters:
      theme_name - name of icon theme to use instead of configured theme, or %NULL to unset a previously set custom theme

    • setThemeName

      public void setThemeName(String 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 [func@Gtk.IconTheme.get_for_display].
      Parameters:
      theme_name - name of icon theme to use instead of configured theme, or %NULL to unset a previously set custom theme

    • onChanged

      public SignalHandler onChanged(IconTheme.OnChanged signal)
      Connect to signal "changed".
      See IconTheme.OnChanged.onChanged() for signal description.
      Field SIGNAL_ON_CHANGED contains original signal name and can be used as resource reference.
      Parameters:
      signal - callback function (lambda).
      Returns:
      SignalHandler. Can be used to disconnect signal and to release callback function.

    • getForDisplay

      public static IconTheme getForDisplay(@Nonnull 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
      [ctor@Gtk.IconTheme.new] 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.

    • getTypeID

      public static long getTypeID()

    • getParentTypeID

      public static long getParentTypeID()

    • getTypeSize

      public static TypeSystem.TypeSize getTypeSize()

    • getParentTypeSize

      public static TypeSystem.TypeSize getParentTypeSize()

    • getInstanceSize

      public static int getInstanceSize()