Package ch.bailu.gtk.gio

Class Icon

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.gobject.Object
ch.bailu.gtk.type.Interface
ch.bailu.gtk.gio.Icon
All Implemented Interfaces:
PointerInterface
public class Icon extends Interface
#GIcon is a very minimal interface for icons. It provides functions
for checking the equality of two icons, hashing of icons and
serializing an icon to and from strings.

#GIcon does not provide the actual pixmap for the icon as this is out
of GIO's scope, however implementations of #GIcon may contain the name
of an icon (see #GThemedIcon), or the path to an icon (see #GLoadableIcon).

To obtain a hash of a #GIcon, see g_icon_hash().

To check if two #GIcons are equal, see g_icon_equal().

For serializing a #GIcon, use g_icon_serialize() and
g_icon_deserialize().

If you want to consume #GIcon (for example, in a toolkit) you must
be prepared to handle at least the three following cases:
#GLoadableIcon, #GThemedIcon and #GEmblemedIcon. It may also make
sense to have fast-paths for other cases (like handling #GdkPixbuf
directly, for example) but all compliant #GIcon implementations
outside of GIO must implement #GLoadableIcon.

If your application or library provides one or more #GIcon
implementations you need to ensure that your new implementation also
implements #GLoadableIcon. Additionally, you must provide an
implementation of g_icon_serialize() that gives a result that is
understood by g_icon_deserialize(), yielding one of the built-in icon
types.

https://docs.gtk.org/gio/iface.Icon.html

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • equal

      public boolean equal(@Nullable Icon icon2)
      Checks if two icons are equal.
      Parameters:
      icon2 - pointer to the second #GIcon.
      Returns:
      %TRUE if @icon1 is equal to @icon2. %FALSE otherwise.

    • serialize

      public Variant serialize()
      Serializes a #GIcon into a #GVariant. An equivalent #GIcon can be retrieved
      back by calling g_icon_deserialize() on the returned value.
      As serialization will avoid using raw icon data when possible, it only
      makes sense to transfer the #GVariant between processes on the same machine,
      (as opposed to over the network), and within the same file system namespace.
      Returns:
      a #GVariant, or %NULL when serialization fails. The #GVariant will not be floating.

    • toStr

      public Str toStr()
      Generates a textual representation of @icon that can be used for
      serialization such as when passing @icon to a different process or
      saving it to persistent storage. Use g_icon_new_for_string() to
      get @icon back from the returned string.

      The encoding of the returned string is proprietary to #GIcon except
      in the following two cases

      - If @icon is a #GFileIcon, the returned string is a native path
      (such as `/path/to/my icon.png`) without escaping
      if the #GFile for @icon is a native file. If the file is not
      native, the returned string is the result of g_file_get_uri()
      (such as `sftp://path/to/my%20icon.png`).

      - If @icon is a #GThemedIcon with exactly one name and no fallbacks,
      the encoding is simply the name (such as `network-server`).
      Returns:
      An allocated NUL-terminated UTF8 string or %NULL if @icon can't be serialized. Use g_free() to free.

    • deserialize

      public static Icon deserialize(@Nonnull Variant value)
      Deserializes a #GIcon previously serialized using g_icon_serialize().
      Parameters:
      value - a #GVariant created with g_icon_serialize()
      Returns:
      a #GIcon, or %NULL when deserialization fails.

    • hash

      public static int hash(@Nonnull Pointer icon)
      Gets a hash for an icon.
      Parameters:
      icon - #gconstpointer to an icon object.
      Returns:
      a #guint containing a hash for the @icon, suitable for use in a #GHashTable or similar data structure.

    • newForString

      public static Icon newForString(@Nonnull Str str) throws AllocationError
      Generate a #GIcon instance from @str. This function can fail if
      @str is not valid - see g_icon_to_string() for discussion.

      If your application or library provides one or more #GIcon
      implementations you need to ensure that each #GType is registered
      with the type system prior to calling g_icon_new_for_string().
      Parameters:
      str - A string obtained via g_icon_to_string().
      Returns:
      An object implementing the #GIcon interface or %NULL if @error is set.
      Throws:
      AllocationError

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