ConfigBase Class Reference

Base class for configuration settings. More...

#include <config_base.h>

Inheritance diagram for ConfigBase:

Public Member Functions
	ConfigBase ()
	Default constructor.
	ConfigBase (ConfigBase &copy)
	Copy constructor.
	ConfigBase (const ConfigBase &copy)
	Copy constructor.
bool	isValid () const
	Checks if the configuration is valid.

Public Attributes
bool	isConfigValid
	Indicates whether the configuration is valid.
QString	errorMessage
	Error message if the configuration is invalid.

Protected Member Functions
void	setInvalid (const QString &message)
	Sets the configuration as invalid with an error message.

Friends
QDataStream &	operator<< (QDataStream &out, const ConfigBase &config)
	Stream insertion operator for ConfigBase objects.
QDataStream &	operator>> (QDataStream &in, ConfigBase &config)
	Stream extraction operator for ConfigBase objects.

Detailed Description

Base class for configuration settings.

Constructor & Destructor Documentation

ConfigBase() [1/2]

ConfigBase::ConfigBase

(

ConfigBase &

copy

)

Copy constructor.

Parameters

copy	The object to copy.

ConfigBase() [2/2]

ConfigBase::ConfigBase

(

const ConfigBase &

copy

)

Copy constructor.

Parameters

copy	The object to copy.

Member Function Documentation

isValid()

bool ConfigBase::isValid

(

)

const

Checks if the configuration is valid.

Returns

True if the configuration is valid, false otherwise.

setInvalid()

void ConfigBase::setInvalid ( const QString & message )

protected

Sets the configuration as invalid with an error message.

Parameters

message

The error message to set.

Friends And Related Symbol Documentation

operator<<

QDataStream & operator<< ( QDataStream & out, const ConfigBase & config )

friend

Stream insertion operator for ConfigBase objects.

Parameters

out	The output stream.
config	The configuration object to insert.

Returns

A reference to the output stream.

operator>>

QDataStream & operator>> ( QDataStream & in, ConfigBase & config )

friend

Stream extraction operator for ConfigBase objects.

Parameters

in	The input stream.
config	The configuration object to extract into.

Returns

A reference to the input stream.

---

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

• /__w/maki/maki/app/common/config_base.h
• /__w/maki/maki/app/common/config_base.cpp