ORODocument Class Reference

#include <KReportRenderObjects.h>

Inheritance diagram for ORODocument:

Signals
void	updated (int pageNo)

Public Member Functions
	ORODocument (const QString &title=QString())
void	addPage (OROPage *page)
void	addSection (OROSection *section)
void	notifyChange (int pageNo)
OROPage *	page (int index)
const OROPage *	page (int index) const
int	pageCount () const
int	pageIndex (const OROPage *page) const
QPageLayout	pageLayout () const
void	removePage (OROPage *page)
void	removeSection (OROSection *section)
OROSection *	section (int index)
const OROSection *	section (int index) const
int	sectionCount () const
void	setPageLayout (const QPageLayout &layout)
void	setTitle (const QString &title)
void	takePage (OROPage *page)
void	takeSection (OROSection *section)
QString	title () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Public Attributes inherited from QObject
typedef	QObjectList
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Represents a single document containing one or more OROPage elements.

Definition at line 49 of file KReportRenderObjects.h.

Constructor & Destructor Documentation

ORODocument()

ORODocument::ORODocument ( const QString & title = QString() )

explicit

Definition at line 56 of file KReportRenderObjects.cpp.

~ORODocument()

ORODocument::~ORODocument ( )

override

Definition at line 61 of file KReportRenderObjects.cpp.

Member Function Documentation

addPage()

void ORODocument::addPage

(

OROPage *

page

)

Adds the supplied page to this document.

Ownership of the page is tranferred the document

Parameters

page	an OROPage* to be added

Definition at line 81 of file KReportRenderObjects.cpp.

addSection()

void ORODocument::addSection

(

OROSection *

section

)

Adds the supplied sectin to the document.

Ownership of the section is transferred to the document

Parameters

section

OROSection* to add to the document

Definition at line 106 of file KReportRenderObjects.cpp.

notifyChange()

void ORODocument::notifyChange

(

int

pageNo

)

Definition at line 123 of file KReportRenderObjects.cpp.

page() [1/2]

OROPage * ORODocument::page

(

int

index

)

Return a pointer to a given page.

Parameters

index

page number to find

Returns

OROPage*

Definition at line 71 of file KReportRenderObjects.cpp.

page() [2/2]

const OROPage * ORODocument::page

(

int

index

)

const

Definition at line 76 of file KReportRenderObjects.cpp.

pageCount()

int ORODocument::pageCount

(

)

const

Return the total number of pages in the document.

Definition at line 133 of file KReportRenderObjects.cpp.

pageIndex()

int ORODocument::pageIndex

(

const OROPage *

page

)

const

Returns the index of the supplied page in the document.

Parameters

page	OROPage* to find

Returns

int page index

Definition at line 170 of file KReportRenderObjects.cpp.

pageLayout()

QPageLayout ORODocument::pageLayout

(

)

const

Definition at line 128 of file KReportRenderObjects.cpp.

removePage()

void ORODocument::removePage

(

OROPage *

page

)

Removes the given page from the document.

The page is also deleted

Parameters

page	OROPage* to delete

Definition at line 148 of file KReportRenderObjects.cpp.

removeSection()

void ORODocument::removeSection

(

OROSection *

section

)

Removes the supplied section from the document.

The section will also be deleted

Parameters

section

OROSection* to remove and delete

Definition at line 159 of file KReportRenderObjects.cpp.

section() [1/2]

OROSection * ORODocument::section

(

int

index

)

Return a pointer to a given section.

Parameters

index

section number to find

Returns

OROSection*

Definition at line 95 of file KReportRenderObjects.cpp.

section() [2/2]

const OROSection * ORODocument::section

(

int

index

)

const

Definition at line 100 of file KReportRenderObjects.cpp.

sectionCount()

int ORODocument::sectionCount

(

)

const

Return the total number of sections in the document.

Definition at line 138 of file KReportRenderObjects.cpp.

setPageLayout()

void ORODocument::setPageLayout

(

const QPageLayout &

layout

)

Definition at line 118 of file KReportRenderObjects.cpp.

setTitle()

void ORODocument::setTitle

(

const QString &

title

)

Definition at line 66 of file KReportRenderObjects.cpp.

takePage()

void ORODocument::takePage

(

OROPage *

page

)

Takes the page from the document but does not delete it.

Parameters

page	OROPage* to take from the document

Definition at line 154 of file KReportRenderObjects.cpp.

takeSection()

void ORODocument::takeSection

(

OROSection *

section

)

Takes the section from the document but does not delete it.

Parameters

section

OROSection* to take from the document

Definition at line 165 of file KReportRenderObjects.cpp.

title()

QString ORODocument::title

(

)

const

Definition at line 143 of file KReportRenderObjects.cpp.

---

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

• KReportRenderObjects.h
• KReportRenderObjects.cpp