ConfigBool Class Reference

#include <config.h>

Inheritance diagram for ConfigBool:

Public Member Functions
	ConfigBool (const char *name, const char *doc, bool defVal)
QCString *	valueStringRef ()
bool *	valueRef ()
void	convertStrToVal ()
void	substEnvVars ()
void	setValueString (const QCString &v)
void	writeTemplate (FTextStream &t, bool sl, bool upd)
void	init ()
Public Member Functions inherited from ConfigOption
	ConfigOption (OptionType t)
virtual	~ConfigOption ()
OptionType	kind () const
QCString	name () const
QCString	docs () const
QCString	dependsOn () const
void	addDependency (const char *dep)
void	setEncoding (const QCString &e)
void	setUserComment (const QCString &u)

Private Attributes
bool	m_value
bool	m_defValue
QCString	m_valueString

Additional Inherited Members
Public Types inherited from ConfigOption
enum	OptionType {   O_Info, O_List, O_Enum, O_String,   O_Int, O_Bool, O_Obsolete, O_Disabled }
enum	{ MAX_OPTION_LENGTH = 23 }
Protected Member Functions inherited from ConfigOption
void	writeBoolValue (FTextStream &t, bool v)
void	writeIntValue (FTextStream &t, int i)
void	writeStringValue (FTextStream &t, QCString &s)
void	writeStringList (FTextStream &t, QStrList &l)
Protected Attributes inherited from ConfigOption
QCString	m_spaces
QCString	m_name
QCString	m_doc
QCString	m_dependency
QCString	m_encoding
QCString	m_userComment
OptionType	m_kind

Detailed Description

Class representing a Boolean type option.

Definition at line 226 of file config.h.

Constructor & Destructor Documentation

ConfigBool::ConfigBool ( const char *  name, const char *  doc, bool  defVal  )

inline

Definition at line 229 of file config.h.

      : ConfigOption(O_Bool)
    {
      m_name = name;
      m_doc = doc;
      m_value = defVal;
      m_defValue = defVal;
    }

Member Function Documentation

void ConfigBool::convertStrToVal ( )

virtual

Reimplemented from ConfigOption.

Definition at line 807 of file config.cpp.

{
  QCString val = m_valueString.stripWhiteSpace().lower();
  if (!val.isEmpty())
  {
    if (val=="yes" || val=="true" || val=="1" || val=="all") 
    {
      m_value=TRUE;
    }
    else if (val=="no" || val=="false" || val=="0" || val=="none")
    {
      m_value=FALSE;
    }
    else
    {
      config_warn("argument `%s' for option %s is not a valid boolean value\n"
                "Using the default: %s!\n",m_valueString.data(),m_name.data(),m_value?"YES":"NO");
    }
  }
}

void ConfigBool::init ( )

inlinevirtual

Reimplemented from ConfigOption.

Definition at line 243 of file config.h.

{ m_value = m_defValue; }

void ConfigBool::setValueString ( const QCString &  v )

inline

Definition at line 241 of file config.h.

{ m_valueString = v; }

void ConfigBool::substEnvVars ( )

virtual

Implements ConfigOption.

Definition at line 3012 of file config.cpp.

{
  substEnvVarsInString(m_valueString);
}

bool* ConfigBool::valueRef ( )

inline

Definition at line 238 of file config.h.

{ return &m_value; }

QCString* ConfigBool::valueStringRef ( )

inline

Definition at line 237 of file config.h.

{ return &m_valueString; }

void ConfigBool::writeTemplate ( FTextStream &  t, bool  sl, bool  upd  )

virtual

Implements ConfigOption.

Definition at line 996 of file config.cpp.

{
  if (!sl)
  {
    t << endl;
    t << convertToComment(m_doc, m_userComment);
    t << endl;
  }
  else if (!m_userComment.isEmpty())
  {
    t << convertToComment("", m_userComment);
  }
  t << m_name << m_spaces.left(MAX_OPTION_LENGTH-m_name.length()) << "=";
  if (upd && !m_valueString.isEmpty())
  {
    writeStringValue(t,m_valueString);
  }
  else
  {
    writeBoolValue(t,m_value);
  }
  t << "\n";
}

Member Data Documentation

bool ConfigBool::m_defValue

private

Definition at line 246 of file config.h.

bool ConfigBool::m_value

private

Definition at line 245 of file config.h.

QCString ConfigBool::m_valueString

private

Definition at line 247 of file config.h.

---

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

• doxygen-1.8.11/src/config.h
• doxygen-1.8.11/build/generated_src/config.cpp