Doxygen
ConfigEnum类 参考

Class representing an enum type option. 更多...

#include <configimpl.h>

+ 类 ConfigEnum 继承关系图:
+ ConfigEnum 的协作图:

Public 成员函数

 ConfigEnum (const char *name, const char *doc, const char *defVal)
 
void addValue (const char *v)
 
const std::vector< QCString > & values () const
 
QCStringvalueRef ()
 
void substEnvVars ()
 
void writeTemplate (TextStream &t, bool sl, bool)
 
void convertStrToVal ()
 
void compareDoxyfile (TextStream &t)
 
void writeXMLDoxyfile (TextStream &t)
 
void init ()
 
bool isDefault ()
 
- Public 成员函数 继承自 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 属性

std::vector< QCStringm_valueRange
 
QCString m_value
 
QCString m_defValue
 

额外继承的成员函数

- Public 类型 继承自 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 成员函数 继承自 ConfigOption
virtual void emptyValueToDefault ()
 
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 属性 继承自 ConfigOption
QCString m_spaces
 
QCString m_name
 
QCString m_doc
 
QCString m_dependency
 
QCString m_encoding
 
QCString m_userComment
 
OptionType m_kind
 

详细描述

Class representing an enum type option.

在文件 configimpl.h152 行定义.

构造及析构函数说明

◆ ConfigEnum()

ConfigEnum::ConfigEnum ( const char *  name,
const char *  doc,
const char *  defVal 
)
inline

在文件 configimpl.h155 行定义.

157  {
158  m_name = name;
159  m_doc = doc;
160  m_value = defVal;
161  m_defValue = defVal;
162  }

引用了 m_defValue, ConfigOption::m_doc, ConfigOption::m_name, m_value , 以及 ConfigOption::name().

成员函数说明

◆ addValue()

void ConfigEnum::addValue ( const char *  v)
inline

在文件 configimpl.h163 行定义.

163 { m_valueRange.push_back(v); }

引用了 m_valueRange.

◆ compareDoxyfile()

void ConfigEnum::compareDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

◆ convertStrToVal()

void ConfigEnum::convertStrToVal ( )
virtual

重载 ConfigOption .

◆ init()

void ConfigEnum::init ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h171 行定义.

171 { m_value = m_defValue; }

引用了 m_defValue , 以及 m_value.

◆ isDefault()

bool ConfigEnum::isDefault ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h172 行定义.

172 { return m_value == m_defValue; }

引用了 m_defValue , 以及 m_value.

◆ substEnvVars()

void ConfigEnum::substEnvVars ( )
virtual

实现了 ConfigOption.

◆ valueRef()

QCString* ConfigEnum::valueRef ( )
inline

在文件 configimpl.h165 行定义.

165 { return &m_value; }

引用了 m_value.

◆ values()

const std::vector<QCString>& ConfigEnum::values ( ) const
inline

在文件 configimpl.h164 行定义.

164 { return m_valueRange; }

引用了 m_valueRange.

◆ writeTemplate()

void ConfigEnum::writeTemplate ( TextStream t,
bool  sl,
bool   
)
virtual

实现了 ConfigOption.

◆ writeXMLDoxyfile()

void ConfigEnum::writeXMLDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

类成员变量说明

◆ m_defValue

QCString ConfigEnum::m_defValue
private

在文件 configimpl.h177 行定义.

被这些函数引用 ConfigEnum(), init() , 以及 isDefault().

◆ m_value

QCString ConfigEnum::m_value
private

在文件 configimpl.h176 行定义.

被这些函数引用 ConfigEnum(), init(), isDefault() , 以及 valueRef().

◆ m_valueRange

std::vector<QCString> ConfigEnum::m_valueRange
private

在文件 configimpl.h175 行定义.

被这些函数引用 addValue() , 以及 values().


该类的文档由以下文件生成:
ConfigEnum::m_defValue
QCString m_defValue
Definition: configimpl.h:177
ConfigEnum::m_valueRange
std::vector< QCString > m_valueRange
Definition: configimpl.h:175
ConfigOption::name
QCString name() const
Definition: configimpl.h:70
ConfigOption::O_Enum
@ O_Enum
A fixed set of items
Definition: configimpl.h:46
ConfigOption::m_name
QCString m_name
Definition: configimpl.h:94
ConfigOption::ConfigOption
ConfigOption(OptionType t)
Definition: configimpl.h:60
ConfigEnum::m_value
QCString m_value
Definition: configimpl.h:176
ConfigOption::m_doc
QCString m_doc
Definition: configimpl.h:95