ini::Line Class Reference

Is a comment line, but also superclass for Section and Key. More...

#include <IniLine.h>

Inheritance diagram for ini::Line:

Public Member Functions
	Line (const std::string &sCharLine)
virtual	~Line ()
std::size_t	getLineSizeWithEOL () const
std::string	getText () const
LINE_TYPE	getType () const
void	setText (std::string sCharLine)

Protected Member Functions
	Line ()
	Line (const std::string &sCharLine, LINE_TYPE eLineType)
char *	getTextWithEOL () const

Protected Attributes
LINE_TYPE	m_eLineType
LineFactory	m_LineFactory
std::string	m_sText

Private Member Functions
	Line (const Line &)
Line &	operator= (const Line &)

Friends
class	File
class	LineFactory
class	Section

Detailed Description

Is a comment line, but also superclass for Section and Key.

Author

Helmut Jakoby

Copyright

© 1995 Helmut Jakoby

Constructor & Destructor Documentation

Line() [1/4]

ini::Line::Line

(

const std::string &

sCharLine

)

Constructor with parameter passing.

Parameters

[in]

sCharLine

The text of the entry.

~Line()

virtual ini::Line::~Line ( )

virtual

Destructor, memory being purged.

Line() [2/4]

ini::Line::Line ( const std::string & sCharLine, LINE_TYPE eLineType )

protected

This constructor with parameter passing is not publicly available.

Parameters

[in]	sCharLine	The text of the entry.
[in]	eLineType	The desired type of the entry.

Line() [3/4]

ini::Line::Line ( )

protected

The standard constructor is not publicly available.

Line() [4/4]

ini::Line::Line ( const Line & )

inlineprivate

The copy constructor is not available.

Member Function Documentation

getLineSizeWithEOL()

std::size_t ini::Line::getLineSizeWithEOL

(

)

const

Returns the length of the string from m_sText plus EOL.

Returns

The length of the entry text.

getText()

std::string ini::Line::getText

(

)

const

Returns the text of the INI entry.

Returns

The text.

getTextWithEOL()

char * ini::Line::getTextWithEOL ( ) const

protected

Returns the text of the INI entry as an EOL terminated string.

Returns

The text with a line break at the end.

getType()

LINE_TYPE ini::Line::getType

(

)

const

Returns the type of the entry.

Returns

The type as enumaration.

operator=()

Line & ini::Line::operator= ( const Line & )

private

The assignment operator is not available.

setText()

void ini::Line::setText

(

std::string

sCharLine

)

Sets the text of the INI entry.

Parameters

[in]

sCharLine

The text as string.

Friends And Related Symbol Documentation

File

friend class File

friend

LineFactory

friend class LineFactory

friend

Section

friend class Section

friend

Member Data Documentation

m_eLineType

LINE_TYPE ini::Line::m_eLineType

protected

The type of the entry.

m_LineFactory

LineFactory ini::Line::m_LineFactory

protected

Helper class, returns among other things a type-appropriate entry.

m_sText

std::string ini::Line::m_sText

protected

The text (one line of the INI file) of the entry is stored in this attribute.

---

The documentation for this class was generated from the following file:

• IniLine.h