Doxygen
ConfigString类 参考

Class representing a string type option. 更多...

#include <configimpl.h>

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

Public 类型

enum  WidgetType { String, File, Dir, Image }
 
- 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 成员函数

 ConfigString (const char *name, const char *doc)
 
 ~ConfigString ()
 
void setWidgetType (WidgetType w)
 
WidgetType widgetType () const
 
void setDefaultValue (const char *v)
 
QCStringvalueRef ()
 
void writeTemplate (TextStream &t, bool sl, bool)
 
void compareDoxyfile (TextStream &t)
 
void writeXMLDoxyfile (TextStream &t)
 
void substEnvVars ()
 
void init ()
 
void emptyValueToDefault ()
 
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 属性

QCString m_value
 
QCString m_defValue
 
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 representing a string type option.

在文件 configimpl.h182 行定义.

成员枚举类型说明

◆ WidgetType

枚举值
String 
File 
Dir 
Image 

在文件 configimpl.h185 行定义.

185 { String, File, Dir, Image };

构造及析构函数说明

◆ ConfigString()

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

在文件 configimpl.h186 行定义.

188  {
189  m_name = name;
190  m_doc = doc;
192  }

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

◆ ~ConfigString()

ConfigString::~ConfigString ( )
inline

在文件 configimpl.h193 行定义.

194  {
195  }

成员函数说明

◆ compareDoxyfile()

void ConfigString::compareDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

◆ emptyValueToDefault()

void ConfigString::emptyValueToDefault ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h205 行定义.

205 { if (m_value.isEmpty()) m_value=m_defValue; };

引用了 QCString::isEmpty(), m_defValue , 以及 m_value.

◆ init()

void ConfigString::init ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h204 行定义.

204 { m_value = m_defValue; }

引用了 m_defValue , 以及 m_value.

◆ isDefault()

bool ConfigString::isDefault ( )
inlinevirtual

重载 ConfigOption .

在文件 configimpl.h206 行定义.

引用了 m_defValue, m_value , 以及 QCString::stripWhiteSpace().

◆ setDefaultValue()

void ConfigString::setDefaultValue ( const char *  v)
inline

在文件 configimpl.h198 行定义.

198 { m_defValue = v; }

引用了 m_defValue.

◆ setWidgetType()

void ConfigString::setWidgetType ( WidgetType  w)
inline

在文件 configimpl.h196 行定义.

196 { m_widgetType = w; }

引用了 m_widgetType.

◆ substEnvVars()

void ConfigString::substEnvVars ( )
virtual

实现了 ConfigOption.

◆ valueRef()

QCString* ConfigString::valueRef ( )
inline

在文件 configimpl.h199 行定义.

199 { return &m_value; }

引用了 m_value.

◆ widgetType()

WidgetType ConfigString::widgetType ( ) const
inline

在文件 configimpl.h197 行定义.

197 { return m_widgetType; }

引用了 m_widgetType.

◆ writeTemplate()

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

实现了 ConfigOption.

◆ writeXMLDoxyfile()

void ConfigString::writeXMLDoxyfile ( TextStream t)
virtual

实现了 ConfigOption.

类成员变量说明

◆ m_defValue

QCString ConfigString::m_defValue
private

在文件 configimpl.h210 行定义.

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

◆ m_value

QCString ConfigString::m_value
private

在文件 configimpl.h209 行定义.

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

◆ m_widgetType

WidgetType ConfigString::m_widgetType
private

在文件 configimpl.h211 行定义.

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


该类的文档由以下文件生成:
ConfigString::File
@ File
Definition: configimpl.h:185
ConfigOption::name
QCString name() const
Definition: configimpl.h:70
QCString::isEmpty
bool isEmpty() const
Returns TRUE iff the string is empty
Definition: qcstring.h:144
ConfigString::String
@ String
Definition: configimpl.h:185
ConfigOption::O_String
@ O_String
A single item
Definition: configimpl.h:47
ConfigString::m_defValue
QCString m_defValue
Definition: configimpl.h:210
ConfigString::m_value
QCString m_value
Definition: configimpl.h:209
Image
Class representing a bitmap image generated by doxygen.
Definition: image.h:26
ConfigOption::m_name
QCString m_name
Definition: configimpl.h:94
ConfigString::Dir
@ Dir
Definition: configimpl.h:185
QCString::stripWhiteSpace
QCString stripWhiteSpace() const
returns a copy of this string with leading and trailing whitespace removed
Definition: qcstring.h:243
ConfigOption::ConfigOption
ConfigOption(OptionType t)
Definition: configimpl.h:60
ConfigOption::m_doc
QCString m_doc
Definition: configimpl.h:95
ConfigString::m_widgetType
WidgetType m_widgetType
Definition: configimpl.h:211