#include <Elements.h>

Inheritance diagram for rdf::Region:

Collaboration diagram for rdf::Region:

Public Types
enum	Type { type_unknown = 0, type_root, type_text_region, type_text_line, type_word, type_separator, type_image, type_graphic, type_chart, type_noise, type_end }

Public Member Functions
	Region (const Type &type=Type::type_unknown)
	Initializes a new instance of the Region class. The Region is the base class for all Region elements that are contained in the extended PAGE XML. More...

void	setSelected (bool select)

bool	selected () const

void	setType (const Region::Type &type)
	Sets the Region type. More...

Region::Type	type () const
	The Region's type (e.g. type_text_region). More...

void	setId (const QString &id)
	Set a unique identifier to the region. More...

QString	id () const
	Returns the Region's unique identifier. More...

void	setCustom (const QString &c)

QString	custom () const

void	setPolygon (const Polygon &polygon)
	Set the polygon which enclosed the Region. The polygon's coordinates are w.r.t the image coordinates. More...

Polygon	polygon () const
	The Region's polygon. More...

void	addChild (QSharedPointer< Region > child)
	Adds a child to the current Region. More...

void	addUniqueChild (QSharedPointer< Region > child)

void	removeChild (QSharedPointer< Region > child)
	Removes the child specified. More...

void	setChildren (const QVector< QSharedPointer< Region > > &children)
	Sets the child regions. More...

QVector< QSharedPointer< Region > >	children () const
	Children of this instance. More...

virtual void	draw (QPainter &p, const RegionTypeConfig &config) const
	Draws the Region to the Painter. More...

virtual QString	toString (bool withChildren=false) const
	Returns a string discribing the Region. More...

virtual QString	childrenToString () const
	Returns a string with all attributes of the Region's children. More...

virtual bool	read (QXmlStreamReader &reader)
	Adds Attributes to the current region. More...

virtual void	write (QXmlStreamWriter &writer, bool withChildren=true, bool close=true) const
	Writes the Region to the XML stream. More...

virtual void	writeChildren (QXmlStreamWriter &writer) const
	Writes the Region's children to the XML stream. More...

virtual bool	operator== (const Region &r1)

Static Public Member Functions
static QVector< QSharedPointer < Region > >	allRegions (QSharedPointer< Region > root)

static QVector< QSharedPointer < Region > >	filter (QSharedPointer< Region > root, const Region::Type &type)

Protected Member Functions
void	collectRegions (QVector< QSharedPointer< Region > > &allRegions, const Region::Type &type=type_unknown) const

virtual bool	readPoints (QXmlStreamReader &reader)

Protected Attributes
Type	mType = Type::type_unknown

bool	mSelected = false

QString	mId

QString	mCustom

Polygon	mPoly

QVector< QSharedPointer< Region > >	mChildren

Friends
DllCoreExport QDataStream &	operator<< (QDataStream &s, const Region &r)
	Writes the Region r to the data stream s More...

DllCoreExport QDebug	operator<< (QDebug d, const Region &r)
	Prints the Region r to the debug output. More...

Member Enumeration Documentation

enum rdf::Region::Type

Enumerator
type_unknown
type_root
type_text_region
type_text_line
type_word
type_separator
type_image
type_graphic
type_chart
type_noise
type_end

Constructor & Destructor Documentation

rdf::Region::Region ( const Type & type = Type::type_unknown )

Initializes a new instance of the Region class. The Region is the base class for all Region elements that are contained in the extended PAGE XML.

Member Function Documentation

void rdf::Region::addChild ( QSharedPointer< Region > child )

Adds a child to the current Region.

Parameters

child The child region.

void rdf::Region::addUniqueChild ( QSharedPointer< Region > child )

QVector< QSharedPointer< Region > > rdf::Region::allRegions ( QSharedPointer< Region > root )

static

QVector< QSharedPointer< Region > > rdf::Region::children ( ) const

Children of this instance.

Returns

QString rdf::Region::childrenToString ( ) const

virtual

Returns a string with all attributes of the Region's children.

Returns

void rdf::Region::collectRegions	(	QVector< QSharedPointer< Region > > &	allRegions,
		const Region::Type &	type = `type_unknown`
	)		const

protected

QString rdf::Region::custom ( ) const

void rdf::Region::draw	(	QPainter &	p,
		const RegionTypeConfig &	config
	)		const

virtual

Draws the Region to the Painter.

Parameters

p	The painter.
config	The configuration containing colors etc.

Reimplemented in rdf::TextLine.

QVector< QSharedPointer< Region > > rdf::Region::filter	(	QSharedPointer< Region >	root,
		const Region::Type &	type
	)

static

QString rdf::Region::id ( ) const

Returns the Region's unique identifier.

Returns

bool rdf::Region::operator== ( const Region & r1 )

virtual

Reimplemented in rdf::SeparatorRegion.

Polygon rdf::Region::polygon ( ) const

The Region's polygon.

Returns

bool rdf::Region::read ( QXmlStreamReader & reader )

virtual

Adds Attributes to the current region.

Parameters

reader XML reader set to the current line (inside a region type).

Returns: false if an opening tag is unknown

Reimplemented in rdf::TextLine.

bool rdf::Region::readPoints ( QXmlStreamReader & reader )

protectedvirtual

void rdf::Region::removeChild ( QSharedPointer< Region > child )

Removes the child specified.

Parameters

child The child region.

bool rdf::Region::selected ( ) const

void rdf::Region::setChildren ( const QVector< QSharedPointer< Region > > & children )

Sets the child regions.

Parameters

children The child regions.

void rdf::Region::setCustom ( const QString & c )

void rdf::Region::setId ( const QString & id )

Set a unique identifier to the region.

Parameters

id	A unique identifier.

void rdf::Region::setPolygon ( const Polygon & polygon )

Set the polygon which enclosed the Region. The polygon's coordinates are w.r.t the image coordinates.

Parameters

polygon A polygon that represents the Region.

void rdf::Region::setSelected ( bool select )

void rdf::Region::setType ( const Region::Type & type )

Sets the Region type.

Parameters

type The type.

QString rdf::Region::toString ( bool withChildren = false ) const

virtual

Returns a string discribing the Region.

Returns

Reimplemented in rdf::TextLine.

Region::Type rdf::Region::type ( ) const

The Region's type (e.g. type_text_region).

Returns

void rdf::Region::write	(	QXmlStreamWriter &	writer,
		bool	withChildren = `true`,
		bool	close = `true`
	)		const

virtual

Writes the Region to the XML stream.

Parameters

writer	The XML stream at the position where the region should be written.
withChildren	if set to `true` the Region's children are written too.
close	if set to `true` the element's close tag is appended.

Reimplemented in rdf::TextLine.

void rdf::Region::writeChildren ( QXmlStreamWriter & writer ) const

virtual

Writes the Region's children to the XML stream.

Parameters

writer The XML stream.

Friends And Related Function Documentation

DllCoreExport QDataStream& operator<<	(	QDataStream &	s,
		const Region &	r
	)

friend

Writes the Region r to the data stream s

Parameters

s	A data stream.
r	A region r.

Returns: The data stream with the current region.

DllCoreExport QDebug operator<<	(	QDebug	d,
		const Region &	r
	)

friend

Prints the Region r to the debug output.

Parameters

d	A Debug output.
r	The Region to be printed.

Returns: The debug output with the current Region.

Member Data Documentation

QVector<QSharedPointer<Region> > rdf::Region::mChildren

protected

QString rdf::Region::mCustom

protected

QString rdf::Region::mId

protected

Polygon rdf::Region::mPoly

protected

bool rdf::Region::mSelected = false

protected

Type rdf::Region::mType = Type::type_unknown

protected

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

src/Core/Elements.h
src/Core/Elements.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation