conf::ConfGlobalQ Class Reference

Class for easy use of the configuration global settings. More...

#include <quick.h>

List of all members.

Public Member Functions

 ConfGlobalQ (ConfLogger &logger)
 Constructor.
virtual ~ConfGlobalQ ()
 Destructor.
virtual bool setup ()
 Adds global directives, variables and include paths.
Confgconf ()
 Returns the Conf object managing global directives.
ConfGlobalglobal ()
 Returns the ConfGlobal object managing variables and include paths.
bool is_setup () const
 Has the setup() function been called?

Protected Attributes

Conf m_gconf
 Add global directives to this object.
ConfGlobal m_global
 Add variables and include paths to this object.


Detailed Description

ConfGlobalQ is a class that encapsulates all configuration global settings stuff, allowing you to focus on the essential, i.e. adding global directives, variables and include paths.

The setup() function must be called before using an object of this class.


Constructor & Destructor Documentation

conf::ConfGlobalQ::ConfGlobalQ ( ConfLogger logger  )  [inline]

Constructs the ConfGlobalQ object.

Parameters:
[in] logger Logger used to construct the Conf object used to store global directives.


Member Function Documentation

virtual bool conf::ConfGlobalQ::setup (  )  [inline, virtual]

Override this function to add global directives to the m_conf object, along with variables and include paths to the m_global object.

This function must be called before using an object of this class.

Returns:
true if setup completed successfully, false otherwise.


The documentation for this class was generated from the following file:
Generated on Fri Apr 18 22:03:28 2008 for Epona API by  doxygen 1.5.3