KDevelop API Documentation
Overview Architecture Class Hierarchy Classes Classes (annotated) Members Namespaces Source Files
Search for 

ConfigOption Class Reference

Abstract base class for any configuration option. More...

#include <config.h>

Inheritance diagram for ConfigOption:

Inheritance graph
[legend]
Collaboration diagram for ConfigOption:

Collaboration graph
[legend]
List of all members.

Public Types

enum  OptionType {
  O_Info, O_List, O_Enum, O_String,
  O_Int, O_Bool, O_Obsolete
}
enum  { MAX_OPTION_LENGTH = 23 }

Public Member Functions

 ConfigOption (OptionType t)
virtual ~ConfigOption ()
OptionType kind () const
QCString name () const
QCString docs () const
QCString dependsOn () const
void addDependency (const char *dep)

Protected Member Functions

virtual void writeTemplate (QTextStream &t, bool sl, bool upd)=0
virtual void convertStrToVal ()
virtual void substEnvVars ()=0
virtual void init ()
QCString convertToComment (const QCString &s)
void writeBoolValue (QTextStream &t, bool v)
void writeIntValue (QTextStream &t, int i)
void writeStringValue (QTextStream &t, QCString &s)
void writeStringList (QTextStream &t, QStrList &l)

Protected Attributes

QCString m_spaces
QCString m_name
QCString m_doc
QCString m_dependency
OptionType m_kind

Friends

class Config

Detailed Description

Abstract base class for any configuration option.

Definition at line 13 of file config.h.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
MAX_OPTION_LENGTH  Maximum length of an option in the config file. Used for alignment purposes.

Definition at line 30 of file config.h.

enum ConfigOption::OptionType
 

The type of option

Enumeration values:
O_Info 
O_List 
O_Enum 
O_String 
O_Int 
O_Bool 
O_Obsolete 

Definition at line 20 of file config.h.

Constructor & Destructor Documentation

ConfigOption::ConfigOption (  OptionType  t  )  [inline]
 

Definition at line 37 of file config.h.

virtual ConfigOption::~ConfigOption (   )  [inline, virtual]
 

Definition at line 41 of file config.h.

Member Function Documentation

void ConfigOption::addDependency (  const char *  dep  )  [inline]
 

Definition at line 51 of file config.h.

virtual void ConfigOption::convertStrToVal (   )  [inline, protected, virtual]
 

Reimplemented in ConfigInt, and ConfigBool.

Definition at line 55 of file config.h.

QCString ConfigOption::convertToComment (  const QCString &  s  )  [protected]
 

Definition at line 582 of file config.cpp.

References s.

Referenced by ConfigBool::writeTemplate(), ConfigInt::writeTemplate(), ConfigString::writeTemplate(), ConfigEnum::writeTemplate(), and ConfigList::writeTemplate().

QCString ConfigOption::dependsOn (   )  const [inline]
 

Definition at line 50 of file config.h.

Referenced by DoxygenConfigWidget::DoxygenConfigWidget().

QCString ConfigOption::docs (   )  const [inline]
 

Definition at line 48 of file config.h.

Referenced by DoxygenConfigWidget::DoxygenConfigWidget().

virtual void ConfigOption::init (   )  [inline, protected, virtual]
 

Reimplemented in ConfigList, ConfigEnum, ConfigString, ConfigInt, and ConfigBool.

Definition at line 57 of file config.h.

OptionType ConfigOption::kind (   )  const [inline]
 

returns the kind of option this is.

Definition at line 46 of file config.h.

Referenced by configYYlex(), DoxygenConfigWidget::DoxygenConfigWidget(), Config::getBool(), Config::getEnum(), Config::getInt(), Config::getList(), and Config::getString().

QCString ConfigOption::name (   )  const [inline]
 

Definition at line 47 of file config.h.

Referenced by DoxygenConfigWidget::DoxygenConfigWidget().

virtual void ConfigOption::substEnvVars (   )  [protected, pure virtual]
 

Implemented in ConfigInfo, ConfigList, ConfigEnum, ConfigString, ConfigInt, ConfigBool, and ConfigObsolete.

void ConfigOption::writeBoolValue (  QTextStream &  t,
bool  v
)  [protected]
 

Definition at line 602 of file config.cpp.

Referenced by ConfigBool::writeTemplate().

void ConfigOption::writeIntValue (  QTextStream &  t,
int  i
)  [protected]
 

Definition at line 607 of file config.cpp.

Referenced by ConfigInt::writeTemplate().

void ConfigOption::writeStringList (  QTextStream &  t,
QStrList &  l
)  [protected]
 

Definition at line 639 of file config.cpp.

References first(), l, s, and writeStringValue().

Referenced by ConfigList::writeTemplate().

void ConfigOption::writeStringValue (  QTextStream &  t,
QCString &  s
)  [protected]
 

Definition at line 612 of file config.cpp.

References s.

Referenced by writeStringList(), ConfigBool::writeTemplate(), ConfigInt::writeTemplate(), ConfigString::writeTemplate(), and ConfigEnum::writeTemplate().

virtual void ConfigOption::writeTemplate (  QTextStream &  t,
bool  sl,
bool  upd
)  [protected, pure virtual]
 

Implemented in ConfigInfo, ConfigList, ConfigEnum, ConfigString, ConfigInt, ConfigBool, and ConfigObsolete.

Friends And Related Function Documentation

friend class Config [friend]
 

Definition at line 15 of file config.h.

Member Data Documentation

QCString ConfigOption::m_dependency [protected]
 

Definition at line 68 of file config.h.

QCString ConfigOption::m_doc [protected]
 

Definition at line 67 of file config.h.

OptionType ConfigOption::m_kind [protected]
 

Definition at line 69 of file config.h.

QCString ConfigOption::m_name [protected]
 

Definition at line 66 of file config.h.

QCString ConfigOption::m_spaces [protected]
 

Definition at line 65 of file config.h.

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:38:32 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003