Scripting::Report Class Reference

#include <KReportScriptReport.h>

Inheritance diagram for Scripting::Report:

Public Slots
void	eventOnComplete ()
void	eventOnNewPage ()
void	eventOnOpen ()
void	initialize (const QJSValue &val)
QString	name () const
QObject *	objectByName (const QString &)
QString	recordSource () const
QObject *	sectionByName (const QString &)
QString	title () const

Public Member Functions
	Report (KReportDocument *)
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
Public Types inherited from QObject
typedef	QObjectList
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)
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

Report object user scripting API.

Contains methods for a report object which can be called by user scripts.
Example:

function report()
{
 this.OnOpen = function()
 {
  debug.print("Report opened!");
 }
}
reportname.initialize(new report())

Definition at line 47 of file KReportScriptReport.h.

Constructor & Destructor Documentation

Report()

Scripting::Report::Report ( KReportDocument * r )

explicit

Definition at line 31 of file KReportScriptReport.cpp.

~Report()

Scripting::Report::~Report ( )

override

Definition at line 38 of file KReportScriptReport.cpp.

Member Function Documentation

eventOnComplete

void Scripting::Report::eventOnComplete ( )

slot

Executed when the report is complete. If a handler exists for this in the user object it is called.

Definition at line 111 of file KReportScriptReport.cpp.

eventOnNewPage

void Scripting::Report::eventOnNewPage ( )

slot

Executed when a new page is created. If a handler exists for this in the user object it is called.

Definition at line 117 of file KReportScriptReport.cpp.

eventOnOpen

void Scripting::Report::eventOnOpen ( )

slot

Executed when the report is opened. If a handler exists for this in the user object it is called.

Definition at line 105 of file KReportScriptReport.cpp.

initialize

void Scripting::Report::initialize ( const QJSValue & val )

slot

Assigns a user object to this report.

Definition at line 100 of file KReportScriptReport.cpp.

name

QString Scripting::Report::name ( ) const

slot

Returns

the name of the report as a string

Definition at line 48 of file KReportScriptReport.cpp.

objectByName

QObject * Scripting::Report::objectByName ( const QString & n )

slot

Returns

an object in the report given its name, or NULL

Definition at line 58 of file KReportScriptReport.cpp.

recordSource

QString Scripting::Report::recordSource ( ) const

slot

Returns

the record source (data source, table, query etc) as a string

Definition at line 53 of file KReportScriptReport.cpp.

sectionByName

QObject * Scripting::Report::sectionByName ( const QString & n )

slot

Returns

a section in the report given its name, or NULL

Definition at line 90 of file KReportScriptReport.cpp.

title

QString Scripting::Report::title ( ) const

slot

Returns

the title of the report as a string

Definition at line 43 of file KReportScriptReport.cpp.

---

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

• KReportScriptReport.h
• KReportScriptReport.cpp