org::kde::newstuff::Button

org::kde::newstuff::Button Class Reference

Inherits Button.

Properties

var changedEntries
 
string configFile
 
string downloadNewWhat
 
alias engine
 
alias viewMode
 
bool visibleWhenDisabled
 

Signals

void aboutToShowDialog ()
 

Public Member Functions

void showDialog ()
 
void showEntryDetails (providerId, entryId)
 

Detailed Description

A button which when clicked will open a dialog with a NewStuff.Page at the base.

Since
1.1This component is equivalent to the old Button
See also
KNewStuff::Button
Since
5.63

Definition at line 18 of file Button.qml.

Property Documentation

var org::kde::newstuff::Button::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 Button component)

Definition at line 61 of file Button.qml.

string org::kde::newstuff::Button::configFile

The configuration file to use for this button.

Definition at line 32 of file Button.qml.

string org::kde::newstuff::Button::downloadNewWhat

Set the text that should appear on the button.

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

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

Definition at line 39 of file Button.qml.

alias org::kde::newstuff::Button::engine

The engine which handles the content in this Button.

Definition at line 54 of file Button.qml.

alias org::kde::newstuff::Button::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 45 of file Button.qml.

bool org::kde::newstuff::Button::visibleWhenDisabled

If this is true (default is false), the button will be shown when the Kiosk settings are such that Get Hot New Stuff is disallowed (and any other time enabled is set to false).

Usually you would want to leave this alone, but occasionally you may have a reason to leave a button in place that the user is unable to enable.

Definition at line 77 of file Button.qml.

Member Function Documentation

void org::kde::newstuff::Button::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::Button::showDialog ( )

Show the dialog (same as clicking the button), if allowed by the Kiosk settings.

void org::kde::newstuff::Button::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 Wed Jan 27 2021 22:41:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.