goption.h File Reference

API published in:
API deprecated in:


#include <_ansi.h>
#include <glib/gerror.h>
#include <glib/gquark.h>

Go to the source code of this file.


Data Structures

struct   _GOptionEntry

Defines

#define  G_OPTION_ERROR   (g_option_error_quark ())
#define  G_OPTION_REMAINING   ""

Typedefs

typedef typedefG_BEGIN_DECLS
struct _GOptionContext 
GOptionContext
typedef _GOptionGroup  GOptionGroup
typedef _GOptionEntry  GOptionEntry
typedef gboolean(*  GOptionArgFunc )(const gchar *option_name, const gchar *value, gpointer data, GError **error)
typedef gboolean(*  GOptionParseFunc )(GOptionContext *context, GOptionGroup *group, gpointer data, GError **error)
typedef void(*  GOptionErrorFunc )(GOptionContext *context, GOptionGroup *group, gpointer data, GError **error)

Enumerations

enum   GOptionFlags {
  G_OPTION_FLAG_HIDDEN = 1 << 0, G_OPTION_FLAG_IN_MAIN = 1 << 1, G_OPTION_FLAG_REVERSE = 1 << 2, G_OPTION_FLAG_NO_ARG = 1 << 3,
  G_OPTION_FLAG_FILENAME = 1 << 4, G_OPTION_FLAG_OPTIONAL_ARG = 1 << 5, G_OPTION_FLAG_NOALIAS = 1 << 6
}
enum   GOptionArg {
  G_OPTION_ARG_NONE, G_OPTION_ARG_STRING, G_OPTION_ARG_INT, G_OPTION_ARG_CALLBACK,
  G_OPTION_ARG_FILENAME, G_OPTION_ARG_STRING_ARRAY, G_OPTION_ARG_FILENAME_ARRAY
}
enum   GOptionError { G_OPTION_ERROR_UNKNOWN_OPTION, G_OPTION_ERROR_BAD_VALUE, G_OPTION_ERROR_FAILED }

Functions

IMPORT_C GQuark  g_option_error_quark (void)
IMPORT_C GOptionContext g_option_context_new (const gchar *parameter_string)
IMPORT_C void  g_option_context_free (GOptionContext *context)
IMPORT_C void  g_option_context_set_help_enabled (GOptionContext *context, gboolean help_enabled)
IMPORT_C gboolean  g_option_context_get_help_enabled (GOptionContext *context)
IMPORT_C void  g_option_context_set_ignore_unknown_options (GOptionContext *context, gboolean ignore_unknown)
IMPORT_C gboolean  g_option_context_get_ignore_unknown_options (GOptionContext *context)
IMPORT_C void  g_option_context_add_main_entries (GOptionContext *context, const GOptionEntry *entries, const gchar *translation_domain)
IMPORT_C gboolean  g_option_context_parse (GOptionContext *context, gint *argc, gchar ***argv, GError **error)
IMPORT_C void  g_option_context_add_group (GOptionContext *context, GOptionGroup *group)
IMPORT_C void  g_option_context_set_main_group (GOptionContext *context, GOptionGroup *group)
IMPORT_C GOptionGroup g_option_context_get_main_group (GOptionContext *context)
IMPORT_C GOptionGroup g_option_group_new (const gchar *name, const gchar *description, const gchar *help_description, gpointer user_data, GDestroyNotify destroy)
IMPORT_C void  g_option_group_set_parse_hooks (GOptionGroup *group, GOptionParseFunc pre_parse_func, GOptionParseFunc post_parse_func)
IMPORT_C void  g_option_group_set_error_hook (GOptionGroup *group, GOptionErrorFunc error_func)
IMPORT_C void  g_option_group_free (GOptionGroup *group)
IMPORT_C void  g_option_group_add_entries (GOptionGroup *group, const GOptionEntry *entries)
IMPORT_C void  g_option_group_set_translate_func (GOptionGroup *group, GTranslateFunc func, gpointer data, GDestroyNotify destroy_notify)
IMPORT_C void  g_option_group_set_translation_domain (GOptionGroup *group, const gchar *domain)

Define Documentation

#define G_OPTION_ERROR   (g_option_error_quark ())
 
#define G_OPTION_REMAINING   ""
 

Typedef Documentation

typedef gboolean(* GOptionArgFunc)(const gchar *option_name, const gchar *value, gpointer data, GError **error)
 
typedef typedefG_BEGIN_DECLS struct _GOptionContext GOptionContext
 
typedef struct _GOptionEntry GOptionEntry
 
typedef void(* GOptionErrorFunc)(GOptionContext *context, GOptionGroup *group, gpointer data, GError **error)
 
typedef struct _GOptionGroup GOptionGroup
 
typedef gboolean(* GOptionParseFunc)(GOptionContext *context, GOptionGroup *group, gpointer data, GError **error)
 

Enumeration Type Documentation

enum GOptionArg
 
Enumerator:
G_OPTION_ARG_NONE 
G_OPTION_ARG_STRING 
G_OPTION_ARG_INT 
G_OPTION_ARG_CALLBACK 
G_OPTION_ARG_FILENAME 
G_OPTION_ARG_STRING_ARRAY 
G_OPTION_ARG_FILENAME_ARRAY 
enum GOptionError
 
Enumerator:
G_OPTION_ERROR_UNKNOWN_OPTION 
G_OPTION_ERROR_BAD_VALUE 
G_OPTION_ERROR_FAILED 
enum GOptionFlags
 
Enumerator:
G_OPTION_FLAG_HIDDEN 
G_OPTION_FLAG_IN_MAIN 
G_OPTION_FLAG_REVERSE 
G_OPTION_FLAG_NO_ARG 
G_OPTION_FLAG_FILENAME 
G_OPTION_FLAG_OPTIONAL_ARG 
G_OPTION_FLAG_NOALIAS 

Function Documentation

IMPORT_C void g_option_context_add_group GOptionContext context,
GOptionGroup group
 
IMPORT_C void g_option_context_add_main_entries GOptionContext context,
const GOptionEntry entries,
const gchar translation_domain
 
IMPORT_C void g_option_context_free GOptionContext context  ) 
 
IMPORT_C gboolean g_option_context_get_help_enabled GOptionContext context  ) 
 
IMPORT_C gboolean g_option_context_get_ignore_unknown_options GOptionContext context  ) 
 
IMPORT_C GOptionGroup* g_option_context_get_main_group GOptionContext context  ) 
 
IMPORT_C GOptionContext* g_option_context_new const gchar parameter_string  ) 
 
IMPORT_C gboolean g_option_context_parse GOptionContext context,
gint argc,
gchar ***  argv,
GError **  error
 
IMPORT_C void g_option_context_set_help_enabled GOptionContext context,
gboolean  help_enabled
 
IMPORT_C void g_option_context_set_ignore_unknown_options GOptionContext context,
gboolean  ignore_unknown
 
IMPORT_C void g_option_context_set_main_group GOptionContext context,
GOptionGroup group
 
IMPORT_C GQuark g_option_error_quark void   ) 
 
IMPORT_C void g_option_group_add_entries GOptionGroup group,
const GOptionEntry entries
 
IMPORT_C void g_option_group_free GOptionGroup group  ) 
 
IMPORT_C GOptionGroup* g_option_group_new const gchar name,
const gchar description,
const gchar help_description,
gpointer  user_data,
GDestroyNotify  destroy
 
IMPORT_C void g_option_group_set_error_hook GOptionGroup group,
GOptionErrorFunc  error_func
 
IMPORT_C void g_option_group_set_parse_hooks GOptionGroup group,
GOptionParseFunc  pre_parse_func,
GOptionParseFunc  post_parse_func
 
IMPORT_C void g_option_group_set_translate_func GOptionGroup group,
GTranslateFunc  func,
gpointer  data,
GDestroyNotify  destroy_notify
 
IMPORT_C void g_option_group_set_translation_domain GOptionGroup group,
const gchar domain
 

Copyright © Nokia Corporation 2001-2008
Back to top