Package ch.bailu.gtk.glib

Class OptionEntry

java.lang.Object
ch.bailu.gtk.type.Type
ch.bailu.gtk.type.Pointer
ch.bailu.gtk.type.Record
ch.bailu.gtk.glib.OptionEntry
All Implemented Interfaces:
PointerInterface
public class OptionEntry extends Record
A GOptionEntry struct defines a single option. To have an effect, they
must be added to a #GOptionGroup with g_option_context_add_main_entries()
or g_option_group_add_entries().

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

  • Field Details

    • LONG_NAME

      public static final String LONG_NAME
      The long name of an option can be used to specify it
      in a commandline as `--long_name`. Every option must have a
      long name. To resolve conflicts if multiple option groups contain
      the same long name, it is also possible to specify the option as
      `--groupname-long_name`.
      See Also:

    • SHORT_NAME

      public static final String SHORT_NAME
      If an option has a short name, it can be specified
      `-short_name` in a commandline. @short_name must be a printable
      ASCII character different from '-', or zero if the option has no
      short name.
      See Also:

    • FLAGS

      public static final String FLAGS
      Flags from #GOptionFlags
      See Also:

    • ARG

      public static final String ARG
      The type of the option, as a #GOptionArg
      See Also:

    • ARG_DATA

      public static final String ARG_DATA
      If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data
      must point to a #GOptionArgFunc callback function, which will be
      called to handle the extra argument. Otherwise, @arg_data is a
      pointer to a location to store the value, the required type of
      the location depends on the @arg type:
      - %G_OPTION_ARG_NONE: %gboolean
      - %G_OPTION_ARG_STRING: %gchar*
      - %G_OPTION_ARG_INT: %gint
      - %G_OPTION_ARG_FILENAME: %gchar*
      - %G_OPTION_ARG_STRING_ARRAY: %gchar**
      - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
      - %G_OPTION_ARG_DOUBLE: %gdouble
      If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
      the location will contain a newly allocated string if the option
      was given. That string needs to be freed by the callee using g_free().
      Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or
      %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().
      See Also:

    • DESCRIPTION

      public static final String DESCRIPTION
      the description for the option in `--help`
      output. The @description is translated using the @translate_func
      of the group, see g_option_group_set_translation_domain().
      See Also:

    • ARG_DESCRIPTION

      public static final String ARG_DESCRIPTION
      The placeholder to use for the extra argument parsed
      by the option in `--help` output. The @arg_description is translated
      using the @translate_func of the group, see
      g_option_group_set_translation_domain().
      See Also:

  • Constructor Details

    • OptionEntry

      public OptionEntry(PointerContainer pointer)

    • OptionEntry

      public OptionEntry()

  • Method Details

    • getClassHandler

      public static ClassHandler getClassHandler()

    • setFieldLongName

      public void setFieldLongName(Str long_name)
      The long name of an option can be used to specify it
      in a commandline as `--long_name`. Every option must have a
      long name. To resolve conflicts if multiple option groups contain
      the same long name, it is also possible to specify the option as
      `--groupname-long_name`.

    • getFieldLongName

      public Str getFieldLongName()
      The long name of an option can be used to specify it
      in a commandline as `--long_name`. Every option must have a
      long name. To resolve conflicts if multiple option groups contain
      the same long name, it is also possible to specify the option as
      `--groupname-long_name`.

    • setFieldShortName

      public void setFieldShortName(byte short_name)
      If an option has a short name, it can be specified
      `-short_name` in a commandline. @short_name must be a printable
      ASCII character different from '-', or zero if the option has no
      short name.

    • getFieldShortName

      public byte getFieldShortName()
      If an option has a short name, it can be specified
      `-short_name` in a commandline. @short_name must be a printable
      ASCII character different from '-', or zero if the option has no
      short name.

    • setFieldFlags

      public void setFieldFlags(int flags)
      Flags from #GOptionFlags

    • getFieldFlags

      public int getFieldFlags()
      Flags from #GOptionFlags

    • setFieldArg

      public void setFieldArg(int arg)
      The type of the option, as a #GOptionArg

    • getFieldArg

      public int getFieldArg()
      The type of the option, as a #GOptionArg

    • setFieldArgData

      public void setFieldArgData(Pointer arg_data)
      If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data
      must point to a #GOptionArgFunc callback function, which will be
      called to handle the extra argument. Otherwise, @arg_data is a
      pointer to a location to store the value, the required type of
      the location depends on the @arg type:
      - %G_OPTION_ARG_NONE: %gboolean
      - %G_OPTION_ARG_STRING: %gchar*
      - %G_OPTION_ARG_INT: %gint
      - %G_OPTION_ARG_FILENAME: %gchar*
      - %G_OPTION_ARG_STRING_ARRAY: %gchar**
      - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
      - %G_OPTION_ARG_DOUBLE: %gdouble
      If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
      the location will contain a newly allocated string if the option
      was given. That string needs to be freed by the callee using g_free().
      Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or
      %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().

    • getFieldArgData

      public Pointer getFieldArgData()
      If the @arg type is %G_OPTION_ARG_CALLBACK, then @arg_data
      must point to a #GOptionArgFunc callback function, which will be
      called to handle the extra argument. Otherwise, @arg_data is a
      pointer to a location to store the value, the required type of
      the location depends on the @arg type:
      - %G_OPTION_ARG_NONE: %gboolean
      - %G_OPTION_ARG_STRING: %gchar*
      - %G_OPTION_ARG_INT: %gint
      - %G_OPTION_ARG_FILENAME: %gchar*
      - %G_OPTION_ARG_STRING_ARRAY: %gchar**
      - %G_OPTION_ARG_FILENAME_ARRAY: %gchar**
      - %G_OPTION_ARG_DOUBLE: %gdouble
      If @arg type is %G_OPTION_ARG_STRING or %G_OPTION_ARG_FILENAME,
      the location will contain a newly allocated string if the option
      was given. That string needs to be freed by the callee using g_free().
      Likewise if @arg type is %G_OPTION_ARG_STRING_ARRAY or
      %G_OPTION_ARG_FILENAME_ARRAY, the data should be freed using g_strfreev().

    • setFieldDescription

      public void setFieldDescription(Str description)
      the description for the option in `--help`
      output. The @description is translated using the @translate_func
      of the group, see g_option_group_set_translation_domain().

    • getFieldDescription

      public Str getFieldDescription()
      the description for the option in `--help`
      output. The @description is translated using the @translate_func
      of the group, see g_option_group_set_translation_domain().

    • setFieldArgDescription

      public void setFieldArgDescription(Str arg_description)
      The placeholder to use for the extra argument parsed
      by the option in `--help` output. The @arg_description is translated
      using the @translate_func of the group, see
      g_option_group_set_translation_domain().

    • getFieldArgDescription

      public Str getFieldArgDescription()
      The placeholder to use for the extra argument parsed
      by the option in `--help` output. The @arg_description is translated
      using the @translate_func of the group, see
      g_option_group_set_translation_domain().