Doxygen
ConfigList类 参考

Class respresenting a list type option. 更多...

#include <configimpl.h>

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

Public 类型

enum  WidgetType { String, File, Dir, FileAndDir }
 
- 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 }
 

Public 成员函数

 ConfigList (const char *name, const char *doc)
 
void addValue (const char *v)
 
void setWidgetType (WidgetType w)
 
WidgetType widgetType () const
 
StringVectorvalueRef ()
 
StringVector getDefault ()
 
void emptyValueToDefault ()
 
void writeTemplate (TextStream &t, bool sl, bool)
 
void compareDoxyfile (TextStream &t)
 
void writeXMLDoxyfile (TextStream &t)
 
void substEnvVars ()
 
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 属性

StringVector m_value
 
StringVector m_defaultValue
 
WidgetType m_widgetType
 

额外继承的成员函数

- Protected 成员函数 继承自 ConfigOption
virtual void convertStrToVal ()
 
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 respresenting a list type option.

在文件 configimpl.h121 行定义.

成员枚举类型说明

◆ WidgetType

枚举值
String 
File 
Dir 
FileAndDir 

在文件 configimpl.h124 行定义.

124 { String, File, Dir, FileAndDir };

构造及析构函数说明

◆ ConfigList()

ConfigList::ConfigList ( const char *  name,
const char *  doc 
)
inline

在文件 configimpl.h125 行定义.

127  {
128  m_name = name;
129  m_doc = doc;
131  }

引用了 ConfigOption::m_doc, ConfigOption::m_name, m_widgetType, ConfigOption::name() , 以及 String.

成员函数说明

◆ addValue()

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

在文件 configimpl.h132 行定义.

132 { m_defaultValue.push_back(v); }

引用了 m_defaultValue.

◆ compareDoxyfile()

void ConfigList::compareDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

◆ emptyValueToDefault()

void ConfigList::emptyValueToDefault ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h137 行定义.

137 { if (m_value.empty() && !m_defaultValue.empty()) m_value=m_defaultValue; };

引用了 m_defaultValue , 以及 m_value.

◆ getDefault()

StringVector ConfigList::getDefault ( )
inline

在文件 configimpl.h136 行定义.

136 { return m_defaultValue; }

引用了 m_defaultValue.

◆ init()

void ConfigList::init ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h142 行定义.

142 { m_value = m_defaultValue; }

引用了 m_defaultValue , 以及 m_value.

◆ isDefault()

bool ConfigList::isDefault ( )
virtual

重载 ConfigOption .

◆ setWidgetType()

void ConfigList::setWidgetType ( WidgetType  w)
inline

在文件 configimpl.h133 行定义.

133 { m_widgetType = w; }

引用了 m_widgetType.

◆ substEnvVars()

void ConfigList::substEnvVars ( )
virtual

实现了 ConfigOption.

◆ valueRef()

StringVector* ConfigList::valueRef ( )
inline

在文件 configimpl.h135 行定义.

135 { return &m_value; }

引用了 m_value.

◆ widgetType()

WidgetType ConfigList::widgetType ( ) const
inline

在文件 configimpl.h134 行定义.

134 { return m_widgetType; }

引用了 m_widgetType.

◆ writeTemplate()

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

实现了 ConfigOption.

◆ writeXMLDoxyfile()

void ConfigList::writeXMLDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

类成员变量说明

◆ m_defaultValue

StringVector ConfigList::m_defaultValue
private

在文件 configimpl.h146 行定义.

被这些函数引用 addValue(), emptyValueToDefault(), getDefault() , 以及 init().

◆ m_value

StringVector ConfigList::m_value
private

在文件 configimpl.h145 行定义.

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

◆ m_widgetType

WidgetType ConfigList::m_widgetType
private

在文件 configimpl.h147 行定义.

被这些函数引用 ConfigList(), setWidgetType() , 以及 widgetType().


该类的文档由以下文件生成:
ConfigOption::O_List
@ O_List
A list of items
Definition: configimpl.h:45
ConfigOption::name
QCString name() const
Definition: configimpl.h:70
ConfigList::m_defaultValue
StringVector m_defaultValue
Definition: configimpl.h:146
ConfigList::File
@ File
Definition: configimpl.h:124
ConfigOption::m_name
QCString m_name
Definition: configimpl.h:94
ConfigOption::ConfigOption
ConfigOption(OptionType t)
Definition: configimpl.h:60
ConfigList::m_value
StringVector m_value
Definition: configimpl.h:145
ConfigList::String
@ String
Definition: configimpl.h:124
ConfigList::FileAndDir
@ FileAndDir
Definition: configimpl.h:124
ConfigOption::m_doc
QCString m_doc
Definition: configimpl.h:95
ConfigList::Dir
@ Dir
Definition: configimpl.h:124
ConfigList::m_widgetType
WidgetType m_widgetType
Definition: configimpl.h:147