Difference between revisions of "Development/Tutorials/Collaboration/HotNewStuff/Introduction"

Jump to: navigation, search
m (Text replace - "<code cppqt="cppqt">" to "<syntaxhighlight lang="cpp-qt">")
(Linking in CMakeLists.txt)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Development/Tutorials/Collaboration/HotNewStuff/Introduction}}
+
 
  
 
{{TutorialBrowser|
 
{{TutorialBrowser|
Line 17: Line 17:
 
The example consists of just one c++ source file. <syntaxhighlight lang="cpp-qt">
 
The example consists of just one c++ source file. <syntaxhighlight lang="cpp-qt">
 
//khotnewstuff.cpp
 
//khotnewstuff.cpp
 
#include <kapplication.h>
 
#include <kdebug.h>
 
#include <klocale.h>
 
#include <kcmdlineargs.h>
 
#include <kaboutdata.h>
 
 
#include <knewstuff3/downloaddialog.h>
 
  
 
int main(int argc, char **argv)
 
int main(int argc, char **argv)
 
{
 
{
     KAboutData about("khotnewstuff_example", 0, ki18n("KHotNewStuff"), "0.4");
+
     QCoreApplication::setApplicationName(QStringLiteral("khotnewstuff"));
     about.setProgramIconName("get-hot-new-stuff");
+
    QCoreApplication::setApplicationVersion(QStringLiteral("0.4"));
      
+
     QCoreApplication::setOrganizationDomain(QStringLiteral("kde.org"));
     KApplication i;
+
     QApplication::setApplicationDisplayName(i18n("KHotNewStuff"));
 +
 
 +
     QApplication i(argc, argv);
  
     KNS3::DownloadDialog dialog(args->arg(0));
+
     if (i.arguments().count() > 1) {
    dialog.exec();
+
        QString configfile = QLatin1String(argv[1]);
    foreach (const KNS3::Entry& e, dialog.changedEntries()) {
+
        QPointer<KNS3::DownloadDialog> dialog = new KNS3::DownloadDialog(configfile);
        kDebug() << "Changed Entry: " << e.name();
+
        dialog->exec();
 +
        foreach (const KNS3::Entry& e, dialog->changedEntries()) {
 +
            qCDebug(KNEWSTUFF) << "Changed Entry: " << e.name();
 +
        }
 +
        delete dialog;
 +
    } else {
 +
        return -1;
 
     }
 
     }
 
 
     return 0;
 
     return 0;
 
}
 
}
</syntaxhighlight>  
+
</syntaxhighlight>
 
+
  
 
==== The Configuration File (.knsrc)  ====
 
==== The Configuration File (.knsrc)  ====
Line 52: Line 50:
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
[KNewStuff3]
 
[KNewStuff3]
 +
Name=Wallpapers
 
Categories=KDE Wallpaper 1920x1200,KDE Wallpaper 1600x1200
 
Categories=KDE Wallpaper 1920x1200,KDE Wallpaper 1600x1200
 
TargetDir=wallpapers
 
TargetDir=wallpapers
Line 67: Line 66:
 
* StandardResource: standard ressouce dir, such as .kde/share/wallpapers. This is what KStandardDirs::locateLocal(name) will return.
 
* StandardResource: standard ressouce dir, such as .kde/share/wallpapers. This is what KStandardDirs::locateLocal(name) will return.
 
* TargetDir: a directory in the share/apps section, such as .kde/share/apps/wallpapers. This is what KStandardDirs::locateLocal("data", name) will return.
 
* TargetDir: a directory in the share/apps section, such as .kde/share/apps/wallpapers. This is what KStandardDirs::locateLocal("data", name) will return.
* XdgTargetDir: a directory in the $XDG_DATA_HOME directory such as .local/share/wallpapers (since KDE 4.5)
+
* XdgTargetDir: a directory in the $XDG_DATA_HOME directory such as .local/share/wallpapers
  
  
 
'''Downloaded HTML''':
 
'''Downloaded HTML''':
  
A new option has been added for KDE 4.5.
 
 
By default KNewStuff will ask if the user wants to open ''downloaded HTML'' files with a browser instead of trying to install them. This is so since most of the time HTML means a broken link or a link to a page from which the item can be downloaded. If you want to accept html (because your app actually uses KNewStuff to get html files, you should explicitly allow this:
 
By default KNewStuff will ask if the user wants to open ''downloaded HTML'' files with a browser instead of trying to install them. This is so since most of the time HTML means a broken link or a link to a page from which the item can be downloaded. If you want to accept html (because your app actually uses KNewStuff to get html files, you should explicitly allow this:
 
<syntaxhighlight lang="text">AcceptHtmlDownloads=true</syntaxhighlight>
 
<syntaxhighlight lang="text">AcceptHtmlDownloads=true</syntaxhighlight>
  
 
'''ProvidersUrl'''
 
'''ProvidersUrl'''
The data has to come from somewhere, right? Up until KDE SC 4.5 you '''must''' specify ProvidersUrl with an url to the providers.xml file.
+
The ProvidersUrl is optional, and if you just want to use what KDE provides as default (http://download.kde.org/ocs/providers.xml, currently store.kde.org), leave this out. The advantage of not specifying this field is that users can add more providers using the attica kcm (kcmshell5 kcm_attica).
Starting with KDE 4.5 this is optional, and if you just want to use what KDE provides as default (http://download.kde.org/ocs/providers.xml, currently openDesktop.org), leave this out. The advantage of not specifying this field is that users can add more providers using the attica kcm (kcmshell4 kcm_attica).
+
 
Only if you have to (because you need a different provider) use:
 
Only if you have to (because you need a different provider) use:
 
<syntaxhighlight lang="text">ProvidersUrl=http://download.kde.org/ocs/providers.xml</syntaxhighlight>
 
<syntaxhighlight lang="text">ProvidersUrl=http://download.kde.org/ocs/providers.xml</syntaxhighlight>
Line 84: Line 81:
 
==== Linking in CMakeLists.txt  ====
 
==== Linking in CMakeLists.txt  ====
  
To link against KNS3, just link against ''${KDE4_KNEWSTUFF3_LIBS}''. Example:  
+
To link against KNS3, just link against ''KF5::NewStuff''. Example:  
  
<syntaxhighlight lang="text">
+
<syntaxhighlight lang="cmake">
target_link_libraries(ktexteditor_codesnippets_core
+
target_link_libraries(ktexteditor_codesnippets_core Qt5::Widgets KF5::TextEditor KF5::NewStuff)
${KDE4_KDEUI_LIBS} ${KDE4_KTEXTEDITOR_LIBS} ${KDE4_KNEWSTUFF3_LIBS})
+
</syntaxhighlight>
</syntaxhighlight>  
+
  
 
==== Using a Widget instead of the Dialog  ====
 
==== Using a Widget instead of the Dialog  ====
  
 
If you don't like to use an external dialog, you can also use a widget instead. Just replace '''DownloadDialog''' with '''DownloadWidget''' and you're good to go. This is especially nice as additional page in existing config dialogs.<br>
 
If you don't like to use an external dialog, you can also use a widget instead. Just replace '''DownloadDialog''' with '''DownloadWidget''' and you're good to go. This is especially nice as additional page in existing config dialogs.<br>

Latest revision as of 13:08, 23 December 2016


Get Hot New Stuff 3 Introduction
Tutorial Series   HotNewStuff
Previous   Getting started with KDE development
What's Next   Get Hot New Stuff 3 - Updates
Further Reading   API Documentation

Overview

Here is a small example of an application that asks openDesktop.org for wallpapers. It lets the user install them into the system wallpaper directory.

The Code

The example consists of just one c++ source file.
//khotnewstuff.cpp

int main(int argc, char **argv)
{
    QCoreApplication::setApplicationName(QStringLiteral("khotnewstuff"));
    QCoreApplication::setApplicationVersion(QStringLiteral("0.4"));
    QCoreApplication::setOrganizationDomain(QStringLiteral("kde.org"));
    QApplication::setApplicationDisplayName(i18n("KHotNewStuff"));

    QApplication i(argc, argv);

    if (i.arguments().count() > 1) {
        QString configfile = QLatin1String(argv[1]);
        QPointer<KNS3::DownloadDialog> dialog = new KNS3::DownloadDialog(configfile);
        dialog->exec();
        foreach (const KNS3::Entry& e, dialog->changedEntries()) {
            qCDebug(KNEWSTUFF) << "Changed Entry: " << e.name();
        }
        delete dialog;
    } else {
        return -1;
    }
    return 0;
}

The Configuration File (.knsrc)

For this to work, a file that sets up KNewStuff khotnewstuff_example.knsrc is needed. If you don't pass a file name to the dialog, the name of the file is taken from the about data (application name). If you want to use different dialogs in one application, just create multiple .knsrc files, such as krita_brushes.knsrc and krita_palettes.knsrc for example.

The file has to be in kde/share/config/khotnewstuff_example.knsrc.

[KNewStuff3]
Name=Wallpapers
Categories=KDE Wallpaper 1920x1200,KDE Wallpaper 1600x1200
TargetDir=wallpapers
Uncompress=archive

Uncompress can be one of:

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


You have different options to set the target install directory:

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


Downloaded HTML:

By default KNewStuff will ask if the user wants to open downloaded HTML files with a browser instead of trying to install them. This is so since most of the time HTML means a broken link or a link to a page from which the item can be downloaded. If you want to accept html (because your app actually uses KNewStuff to get html files, you should explicitly allow this:

AcceptHtmlDownloads=true

ProvidersUrl The ProvidersUrl is optional, and if you just want to use what KDE provides as default (http://download.kde.org/ocs/providers.xml, currently store.kde.org), leave this out. The advantage of not specifying this field is that users can add more providers using the attica kcm (kcmshell5 kcm_attica). Only if you have to (because you need a different provider) use:

ProvidersUrl=http://download.kde.org/ocs/providers.xml

Linking in CMakeLists.txt

To link against KNS3, just link against KF5::NewStuff. Example:

target_link_libraries(ktexteditor_codesnippets_core Qt5::Widgets KF5::TextEditor KF5::NewStuff)

Using a Widget instead of the Dialog

If you don't like to use an external dialog, you can also use a widget instead. Just replace DownloadDialog with DownloadWidget and you're good to go. This is especially nice as additional page in existing config dialogs.


This page was last modified on 23 December 2016, at 13:08. Content is available under Creative Commons License SA 4.0 unless otherwise noted.