Kross::FormModule

Kross
FormModule

#include <form.h>

Inheritance diagram for Kross::FormModule:

Public Slots
QWidget *	activeModalWidget ()

QWidget *	activeWindow ()

QAction *	createAction (QObject *parent)

QWidget *	createAssistant (const QString &caption)

QWidget *	createDialog (const QString &caption)

QWidget *	createFileWidget (QWidget *parent, const QString &startDirOrVariable=QString())

QObject *	createLayout (QWidget *parent, const QString &layout)

QWidget *	createListView (QWidget *parent)

QWidget *	createWidget (const QString &className)

QWidget *	createWidget (QWidget *parent, const QString &className, const QString &name=QString())

QWidget *	createWidgetFromUI (QWidget *parent, const QString &xml)

QWidget *	createWidgetFromUIFile (QWidget *parent, const QString &filename)

QObject *	loadPart (QWidget *parent, const QString &name, const QUrl &url=QUrl())

QString	showMessageBox (const QString &dialogtype, const QString &caption, const QString &message, const QString &details=QString())

QWidget *	showProgressDialog (const QString &caption, const QString &labelText)

QString	tr (const QString &str)

QString	tr (const QString &str, const QString &comment)

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Member Functions inherited from QObject
	QObject (QObject *parent)

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 ()

void	dumpObjectInfo () const const

void	dumpObjectTree ()

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 QRegExp &regExp, 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

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

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_DISABLE_COPY (Class)

	Q_DISABLE_COPY_MOVE (Class)

	Q_DISABLE_MOVE (Class)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	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	qFindChild (const QObject *obj, const QString &name)

QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)

QList< T >	qFindChildren (const QObject *obj, const QString &name)

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	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)

QThread *	thread () const const

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)

QString	trUtf8 (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

The FormModule provides access to UI functionality like dialogs or widgets.

Example (in Python) :

import Kross
forms = Kross.module("forms")
dialog = forms.createDialog("My Dialog")
dialog.setButtons("Ok|Cancel")
page = dialog.addPage("Welcome","Welcome Page","document-open")
label = forms.createWidget(page,"QLabel")
label.text = "Hello World Label"
if dialog.exec_loop():
    forms.showMessageBox("Information", "Okay...", "The Ok-button was pressed")

Definition at line 535 of file form.h.

Member Function Documentation

◆ activeModalWidget

QWidget * FormModule::activeModalWidget ( )

slot

Returns: the active modal widget. Modal widgets are special top-level widgets which are subclasses of QDialog and are modal.

Definition at line 673 of file form.cpp.

◆ activeWindow

QWidget * FormModule::activeWindow ( )

slot

Returns: the application top-level window that has the keyboard input focus, or NULL if no application window has the focus.

Definition at line 678 of file form.cpp.

◆ createAction

QAction * FormModule::createAction ( QObject * parent )

slot

Create and return a new QAction instance.

Parameters

parent the parent QObject the new QAction instance is a child of.

Returns: the new QAction instance or NULL.

Definition at line 850 of file form.cpp.

◆ createAssistant

QWidget * FormModule::createAssistant ( const QString & caption )

slot

Create and return a new FormAssistant instance.

Parameters

caption The displayed caption of the dialog.

Definition at line 732 of file form.cpp.

◆ createDialog

QWidget * FormModule::createDialog ( const QString & caption )

slot

Create and return a new FormDialog instance.

Parameters

caption The displayed caption of the dialog.

Definition at line 727 of file form.cpp.

◆ createFileWidget

QWidget * FormModule::createFileWidget	(	QWidget *	parent,
		const QString &	startDirOrVariable = `QString()`
	)

slot

Create and return a new FormFileWidget instance.

Parameters

parent	the parent QWidget the new FormFileWidget instance is a child of.
startDirOrVariable	the start-directory or -variable.

Returns: the new FormFileWidget instance or NULL.

Definition at line 832 of file form.cpp.

◆ createLayout

QObject * FormModule::createLayout	(	QWidget *	parent,
		const QString &	layout
	)

slot

Create and return a new QWidget instance.

Parameters

parent	the parent QWidget the new QWidget is a child of.
layout	the layout style the widget has. This could be one of the following strings; QVBoxLayout QHBoxLayout QStackedLayout

Returns: the new QLayout instance or NULL.

Definition at line 737 of file form.cpp.

◆ createListView

QWidget * FormModule::createListView ( QWidget * parent )

slot

Create and return a new FormListView instance.

Parameters

parent the parent QWidget the new FormListView instance is a child of.

Returns: the new FormFileWidget instance or NULL.

Definition at line 841 of file form.cpp.

◆ createWidget [1/2]

QWidget * FormModule::createWidget ( const QString & className )

slot

Create and return a new QWidget instance.

Parameters

parent	the parent QWidget the new QWidget is a child of.
className	the name of the class that should be created and returned. For example "QLabel" or "QForm".
name	the objectName the new widget has.

Returns: the new QWidget instance or NULL.

Definition at line 753 of file form.cpp.

◆ createWidget [2/2]

QWidget * FormModule::createWidget	(	QWidget *	parent,
		const QString &	className,
		const QString &	name = `QString()`
	)

slot

Create and return a new QWidget instance.

Parameters

parent	the parent QWidget the new QWidget is a child of.
className	the name of the class that should be created and returned. For example "QLabel" or "QForm".
name	the objectName the new widget has.

Returns: the new QWidget instance or NULL.

Definition at line 760 of file form.cpp.

◆ createWidgetFromUI

QWidget * FormModule::createWidgetFromUI	(	QWidget *	parent,
		const QString &	xml
	)

slot

Create and return a new QWidget instance.

Parameters

parent	the new QWidget is a child of parent.
xml	the UI XML string used to construct the new widget.

Returns: the new QWidget instance or NULL.

Definition at line 779 of file form.cpp.

◆ createWidgetFromUIFile

QWidget * FormModule::createWidgetFromUIFile	(	QWidget *	parent,
		const QString &	filename
	)

slot

Create and return a new QWidget instance.

Parameters

parent	the parent QWidget the new QWidget is a child of.
filename	the full filename of the UI file which is read and its UI XML content is used to construct the new widget.

Definition at line 816 of file form.cpp.

◆ loadPart

QObject * FormModule::loadPart	(	QWidget *	parent,
		const QString &	name,
		const QUrl &	url = `QUrl()`
	)

slot

Load and return a KPart component.

Parameters

parent	The parent QWidget the KPart's widget will be child of.
name	The name of the KPart library like e.g. "libkhtmlpart".
url	Optional Url that should be opened on load.

Definition at line 855 of file form.cpp.

◆ showMessageBox

QString FormModule::showMessageBox	(	const QString &	dialogtype,
		const QString &	caption,
		const QString &	message,
		const QString &	details = `QString()`
	)

slot

Show a messagebox.

Parameters

dialogtype	The type of the dialog which could be one of the following; Sorry Error Information QuestionYesNo WarningYesNo WarningContinueCancel WarningYesNoCancel QuestionYesNoCancel
caption	The caption the messagedialog displays.
message	The message that is displayed in the messagedialog.
details	The optional details

Returns

The buttoncode which could be one of the following;

Ok
Cancel
Yes
No
Continue

Definition at line 683 of file form.cpp.

◆ showProgressDialog

QWidget * FormModule::showProgressDialog	(	const QString &	caption,
		const QString &	labelText
	)

slot

Show a progressdialog to provide visible feedback on the progress of a slow operation.

Parameters

caption	The caption the progressdialog displays.
labelText	The displayed label.

Returns: The QProgressDialog widget instance.

Definition at line 722 of file form.cpp.

◆ tr [1/2]

QString FormModule::tr ( const QString & str )

slot

Returns: i18n'ed version of the string

Definition at line 770 of file form.cpp.

◆ tr [2/2]

QString FormModule::tr	(	const QString &	str,
		const QString &	comment
	)

slot

Returns: i18n'ed version of the string, differentiated by the comment text (like '@title:window')

Definition at line 774 of file form.cpp.

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

KStandardShortcut::label

QString label(StandardShortcut id)

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kross

Kross::FormModule

Public Slots

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ activeModalWidget

◆ activeWindow

◆ createAction

◆ createAssistant

◆ createDialog

◆ createFileWidget

◆ createLayout

◆ createListView

◆ createWidget [1/2]

◆ createWidget [2/2]

◆ createWidgetFromUI

◆ createWidgetFromUIFile

◆ loadPart

◆ showMessageBox

◆ showProgressDialog

◆ tr [1/2]

◆ tr [2/2]