Package ch.bailu.gtk.gdkpixbuf

Class PixbufFormat

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.gdkpixbuf.PixbufFormat
All Implemented Interfaces:
PointerInterface
public class PixbufFormat extends Record
A `GdkPixbufFormat` contains information about the image format accepted
by a module.

Only modules should access the fields directly, applications should
use the `gdk_pixbuf_format_*` family of functions.

https://docs.gtk.org/gdk-pixbuf/struct.PixbufFormat.html

  • Field Details

  • Constructor Details

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setFieldName

      public void setFieldName(Str name)
      the name of the image format

    • getFieldName

      public Str getFieldName()
      the name of the image format

    • setFieldSignature

      public void setFieldSignature(PixbufModulePattern signature)
      the signature of the module

    • getFieldSignature

      public PixbufModulePattern getFieldSignature()
      the signature of the module

    • setFieldDomain

      public void setFieldDomain(Str domain)
      the message domain for the `description`

    • getFieldDomain

      public Str getFieldDomain()
      the message domain for the `description`

    • setFieldDescription

      public void setFieldDescription(Str description)
      a description of the image format

    • getFieldDescription

      public Str getFieldDescription()
      a description of the image format

    • copy

      public PixbufFormat copy()
      Creates a copy of `format`.
      Returns:
      the newly allocated copy of a `GdkPixbufFormat`. Use gdk_pixbuf_format_free() to free the resources when done

    • free

      public void free()
      Frees the resources allocated when copying a `GdkPixbufFormat`
      using gdk_pixbuf_format_copy()

    • getDescription

      public Str getDescription()
      Returns a description of the format.
      Returns:
      a description of the format.

    • getLicense

      public Str getLicense()
      Returns information about the license of the image loader for the format.

      The returned string should be a shorthand for a well known license, e.g.
      "LGPL", "GPL", "QPL", "GPL/QPL", or "other" to indicate some other license.
      Returns:
      a string describing the license of the pixbuf format

    • getName

      public Str getName()
      Returns the name of the format.
      Returns:
      the name of the format.

    • isDisabled

      public boolean isDisabled()
      Returns whether this image format is disabled.

      See gdk_pixbuf_format_set_disabled().
      Returns:
      whether this image format is disabled.

    • isSaveOptionSupported

      public boolean isSaveOptionSupported(@Nonnull Str option_key)
      Returns `TRUE` if the save option specified by @option_key is supported when
      saving a pixbuf using the module implementing @format.

      See gdk_pixbuf_save() for more information about option keys.
      Parameters:
      option_key - the name of an option
      Returns:
      `TRUE` if the specified option is supported

    • isSaveOptionSupported

      public boolean isSaveOptionSupported(String option_key)
      Returns `TRUE` if the save option specified by @option_key is supported when
      saving a pixbuf using the module implementing @format.

      See gdk_pixbuf_save() for more information about option keys.
      Parameters:
      option_key - the name of an option
      Returns:
      `TRUE` if the specified option is supported

    • isScalable

      public boolean isScalable()
      Returns whether this image format is scalable.

      If a file is in a scalable format, it is preferable to load it at
      the desired size, rather than loading it at the default size and
      scaling the resulting pixbuf to the desired size.
      Returns:
      whether this image format is scalable.

    • isWritable

      public boolean isWritable()
      Returns whether pixbufs can be saved in the given format.
      Returns:
      whether pixbufs can be saved in the given format.

    • setDisabled

      public void setDisabled(boolean disabled)
      Disables or enables an image format.

      If a format is disabled, GdkPixbuf won't use the image loader for
      this format to load images.

      Applications can use this to avoid using image loaders with an
      inappropriate license, see gdk_pixbuf_format_get_license().
      Parameters:
      disabled - `TRUE` to disable the format @format

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