glib::optiongroup(3) [suse man page]

Glib::OptionGroup(3)					User Contributed Perl Documentation				      Glib::OptionGroup(3)

NAME

       Glib::OptionGroup

HIERARCHY

	 Glib::Boxed
	 +----Glib::OptionGroup

METHODS

   optiongroup = Glib::OptionGroup->new (key => value, ...)
       Creates a new option group from the given key-value pairs.  The valid keys are name, description, help_description, and entries.  The first
       three specify strings while the last one, entries, specifies an array reference of option entries.  Example:

	 my $group = Glib::OptionGroup->new (
		       name => 'urgs',
		       description => 'Urgs Urgs Urgs',
		       help_description => 'Help with Urgs',
		       entries => @entries);

       An option entry is a hash reference like this:

	 { long_name => 'verbose',
	   short_name => 'v',
	   flags => [qw/reverse hidden in-main/],
	   arg_type => 'none',
	   arg_value => $verbose,
	   description => 'verbose desc.',
	   arg_description => 'verbose arg desc.' }

       Of those keys only long_name, arg_type, and arg_value are required.  So this is a valid option entry too:

	 { long_name => 'package-names',
	   arg_type => 'string-array',
	   arg_value => $package_names }

       For convenience, option entries can also be specified as array references containing long_name, short_name, arg_type, and arg_value:

	 [ 'filenames', 'f', 'filename-array', $filenames ]

       If you don't want an option to have a short name, specify undef for it:

	 [ 'filenames', undef, 'filename-array', $filenames ]

   $group->set_translate_func ($func, $data=undef)
       o   $func (scalar)

       o   $data (scalar)

   $group->set_translation_domain ($domain)
       o   $domain (string)

ENUMS AND FLAGS

   enum Glib::OptionArg
       o   'none' / 'G_OPTION_ARG_NONE'

       o   'string' / 'G_OPTION_ARG_STRING'

       o   'int' / 'G_OPTION_ARG_INT'

       o   'filename' / 'G_OPTION_ARG_FILENAME'

       o   'string-array' / 'G_OPTION_ARG_STRING_ARRAY'

       o   'filename-array' / 'G_OPTION_ARG_FILENAME_ARRAY'

       o   'double' / 'G_OPTION_ARG_DOUBLE'

       o   'int64' / 'G_OPTION_ARG_INT64'

   flags Glib::OptionFlags
       o   'hidden' / 'G_OPTION_FLAG_HIDDEN'

       o   'in-main' / 'G_OPTION_FLAG_IN_MAIN'

       o   'reverse' / 'G_OPTION_FLAG_REVERSE'

       o   'no-arg' / 'G_OPTION_FLAG_NO_ARG'

       o   'filename' / 'G_OPTION_FLAG_FILENAME'

       o   'optional-arg' / 'G_OPTION_FLAG_OPTIONAL_ARG'

       o   'noalias' / 'G_OPTION_FLAG_NOALIAS'

SEE ALSO

       Glib, Glib::Boxed

COPYRIGHT

       Copyright (C) 2003-2009 by the gtk2-perl team.

       This software is licensed under the LGPL.  See Glib for a full notice.

perl v5.12.1							    2010-07-05						      Glib::OptionGroup(3)