ConfigOption类 参考

Abstract base class for any configuration option. 更多...

#include <configimpl.h>

类 ConfigOption 继承关系图:

ConfigOption 的协作图:

Public 类型
enum	OptionType {   O_Info, O_List, O_Enum, O_String,   O_Int, O_Bool, O_Obsolete, O_Disabled }
enum	{ MAX_OPTION_LENGTH = 23 }

Public 成员函数
	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)

Protected 成员函数
virtual void	writeTemplate (TextStream &t, bool sl, bool upd)=0
virtual void	compareDoxyfile (TextStream &t)=0
virtual void	writeXMLDoxyfile (TextStream &t)=0
virtual void	convertStrToVal ()
virtual void	emptyValueToDefault ()
virtual void	substEnvVars ()=0
virtual void	init ()
virtual bool	isDefault ()
void	writeBoolValue (TextStream &t, bool v, bool initSpace=true)
void	writeIntValue (TextStream &t, int i, bool initSpace=true)
void	writeStringValue (TextStream &t, const QCString &s, bool initSpace=true)
void	writeStringList (TextStream &t, const StringVector &l)

Protected 属性
QCString	m_spaces
QCString	m_name
QCString	m_doc
QCString	m_dependency
QCString	m_encoding
QCString	m_userComment
OptionType	m_kind

友元
class	ConfigImpl

详细描述

Abstract base class for any configuration option.

在文件 configimpl.h 第 35 行定义.

成员枚举类型说明

anonymous enum

anonymous enum

枚举值
MAX_OPTION_LENGTH	Maximum length of an option in the config file. Used for alignment purposes.

在文件 configimpl.h 第 53 行定义.

    {
     /*! Maximum length of an option in the config file. Used for
      *  alignment purposes.
      */
      MAX_OPTION_LENGTH = 23
    };

OptionType

enum ConfigOption::OptionType

The type of option

枚举值
O_Info	A section header
O_List	A list of items
O_Enum	A fixed set of items
O_String	A single item
O_Int	An integer value
O_Bool	A boolean value
O_Obsolete	An obsolete option
O_Disabled	Disabled compile time option

在文件 configimpl.h 第 42 行定义.

    {
      O_Info,      //!< A section header
      O_List,      //!< A list of items
      O_Enum,      //!< A fixed set of items
      O_String,    //!< A single item
      O_Int,       //!< An integer value
      O_Bool,      //!< A boolean value
      O_Obsolete,  //!< An obsolete option
      O_Disabled   //!< Disabled compile time option
    };

构造及析构函数说明

ConfigOption()

ConfigOption::ConfigOption ( OptionType  t )

inline

在文件 configimpl.h 第 60 行定义.

                               : m_kind(t)
    {
      m_spaces.fill(' ',40);
    }

引用了 QCString::fill() , 以及 m_spaces.

~ConfigOption()

virtual ConfigOption::~ConfigOption ( )

inlinevirtual

在文件 configimpl.h 第 64 行定义.

    {
    }

成员函数说明

addDependency()

void ConfigOption::addDependency ( const char *  dep )

inline

在文件 configimpl.h 第 74 行定义.

{ m_dependency = dep; }

引用了 m_dependency.

compareDoxyfile()

virtual void ConfigOption::compareDoxyfile ( TextStream &  t )

protectedpure virtual

在 ConfigBool, ConfigInt, ConfigString, ConfigEnum, ConfigList, ConfigDisabled, ConfigObsolete , 以及 ConfigInfo 内被实现.

convertStrToVal()

virtual void ConfigOption::convertStrToVal ( )

inlineprotectedvirtual

被 ConfigBool, ConfigInt , 以及 ConfigEnum 重载.

在文件 configimpl.h 第 82 行定义.

{}

dependsOn()

QCString ConfigOption::dependsOn ( ) const

inline

在文件 configimpl.h 第 73 行定义.

{ return m_dependency; }

引用了 m_dependency.

docs()

QCString ConfigOption::docs ( ) const

inline

在文件 configimpl.h 第 71 行定义.

{ return m_doc; }

引用了 m_doc.

emptyValueToDefault()

virtual void ConfigOption::emptyValueToDefault ( )

inlineprotectedvirtual

被 ConfigString , 以及 ConfigList 重载.

在文件 configimpl.h 第 83 行定义.

{}

init()

virtual void ConfigOption::init ( )

inlineprotectedvirtual

被 ConfigBool, ConfigInt, ConfigString, ConfigEnum , 以及 ConfigList 重载.

在文件 configimpl.h 第 85 行定义.

{}

isDefault()

virtual bool ConfigOption::isDefault ( )

inlineprotectedvirtual

被 ConfigBool, ConfigInt, ConfigString, ConfigEnum , 以及 ConfigList 重载.

在文件 configimpl.h 第 86 行定义.

{ return true; }

kind()

OptionType ConfigOption::kind ( ) const

inline

returns the kind of option this is.

在文件 configimpl.h 第 69 行定义.

{ return m_kind; }

引用了 m_kind.

name()

QCString ConfigOption::name ( ) const

inline

在文件 configimpl.h 第 70 行定义.

{ return m_name; }

引用了 m_name.

被这些函数引用 ConfigBool::ConfigBool(), ConfigDisabled::ConfigDisabled(), ConfigEnum::ConfigEnum(), ConfigInfo::ConfigInfo(), ConfigInt::ConfigInt(), ConfigList::ConfigList(), ConfigObsolete::ConfigObsolete() , 以及 ConfigString::ConfigString().

setEncoding()

void ConfigOption::setEncoding ( const QCString &  e )

inline

在文件 configimpl.h 第 75 行定义.

{ m_encoding = e; }

引用了 m_encoding.

setUserComment()

void ConfigOption::setUserComment ( const QCString &  u )

inline

在文件 configimpl.h 第 76 行定义.

{ m_userComment += u; }

引用了 m_userComment.

substEnvVars()

virtual void ConfigOption::substEnvVars ( )

protectedpure virtual

在 ConfigDisabled, ConfigObsolete, ConfigBool, ConfigInt, ConfigString, ConfigEnum, ConfigList , 以及 ConfigInfo 内被实现.

writeBoolValue()

void ConfigOption::writeBoolValue ( TextStream &  t, bool  v, bool  initSpace = true  )

protected

writeIntValue()

void ConfigOption::writeIntValue ( TextStream &  t, int  i, bool  initSpace = true  )

protected

writeStringList()

void ConfigOption::writeStringList ( TextStream &  t, const StringVector &  l  )

protected

writeStringValue()

void ConfigOption::writeStringValue ( TextStream &  t, const QCString &  s, bool  initSpace = true  )

protected

writeTemplate()

virtual void ConfigOption::writeTemplate ( TextStream &  t, bool  sl, bool  upd  )

protectedpure virtual

在 ConfigString, ConfigEnum, ConfigList, ConfigInfo, ConfigBool, ConfigInt, ConfigDisabled , 以及 ConfigObsolete 内被实现.

writeXMLDoxyfile()

virtual void ConfigOption::writeXMLDoxyfile ( TextStream &  t )

protectedpure virtual

在 ConfigBool, ConfigInt, ConfigString, ConfigEnum, ConfigList, ConfigDisabled, ConfigObsolete , 以及 ConfigInfo 内被实现.

友元及相关函数文档

ConfigImpl

friend class ConfigImpl

friend

在文件 configimpl.h 第 37 行定义.

类成员变量说明

m_dependency

QCString ConfigOption::m_dependency

protected

在文件 configimpl.h 第 96 行定义.

被这些函数引用 addDependency() , 以及 dependsOn().

m_doc

QCString ConfigOption::m_doc

protected

在文件 configimpl.h 第 95 行定义.

被这些函数引用 ConfigBool::ConfigBool(), ConfigEnum::ConfigEnum(), ConfigInfo::ConfigInfo(), ConfigInt::ConfigInt(), ConfigList::ConfigList(), ConfigString::ConfigString() , 以及 docs().

m_encoding

QCString ConfigOption::m_encoding

protected

在文件 configimpl.h 第 97 行定义.

被这些函数引用 setEncoding().

m_kind

OptionType ConfigOption::m_kind

protected

在文件 configimpl.h 第 99 行定义.

被这些函数引用 kind().

m_name

QCString ConfigOption::m_name

protected

在文件 configimpl.h 第 94 行定义.

被这些函数引用 ConfigBool::ConfigBool(), ConfigDisabled::ConfigDisabled(), ConfigEnum::ConfigEnum(), ConfigInfo::ConfigInfo(), ConfigInt::ConfigInt(), ConfigList::ConfigList(), ConfigObsolete::ConfigObsolete(), ConfigString::ConfigString() , 以及 name().

m_spaces

QCString ConfigOption::m_spaces

protected

在文件 configimpl.h 第 93 行定义.

被这些函数引用 ConfigOption().

m_userComment

QCString ConfigOption::m_userComment

protected

在文件 configimpl.h 第 98 行定义.

被这些函数引用 setUserComment().

---

该类的文档由以下文件生成:

• src/configimpl.h