ConfigList Class Reference

#include <config.h>

Inheritance diagram for ConfigList:

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

Public Member Functions
	ConfigList (const char *name, const char *doc)
void	addValue (const char *v)
void	setWidgetType (WidgetType w)
WidgetType	widgetType () const
QStrList *	valueRef ()
void	writeTemplate (FTextStream &t, bool sl, bool)
void	substEnvVars ()
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
QStrList	m_value
WidgetType	m_widgetType

Additional Inherited Members
Protected Member Functions inherited from ConfigOption
virtual void	convertStrToVal ()
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 respresenting a list type option.

Definition at line 111 of file config.h.

Member Enumeration Documentation

enum ConfigList::WidgetType

Enumerator
String
File
Dir
FileAndDir

Definition at line 114 of file config.h.

{ String, File, Dir, FileAndDir };

Constructor & Destructor Documentation

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

inline

Definition at line 115 of file config.h.

      : ConfigOption(O_List)
    {
      m_name = name;
      m_doc = doc;
      m_widgetType = String;
    }

Member Function Documentation

void ConfigList::addValue ( const char *  v )

inline

Definition at line 122 of file config.h.

{ m_value.append(v); }

void ConfigList::init ( )

inlinevirtual

Reimplemented from ConfigOption.

Definition at line 128 of file config.h.

{ m_value.clear(); }

void ConfigList::setWidgetType ( WidgetType  w )

inline

Definition at line 123 of file config.h.

{ m_widgetType = w; }

void ConfigList::substEnvVars ( )

virtual

Implements ConfigOption.

Definition at line 3007 of file config.cpp.

{
  substEnvVarsInStrList(m_value);
}

QStrList* ConfigList::valueRef ( )

inline

Definition at line 125 of file config.h.

{ return &m_value; }

WidgetType ConfigList::widgetType ( ) const

inline

Definition at line 124 of file config.h.

{ return m_widgetType; }

void ConfigList::writeTemplate ( FTextStream &  t, bool  sl, bool    )

virtual

Implements ConfigOption.

Definition at line 921 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()) << "=";
  writeStringList(t,m_value);
  t << "\n";
}

Member Data Documentation

QStrList ConfigList::m_value

private

Definition at line 130 of file config.h.

WidgetType ConfigList::m_widgetType

private

Definition at line 131 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