libbtic

libbtic — interaction controller library of the buzztard application framework

Synopsis

#include <libbtic/ic.h>

GOptionGroup *      btic_init_get_option_group          (void);
gboolean            btic_init_check                     (int *argc,
                                                         char **argv[],
                                                         GError **err);
void                btic_init                           (int *argc,
                                                         char **argv[]);

Description

The library offers an abstraction of hardware controllers that can be bound to ui controls.

Details

btic_init_get_option_group ()

GOptionGroup *      btic_init_get_option_group          (void);

Returns a GOptionGroup with libbtic's argument specifications. The group is set up to use standard GOption callbacks, so when using this group in combination with GOption parsing methods, all argument parsing and initialization is automated.

This function is useful if you want to integrate libbtic with other libraries that use GOption (see g_option_context_add_group() ).

Returns :

a pointer to a GOption group. Should be dereferenced after use.

btic_init_check ()

gboolean            btic_init_check                     (int *argc,
                                                         char **argv[],
                                                         GError **err);

Initializes the Buzztard interaction controller library.

This function will return FALSE if Buzztard interaction controller could not be initialized for some reason. If you want your program to fail fatally, use btic_init() instead.

argc :

pointer to application's argc

argv :

pointer to application's argv

err :

pointer to a GError to which a message will be posted on error

Returns :

TRUE if Buzztard interaction controller could be initialized.

btic_init ()

void                btic_init                           (int *argc,
                                                         char **argv[]);

Initializes the Buzztard Interaction Controller library.

Note

This function will terminate your program if it was unable to initialize the core for some reason. If you want your program to fall back, use btic_init_check() instead.

WARNING: This function does not work in the same way as corresponding functions in other glib-style libraries, such as gtk_init(). In particular, unknown command line options cause this function to abort program execution.

argc :

pointer to application's argc

argv :

pointer to application's argv