Gnome::Main Class Reference

#include <main.h>

Inheritance diagram for Gnome::Main:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Main (const Glib::ustring &app_id, const Glib::ustring &app_version, const ModuleInfo &module_info, int argc, char **argv)
 Initialises the current GNOME libraries for use by the application.
 Main (const Glib::ustring &app_id, const Glib::ustring &app_version, const ModuleInfo &module_info, int argc, char **argv, const struct poptOption *options, int flags, poptContext *return_ctx)
 Initialises the current GNOME libraries for use by the application, and takes a table of popt options (popt is the command line argument parsing library).
 Main (const Glib::ustring &app_id, const Glib::ustring &app_version, const ModuleInfo &module_info, int argc, char **argv, Glib::OptionContext &options)
 Initialises the current GNOME libraries for use by the application, and takes an OptionContext for command line arguments.
 ~Main ()

Protected Member Functions

 Main ()
void set_ids (const Glib::ustring &app_id, const Glib::ustring &app_version)

Protected Attributes

Glib::RefPtr< Programm_refProgram

Static Protected Attributes

static char * app_id_
static char * app_version_

Constructor & Destructor Documentation

Gnome::Main::Main ( const Glib::ustring &  app_id,
const Glib::ustring &  app_version,
const ModuleInfo module_info,
int  argc,
char **  argv 
)

Initialises the current GNOME libraries for use by the application.

Every GNOME application will need to use this early in its lifetime to initialize the various GNOME libraries in a consistent fashion. This function is very flexible in allowing the user to specify which modules should be initialised and any special parameter values that should be passed to these modules (along with processing commandline options). It loads the specified module_info, and pulls in all the dependencies. Programs that are not running in setuid or setgid mode will also load modules specified in the --load-modules and also in the GNOME_MODULES environment variable.

Parameters:
app_id Application ID string.
app_version Application Version String. This could be defined in your auto-generated config.h file.
The module to init with this program. This should come from a call such as Gnome::UI::module_info_get().
argc The number of command line arguments contanied in argv.
argv A string array of command line arguments.
Gnome::Main::Main ( const Glib::ustring &  app_id,
const Glib::ustring &  app_version,
const ModuleInfo module_info,
int  argc,
char **  argv,
const struct poptOption *  options,
int  flags,
poptContext *  return_ctx 
)

Initialises the current GNOME libraries for use by the application, and takes a table of popt options (popt is the command line argument parsing library).

Every GNOME application will need to use this early in its lifetime to initialize the various GNOME libraries in a consistent fashion. This function is very flexible in allowing the user to specify which modules should be initialised and any special parameter values that should be passed to these modules (along with processing commandline options). It loads the specified module_info, and pulls in all the dependencies. Programs that are not running in setuid or setgid mode will also load modules specified in the --load-modules and also in the GNOME_MODULES environment variable.

Parameters:
app_id Application ID string.
app_version Application Version String. This could be defined in your auto-generated config.h file.
The module to init with this program. This should come from a call such as Gnome::UI::module_info_get().
argc The number of command line arguments contanied in argv.
argv A string array of command line arguments.
options poptOption table with options to parse.
popt flags.
return_ctx The popt context is returned here.
Deprecated:
Use the constructor that takes a Glib::OptionContext instead.
Gnome::Main::Main ( const Glib::ustring &  app_id,
const Glib::ustring &  app_version,
const ModuleInfo module_info,
int  argc,
char **  argv,
Glib::OptionContext &  options 
)

Initialises the current GNOME libraries for use by the application, and takes an OptionContext for command line arguments.

Every GNOME application will need to use this early in its lifetime to initialize the various GNOME libraries in a consistent fashion. This function is very flexible in allowing the user to specify which modules should be initialised and any special parameter values that should be passed to these modules (along with processing commandline options). It loads the specified module_info, and pulls in all the dependencies. Programs that are not running in setuid or setgid mode will also load modules specified in the --load-modules and also in the GNOME_MODULES environment variable.

Parameters:
app_id Application ID string.
app_version Application Version String. This could be defined in your auto-generated config.h file.
The module to init with this program. This should come from a call such as Gnome::UI::module_info_get().
argc The number of command line arguments contanied in argv.
argv A string array of command line arguments.
options Context with options to parse.
Gnome::Main::~Main (  ) 
Gnome::Main::Main (  )  [protected]

Member Function Documentation

void Gnome::Main::set_ids ( const Glib::ustring &  app_id,
const Glib::ustring &  app_version 
) [protected]

Member Data Documentation

char* Gnome::Main::app_id_ [static, protected]
char* Gnome::Main::app_version_ [static, protected]
Glib::RefPtr<Program> Gnome::Main::m_refProgram [protected]

The documentation for this class was generated from the following file:

Generated on Mon Sep 21 13:16:46 2009 for libgnomemm by  doxygen 1.6.1