.TH "KNS::DownloadDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "knewstuff Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNS::DownloadDialog \- Common download dialog for data browsing and installation.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <downloaddialog.h>\fP
.PP
Inherits KDialogBase.
.PP
.SS "Public Slots"

.in +1c
.ti -1c
.RI "void \fBslotProviders\fP (\fBProvider::List\fP *list)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBDownloadDialog\fP (\fBEngine\fP *engine, \fBQWidget\fP *parent, const \fBQString\fP &caption)"
.br
.ti -1c
.RI "\fBDownloadDialog\fP (\fBQWidget\fP *parent, const \fBQString\fP &caption)"
.br
.ti -1c
.RI "\fB~DownloadDialog\fP ()"
.br
.ti -1c
.RI "void \fBsetType\fP (\fBQString\fP type)"
.br
.ti -1c
.RI "void \fBload\fP ()"
.br
.ti -1c
.RI "void \fBsetProviderList\fP (const \fBQString\fP &providerList)"
.br
.ti -1c
.RI "void \fBload\fP (\fBQString\fP providerList)"
.br
.ti -1c
.RI "void \fBaddProvider\fP (\fBProvider\fP *p)"
.br
.ti -1c
.RI "void \fBaddEntry\fP (\fBEntry\fP *entry)"
.br
.ti -1c
.RI "void \fBclear\fP ()"
.br
.ti -1c
.RI "\fBDownloadDialog\fP (\fBEngine\fP *engine, \fBQWidget\fP *parent=0)"
.br
.ti -1c
.RI "\fBDownloadDialog\fP (\fBQWidget\fP *parent=0)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBopen\fP (const \fBQString\fP &type, const \fBQString\fP &caption)"
.br
.ti -1c
.RI "static void \fBopen\fP (\fBQString\fP type)"
.br
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotApply\fP ()"
.br
.ti -1c
.RI "void \fBslotOk\fP ()"
.br
.in -1c
.SH "Detailed Description"
.PP 
Common download dialog for data browsing and installation. 

It provides an easy-to-use convenience method named \fBopen()\fP which does all the work, unless a more complex operation is needed. 
.PP
.nf
 KNewStuff::DownloadDialog::open('kdesktop/wallpapers');

.fi
.PP
.PP
\fBAuthor:\fP
.RS 4
Josef Spillner (spillner@kde.org) 
.RE
.PP
\fBMaintainer:\fP.RS 4
Josef Spillner (spillner@kde.org) 
.RE
.PP

.PP
Definition at line 57 of file downloaddialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KNS::DownloadDialog::DownloadDialog (\fBEngine\fP * engine, \fBQWidget\fP * parent, const \fBQString\fP & caption)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIengine\fP a pre-built engine object, or NULL if the download dialog should create an engine on its own 
.br
\fIparent\fP the parent window 
.br
\fIcaption\fP the dialog caption 
.RE
.PP

.SS "KNS::DownloadDialog::DownloadDialog (\fBQWidget\fP * parent, const \fBQString\fP & caption)"
.PP
Alternative constructor. 
.PP
Always uses an internal engine.
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the parent window 
.br
\fIcaption\fP the dialog caption 
.RE
.PP

.SS "KNS::DownloadDialog::~\fBDownloadDialog\fP ()"
.PP
Destructor. 
.PP
.SS "KNS::DownloadDialog::DownloadDialog (\fBEngine\fP * engine, \fBQWidget\fP * parent = \fC0\fP)"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIengine\fP a pre-built engine object, or NULL if the download dialog should create an engine on its own 
.br
\fIparent\fP the parent window 
.RE
.PP

.SS "KNS::DownloadDialog::DownloadDialog (\fBQWidget\fP * parent = \fC0\fP)"
.PP
Alternative constructor. 
.PP
Always uses an internal engine.
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP the parent window 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "void KNS::DownloadDialog::setType (\fBQString\fP type)"
.PP
Restricts the display of available data to a certain data type. 
.PP
\fBParameters:\fP
.RS 4
\fItype\fP a Hotstuff data type such as 'korganizer/calendar' 
.RE
.PP

.SS "void KNS::DownloadDialog::load ()"
.PP
Fetches descriptions of all available data, optionally considering a previously set type. 
.PP
.SS "void KNS::DownloadDialog::setProviderList (const \fBQString\fP & providerList)"
.PP
Explicitly uses this provider list instead of the one read from the application configuration. 
.PP
\fBParameters:\fP
.RS 4
\fIproviderList\fP the URL of the provider list
.RE
.PP
\fBSince:\fP
.RS 4
3.4 
.RE
.PP

.SS "void KNS::DownloadDialog::load (\fBQString\fP providerList)"
.PP
Fetches descriptions of all available data, optionally considering a previously set type. 
.PP
\fBParameters:\fP
.RS 4
\fIproviderList\fP the URl to the list of providers; if empty we first try the ProvidersUrl from KGlobal::config, then we fall back to a hardcoded value. 
.RE
.PP

.SS "void KNS::DownloadDialog::addProvider (\fBProvider\fP * p)"
.PP
Adds another provider to the download dialog. 
.PP
This is normally done internally.
.PP
\fBParameters:\fP
.RS 4
\fIp\fP the Hotstuff provider to be added 
.RE
.PP

.SS "void KNS::DownloadDialog::addEntry (\fBEntry\fP * entry)"
.PP
Adds an additional entry to the current provider. 
.PP
This is normally done internally.
.PP
\fBParameters:\fP
.RS 4
\fIentry\fP a Hotstuff data entry to be added 
.RE
.PP

.SS "void KNS::DownloadDialog::clear ()"
.PP
Clears the entry list of the current provider. 
.PP
This is normally done internally. 
.SS "static void KNS::DownloadDialog::open (const \fBQString\fP & type, const \fBQString\fP & caption)\fC [static]\fP"
.PP
Opens the download dialog. 
.PP
This is a convenience method which automatically sets up the dialog. 
.PP
\fBSee also:\fP
.RS 4
\fBsetType()\fP 
.PP
\fBload()\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fItype\fP a data type such as 'korganizer/calendar' 
.br
\fIcaption\fP the dialog caption 
.RE
.PP

.SS "static void KNS::DownloadDialog::open (\fBQString\fP type)\fC [static]\fP"
.PP
Opens the download dialog. 
.PP
This is a convenience method which automatically sets up the dialog. 
.PP
\fBSee also:\fP
.RS 4
\fBsetType()\fP 
.PP
\fBload()\fP
.RE
.PP
\fBParameters:\fP
.RS 4
\fItype\fP a data type such as 'korganizer/calendar' 
.RE
.PP

.SS "void KNS::DownloadDialog::slotProviders (\fBProvider::List\fP * list)\fC [slot]\fP"
.PP
Availability of the provider list. 
.PP
\fBParameters:\fP
.RS 4
\fIlist\fP list of Hotstuff providers 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for knewstuff Library from the source code.
