• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.2 API Reference
  • KDE Home
  • Contact Us
 

KNewStuff

  • KNS3
  • DownloadDialog
Public Member Functions
KNS3::DownloadDialog Class Reference

#include <downloaddialog.h>

Inheritance diagram for KNS3::DownloadDialog:
KDialog QDialog

List of all members.

Public Member Functions

 DownloadDialog (QWidget *parent=0)
 DownloadDialog (const QString &configFile, QWidget *parent=0)
 ~DownloadDialog ()
KNS3::Entry::List changedEntries ()
KNS3::Entry::List installedEntries ()
- Public Member Functions inherited from KDialog
 KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 ~KDialog ()
KPushButton * button (ButtonCode id) const
KIcon buttonIcon (ButtonCode id) const
QString buttonText (ButtonCode id) const
QString buttonToolTip (ButtonCode id) const
QString buttonWhatsThis (ButtonCode id) const
ButtonCode defaultButton () const
QString helpLinkText () const
void incrementInitialSize (const QSize &size)
bool isButtonEnabled (ButtonCode id) const
QWidget * mainWidget ()
virtual QSize minimumSizeHint () const
void restoreDialogSize (const KConfigGroup &config)
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void setButtonFocus (ButtonCode id)
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void setButtonIcon (ButtonCode id, const KIcon &icon)
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void setButtons (ButtonCodes buttonMask)
void setButtonsOrientation (Qt::Orientation orientation)
void setButtonText (ButtonCode id, const QString &text)
void setButtonToolTip (ButtonCode id, const QString &text)
void setButtonWhatsThis (ButtonCode id, const QString &text)
void setDefaultButton (ButtonCode id)
void setEscapeButton (ButtonCode id)
void setInitialSize (const QSize &size)
void setMainWidget (QWidget *widget)
void showButton (ButtonCode id, bool state)
void showButtonSeparator (bool state)
virtual QSize sizeHint () const

Additional Inherited Members

- Public Types inherited from KDialog
enum  ButtonCode
enum  ButtonPopupMode
enum  CaptionFlag
- Public Slots inherited from KDialog
void delayedDestruct ()
void enableButton (ButtonCode id, bool state)
void enableButtonApply (bool state)
void enableButtonCancel (bool state)
void enableButtonOk (bool state)
void enableLinkedHelp (bool state)
bool isDetailsWidgetVisible () const
virtual void setCaption (const QString &caption)
virtual void setCaption (const QString &caption, bool modified)
void setDetailsWidget (QWidget *detailsWidget)
void setDetailsWidgetVisible (bool visible)
void setHelp (const QString &anchor, const QString &appname=QString())
void setHelpLinkText (const QString &text)
virtual void setPlainCaption (const QString &caption)
- Signals inherited from KDialog
void aboutToShowDetails ()
void applyClicked ()
void buttonClicked (KDialog::ButtonCode button)
void cancelClicked ()
void closeClicked ()
void defaultClicked ()
void finished ()
void helpClicked ()
void hidden ()
void layoutHintChanged ()
void noClicked ()
void okClicked ()
void resetClicked ()
void tryClicked ()
void user1Clicked ()
void user2Clicked ()
void user3Clicked ()
void yesClicked ()
- Static Public Member Functions inherited from KDialog
static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void centerOnScreen (QWidget *widget, int screen=-1)
static int groupSpacingHint ()
static QString makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int marginHint ()
static void resizeLayout (QLayout *lay, int margin, int spacing)
static void resizeLayout (QWidget *widget, int margin, int spacing)
static void setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int spacingHint ()
- Public Attributes inherited from KDialog
 Apply
 AppNameCaption
 Cancel
 Close
 Default
 DelayedPopup
 Details
 Help
 HIGCompliantCaption
 InstantPopup
 ModifiedCaption
 No
 NoCaptionFlags
 NoDefault
 None
 Ok
 Reset
 Try
 User1
 User2
 User3
 Yes
- Protected Slots inherited from KDialog
virtual void slotButtonClicked (int button)
void updateGeometry ()
- Protected Member Functions inherited from KDialog
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void closeEvent (QCloseEvent *e)
virtual void hideEvent (QHideEvent *)
virtual void keyPressEvent (QKeyEvent *)
- Protected Attributes inherited from KDialog
KDialogPrivate *const d_ptr

Detailed Description

KNewStuff download dialog.

The download dialog will present items to the user for installation, updates and removal. Preview images as well as other meta information can be seen.

knsrc Files

The Dialog is configured by a .knsrc file containing the KHotNewStuff configuration. Your application should install a file called: $KDEDIR/share/config/appname.knsrc

The file could look like this for wallpapers:

   [KNewStuff3]
   ProvidersUrl=http://download.kde.org/ocs/providers.xml
   Categories=KDE Wallpaper 1920x1200,KDE Wallpaper 1600x1200
   StandardResource=wallpaper
   Uncompress=archive
   

Uncompress can be one of: always, never or archive:

  1. always: assume all downloaded files are archives and need to be extracted
  2. never: never try to extract the file
  3. archive: if the file is an archive, uncompress it, otherwise just pass it on

You have different options to set the target install directory:

  1. StandardResource: standard ressouce dir, such as .kde/share/wallpapers. This is what KStandardDirs::locateLocal(name) will return.
  2. TargetDir: a directory in the share/apps section, such as .kde/share/apps/wallpapers. This is what KStandardDirs::locateLocal("data", name) will return.
  3. XdgTargetDir: a directory in the $XDG_DATA_HOME directory such as .local/share/wallpapers (since 4.5).
Since:
4.4

Definition at line 72 of file knewstuff3/downloaddialog.h.


Constructor & Destructor Documentation

DownloadDialog::DownloadDialog ( QWidget *  parent = 0)
explicit

Create a DownloadDialog that lets the user install, update and uninstall contents.

It will try to find a appname.knsrc file with the configuration. Appname is the name of your application as provided in the about data->

Parameters:
parentthe parent of the dialog

Definition at line 58 of file knewstuff3/downloaddialog.cpp.

DownloadDialog::DownloadDialog ( const QString &  configFile,
QWidget *  parent = 0 
)
explicit

Create a DownloadDialog that lets the user install, update and uninstall contents.

Manually specify the name of a .knsrc file where the KHotNewStuff configuration can be found.

Parameters:
configFilethe name of the configuration file
parentthe parent of the dialog

Definition at line 67 of file knewstuff3/downloaddialog.cpp.

DownloadDialog::~DownloadDialog ( )

destructor

Definition at line 98 of file knewstuff3/downloaddialog.cpp.


Member Function Documentation

Entry::List DownloadDialog::changedEntries ( )

The list of entries with changed status (installed/uninstalled)

Returns:
the list of entries

Definition at line 105 of file knewstuff3/downloaddialog.cpp.

Entry::List DownloadDialog::installedEntries ( )

The list of entries that have been newly installed.

Returns:
the list of entries

Definition at line 110 of file knewstuff3/downloaddialog.cpp.


The documentation for this class was generated from the following files:
  • knewstuff3/downloaddialog.h
  • knewstuff3/downloaddialog.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sun Apr 28 2013 14:28:53 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KNewStuff

Skip menu "KNewStuff"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.2 API Reference

Skip menu "kdelibs-4.10.2 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal