org::kde::newstuff::Dialog

Search for usage in LXR

org::kde::newstuff::Dialog Class Reference

Inherits Dialog.

Properties

alias changedEntries
 
alias configFile
 
string downloadNewWhat
 
alias engine
 
alias viewMode
 

Signals

void aboutToShowDialog ()
 

Public Member Functions

void showEntryDetails (providerId, entryId)
 

Detailed Description

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

Since
1.1This 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 24 of file Dialog.qml.

Property Documentation

alias org::kde::newstuff::Dialog::changedEntries

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)

Definition at line 59 of file Dialog.qml.

alias org::kde::newstuff::Dialog::configFile

The configuration file to use for this button.

Definition at line 29 of file Dialog.qml.

string org::kde::newstuff::Dialog::downloadNewWhat

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

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

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 37 of file Dialog.qml.

alias org::kde::newstuff::Dialog::engine

The engine which handles the content in this dialog.

Definition at line 41 of file Dialog.qml.

alias org::kde::newstuff::Dialog::viewMode

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 47 of file Dialog.qml.

Member Function Documentation

void org::kde::newstuff::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

void org::kde::newstuff::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
providerIdThe provider ID for the entry you wish to show details for
entryIdThe 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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Mar 8 2021 22:41:52 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.