Button

Search for usage in LXR

Inherits Button.

Properties

var changedEntries
 
Binding changedEntriesBinding
 
string configFile
 
string downloadNewWhat
 
QtObject engine
 
Connections engineConnections
 
Item ghnsDialog
 
int viewMode
 
bool visibleWhenDisabled
 

Signals

void aboutToShowDialog ()
 
void entryEvent (QtObject entry, int event)
 

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.

This component is equivalent to the old Button

See also
KNewStuff::Button
Since
5.63

Definition at line 16 of file Button.qml.

Property Documentation

◆ changedEntries

var Button::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 Button component)
Deprecated:
Since 5.82, use entryEvent instead

Definition at line 71 of file Button.qml.

◆ configFile

string Button::configFile
read

The configuration file to use for this button.

Definition at line 30 of file Button.qml.

◆ downloadNewWhat

string Button::downloadNewWhat
read

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

◆ engine

QtObject Button::engine
read

The engine which handles the content in this Button.

Definition at line 55 of file Button.qml.

◆ viewMode

int Button::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 46 of file Button.qml.

◆ visibleWhenDisabled

bool Button::visibleWhenDisabled
read

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 89 of file Button.qml.

Member Function Documentation

◆ aboutToShowDialog

void 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

◆ entryEvent

void Button::entryEvent ( QtObject  entry,
int  event 
)
signal

This forwards the entryEvent from the QtQuick engine.

See also
Engine::entryEvent
Since
5.82

◆ showDialog()

void Button::showDialog ( )

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

◆ showEntryDetails()

void 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-2023 The KDE developers.
Generated on Sun Dec 3 2023 03:58:30 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.