Dialog Class Reference

Inheritance diagram for Dialog:

Properties
alias	changedEntries
alias	configFile
string	downloadNewWhat
alias	engine
Connections	engineConnections
alias	viewMode
Properties inherited from QObject
	objectName

Signals
void	aboutToShowDialog ()
void	entryEvent (QtObject entry, int event)
Signals inherited from Window
void	activeViewChanged ()
void	themeChanged ()
void	windowClosed ()

Public Member Functions
void	open ()
void	showEntryDetails (providerId, entryId)
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

Additional Inherited Members
Public Slots inherited from Window
void	activate ()
View *	activeView () const
View *	addView (Document *document)
void	close ()
QAction *	createAction (const QString &id, const QString &text=QString(), const QString &menuLocation=QString("tools/scripts"))
QList< QDockWidget * >	dockers () const
QMainWindow *	qwindow () const
void	showView (View *view)
QList< View * >	views () 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

A dialog which has a NewStuff.Page at the base.

This component is equivalent to the old DownloadDialog, but you should consider using NewStuff.Page instead for a more modern style of integration into your application's flow.

See also

KNewStuff::DownloadDialog

Since

5.63

Definition at line 21 of file Dialog.qml.

Property Documentation

changedEntries

alias Dialog::changedEntries

read

Contains the entries which have been changed.

Note

This is cleared when the dialog is shown, so the changed entries are those changed since the dialog was opened most recently (rather than the lifetime of the instance of the Dialog component)

Deprecated:

Since 5.82, use entryEvent of component.engine instead

Definition at line 70 of file Dialog.qml.

configFile

alias Dialog::configFile

read

The configuration file to use for this button.

Definition at line 28 of file Dialog.qml.

downloadNewWhat

string Dialog::downloadNewWhat

read

Set the text that should appear as the dialog's title.

Will be set as i18nd("knewstuff5", "Download New %1").

@default The name defined by your knsrc config file

Note

For the sake of consistency, you should NOT override the title property, just set this one

Definition at line 36 of file Dialog.qml.

engine

alias Dialog::engine

read

The engine which handles the content in this dialog.

Definition at line 43 of file Dialog.qml.

viewMode

alias Dialog::viewMode

read

The default view mode of the dialog spawned by this button.

This should be set using the NewStuff.Page.ViewMode enum

See also

NewStuff.Page.ViewMode

Definition at line 49 of file Dialog.qml.

Member Function Documentation

aboutToShowDialog

void Dialog::aboutToShowDialog ( )

signal

emitted when the Hot New Stuff dialog is about to be shown, usually as a result of the user having click on the button

entryEvent

void Dialog::entryEvent ( QtObject  entry, int  event  )

signal

This forwards the entryEvent from the QtQuick engine.

See also

Engine::entryEvent

Since

5.82

showEntryDetails()

void Dialog::showEntryDetails	(	providerId	,
		entryId
	)

Show the details page for a specific entry.

If you call this function before the engine initialisation has been completed, the action itself will be postponed until that has happened.

Parameters

providerId	The provider ID for the entry you wish to show details for
entryId	The unique ID for the entry you wish to show details for

Since

5.79

---

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

• Dialog.qml