ConfigString Class Reference

#include <config.h>

Inheritance diagram for ConfigString:

Public Types
enum	WidgetType { String, File, Dir, Image }
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
	ConfigString (const char *name, const char *doc)
	~ConfigString ()
void	setWidgetType (WidgetType w)
WidgetType	widgetType () const
void	setDefaultValue (const char *v)
QCString *	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
QCString	m_value
QCString	m_defValue
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 representing a string type option.

Definition at line 165 of file config.h.

Member Enumeration Documentation

enum ConfigString::WidgetType

Enumerator
String
File
Dir
Image

Definition at line 168 of file config.h.

{ String, File, Dir, Image };

Constructor & Destructor Documentation

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

inline

Definition at line 169 of file config.h.

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

ConfigString::~ConfigString ( )

inline

Definition at line 176 of file config.h.

    {
    }

Member Function Documentation

void ConfigString::init ( )

inlinevirtual

Reimplemented from ConfigOption.

Definition at line 185 of file config.h.

{ m_value = m_defValue.copy(); }

void ConfigString::setDefaultValue ( const char *  v )

inline

Definition at line 181 of file config.h.

{ m_defValue = v; }

void ConfigString::setWidgetType ( WidgetType  w )

inline

Definition at line 179 of file config.h.

{ m_widgetType = w; }

void ConfigString::substEnvVars ( )

virtual

Implements ConfigOption.

Definition at line 3002 of file config.cpp.

{
  substEnvVarsInString(m_value);
}

QCString* ConfigString::valueRef ( )

inline

Definition at line 182 of file config.h.

{ return &m_value; }

WidgetType ConfigString::widgetType ( ) const

inline

Definition at line 180 of file config.h.

{ return m_widgetType; }

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

virtual

Implements ConfigOption.

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

Member Data Documentation

QCString ConfigString::m_defValue

private

Definition at line 189 of file config.h.

QCString ConfigString::m_value

private

Definition at line 188 of file config.h.

WidgetType ConfigString::m_widgetType

private

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