Package ch.bailu.gtk.glib

Class Error

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.glib.Error
All Implemented Interfaces:
PointerInterface
public class Error extends Record
The `GError` structure contains information about
an error that has occurred.

https://docs.gtk.org/glib/struct.Error.html

  • Field Details

  • Constructor Details

    • Error

      public Error(PointerContainer pointer)

    • Error

      public Error()

    • Error

      public Error(int domain, int code, @Nonnull Str format, Object... _elipse)
      Creates a new #GError with the given @domain and @code,
      and a message formatted with @format.
      Parameters:
      domain - error domain
      code - error code
      format - printf()-style format for error message
      _elipse - parameters for message format

    • Error

      public Error(int domain, int code, String format, Object... _elipse)
      Creates a new #GError with the given @domain and @code,
      and a message formatted with @format.
      Parameters:
      domain - error domain
      code - error code
      format - printf()-style format for error message
      _elipse - parameters for message format

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setFieldDomain

      public void setFieldDomain(int domain)
      error domain, e.g. %G_FILE_ERROR

    • getFieldDomain

      public int getFieldDomain()
      error domain, e.g. %G_FILE_ERROR

    • setFieldCode

      public void setFieldCode(int code)
      error code, e.g. %G_FILE_ERROR_NOENT

    • getFieldCode

      public int getFieldCode()
      error code, e.g. %G_FILE_ERROR_NOENT

    • setFieldMessage

      public void setFieldMessage(Str message)
      human-readable informative error message

    • getFieldMessage

      public Str getFieldMessage()
      human-readable informative error message

    • newLiteralError

      public static Error newLiteralError(int domain, int code, @Nonnull Str message)
      Creates a new #GError; unlike g_error_new(), @message is
      not a printf()-style format string. Use this function if
      @message contains text you don't have control over,
      that could include printf() escape sequences.
      Parameters:
      domain - error domain
      code - error code
      message - error message
      Returns:
      a new #GError

    • newLiteralError

      public static Error newLiteralError(int domain, int code, String message)
      Creates a new #GError; unlike g_error_new(), @message is
      not a printf()-style format string. Use this function if
      @message contains text you don't have control over,
      that could include printf() escape sequences.
      Parameters:
      domain - error domain
      code - error code
      message - error message
      Returns:
      a new #GError

    • copy

      public Error copy()
      Makes a copy of @error.
      Returns:
      a new #GError

    • free

      public void free()
      Frees a #GError and associated resources.

    • matches

      public boolean matches(int domain, int code)
      Returns %TRUE if @error matches @domain and @code, %FALSE
      otherwise. In particular, when @error is %NULL, %FALSE will
      be returned.

      If @domain contains a `FAILED` (or otherwise generic) error code,
      you should generally not check for it explicitly, but should
      instead treat any not-explicitly-recognized error code as being
      equivalent to the `FAILED` code. This way, if the domain is
      extended in the future to provide a more specific error code for
      a certain case, your code will still work.
      Parameters:
      domain - an error domain
      code - an error code
      Returns:
      whether @error has @domain and @code

    • domainRegister

      public static int domainRegister(@Nonnull Str error_type_name, long error_type_private_size, Error.OnErrorInitFunc error_type_init, Error.OnErrorCopyFunc error_type_copy, Error.OnErrorClearFunc error_type_clear)
      This function registers an extended #GError domain.
      @error_type_name will be duplicated. Otherwise does the same as
      g_error_domain_register_static().
      Parameters:
      error_type_name - string to create a #GQuark from
      error_type_private_size - size of the private error data in bytes
      error_type_init - function initializing fields of the private error data
      error_type_copy - function copying fields of the private error data
      error_type_clear - function freeing fields of the private error data
      Returns:
      #GQuark representing the error domain

    • domainRegisterStatic

      public static int domainRegisterStatic(@Nonnull Str error_type_name, long error_type_private_size, Error.OnErrorInitFunc error_type_init, Error.OnErrorCopyFunc error_type_copy, Error.OnErrorClearFunc error_type_clear)
      This function registers an extended #GError domain.

      @error_type_name should not be freed. @error_type_private_size must
      be greater than 0.

      @error_type_init receives an initialized #GError and should then initialize
      the private data.

      @error_type_copy is a function that receives both original and a copy
      #GError and should copy the fields of the private error data. The standard
      #GError fields are already handled.

      @error_type_clear receives the pointer to the error, and it should free the
      fields of the private error data. It should not free the struct itself though.

      Normally, it is better to use G_DEFINE_EXTENDED_ERROR(), as it
      already takes care of passing valid information to this function.
      Parameters:
      error_type_name - static string to create a #GQuark from
      error_type_private_size - size of the private error data in bytes
      error_type_init - function initializing fields of the private error data
      error_type_copy - function copying fields of the private error data
      error_type_clear - function freeing fields of the private error data
      Returns:
      #GQuark representing the error domain

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