text_stream::OTextStreamBase::Context Class Reference

Conversion context. More...

#include <OTextStream.h>

Collaboration diagram for text_stream::OTextStreamBase::Context:

List of all members.

Public Member Functions
bool	Opt (Opt::Option opt, long *value=0)
	Get option presence and value.
void	SetOpt (Opt::Option opt, long value=0)
	Set specified option.
void	ClearOpt (Opt::Option opt)
	Clear specified option.
void	ClearAllOpts ()
	Clear all options.
void	End ()
	Indicate end of stream status.
size_t	operator++ (int)
	Increment counter of written characters.
size_t	operator+= (size_t addend)
	Add specified value to counter for written characters.
Context &	operator+= (const Context &ctx)
	Apply provided sub-context state to the given context.
	operator size_t ()
	Get number of written characters.
	operator bool ()
	Get end of stream status.

---

Detailed Description

Conversion context.

---

Member Function Documentation

void text_stream::OTextStreamBase::Context::ClearAllOpts

(

)

[inline]

Clear all options.

void text_stream::OTextStreamBase::Context::ClearOpt

(

Opt::Option

opt

)

[inline]

Clear specified option.

Parameters:

opt	Option to clear.

void text_stream::OTextStreamBase::Context::End

(

)

[inline]

Indicate end of stream status.

text_stream::OTextStreamBase::Context::operator bool

(

)

[inline]

Get end of stream status.

Returns:

true if end of stream not yet reached.

text_stream::OTextStreamBase::Context::operator size_t

(

)

[inline]

Get number of written characters.

size_t text_stream::OTextStreamBase::Context::operator++

(

int

)

[inline]

Increment counter of written characters.

Returns:

New counter value.

Context& text_stream::OTextStreamBase::Context::operator+=

(

const Context &

ctx

)

[inline]

Apply provided sub-context state to the given context.

size_t text_stream::OTextStreamBase::Context::operator+=

(

size_t

addend

)

[inline]

Add specified value to counter for written characters.

Parameters:

addend

Value to add.

Returns:

New counter value.

bool text_stream::OTextStreamBase::Context::Opt	(	Opt::Option	opt,
		long *	value = 0
	)		[inline]

Get option presence and value.

Parameters:

opt	Option to check.
value	Optional pointer where the option value should be stored. Can be zero if value is not required.

Returns:

true if the option is set, false otherwise.

void text_stream::OTextStreamBase::Context::SetOpt	(	Opt::Option	opt,
		long	value = 0
	)		[inline]

Set specified option.

Parameters:

opt	Option to set.
value	Optional associated value.

---

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

• include/common/OTextStream.h
• lib/common/OTextStream.cpp