开发/教程

    From KDE TechBase
    This page is a translated version of the page Development/Tutorials and the translation is 22% complete.


    这里有一系列当前可用的 KDE 应用和 Plasma 工作开发教程,以及如何使用 KDE 框架开发第三方应用程序。

    使用 KDE 框架开发的基础

    您是否对用 KDE 框架编写应用程序感兴趣?这个系列教程就是为新人而编写的。

    Setting Up
    Before you start writing and building KDE software, you'll need to prepare your tools first.
    世界你好
    介绍非常基础的 KDE 框架编程
    创建主窗口
    本教程将向你展示关于应用程序最重要的部分──主窗口──的魔力。
    使用动作
    如何向菜单和工具栏中添加动作,基于主窗口教程。
    保存与载入
    介绍KIO类库,为应用程序增加加载,存储的功能。
    命令行参数
    在命令行用文字编辑器打开指定文件。
    常见编程错误
    介绍各种在开发Qt和KDE应用程序时常见的错误,以及如何避免它们

    Integrating with Workspaces

    会话管理
    让程序了解X会话
    图标
    使用 KAction 您可以在分发应用程序时,将应用程序的图标自动安装到正确的位置。基于 KAction 教程
    桌面文件
    让您的应用程序显示在 K 菜单和应用程序菜单中。基于图标教程。

    使用KConfig管理配置数据

    KConfig介绍
    概要介绍了KConfig相关的类,以及如何在你的应用程序代码中使用它们
    使用KConfig XT
    关于如何有效使用KConfig XT框架的教程.
    更新KConfig文件
    关于如何编写一个更新脚本,以保证你程序的配置文件格式与用户已使用的现有配置文件一致的教程

    服务:应用程序和插件

    服务框架介绍
    关于KDE中的服务框架,以及它们向开发人员提供了哪些功能的概述。覆盖了对系统配置文件缓存(SyCoCa)、源数据文件以及用索引信息可以做哪些事情的介绍
    KDE 服务框架的概览和提供给应用开发者的内容。涵盖了系统配置缓存 (SyCoCa),源数据文件和索引信息的可能用途。
    使用Trader查询来查找服务
    如何使用Trader查询语法来查找那些在SyCoCa中被索引了的服务,如插件或者mime类型等
    使用 KService 创建和加载插件
    了解如何定义自定义插件类型,找到安装的插件 (包括第三方插件) 和如何用 KService 简便便携地加载它们。

    本地化

    参阅 本地化入口.

    Unicode 介绍
    介绍 Unicode 是什么以及如何在 KDE 应用中处理 Unicode 数据。
    编写支持本地化/国际化的应用程序。
    这个教程涵盖了,什么是本地化,为什么它如此重要,以及如何保证您的应用程序可以本地化。所有应用开发者都应该阅读这个教程。
    避免常见的本地化陷阱
    有些常见的错误会让应用程序难以正确本地化。看看它们是哪些问题,并在实践开发中小心避免它们。
    构建 KDE 的本地化模块
    Building and installing language support from KDE's localization (l10n) module is a good idea for those working on applications in the main KDE repository. Doing so will allow you to test your application in another language and spot problem areas. Learn how to do just that in this tutorial.
    Incorporating i18n Into the Build System
    Once your application is ready to be localized, the next step is to ensure that translation files are built automatically and kept up to date. This tutorial covers the necessary CMakeFiles.txt additions as well the process of distributing the resulting message catalogs with your application.
    Common i18n Challenges and Solutions
    This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules.
    Semantic Markup of Messages
    To ensure consistent presentation and more meaningful representations of messages in applications, semantic markup can be applied to messages marked for translation using the KUIT system. This tutorial describes how this system works.
    Automated i18n Code Checking
    The Krazy code checker scans KDE's code and reports common i18n mistakes.
    Dealing with Language Changes
    This tutorial covers dealing with changing languages: How to add the function to change the language and then dynamically update the user interface when language has been changed.
    Understanding How Messages Appear to Translators
    An introduction to what context information is extracted (and what isn't) from source code for translators to see.

    Application Automation and Scripting

    D-Bus

    D-Bus 介绍
    从一个程序开发员的角度对D-Bus作一个单刀直入的介绍,教程里讲述了D-Bus是什么以及如何人在应用程序中使用。
    访问D-Bus接口
    手把手指导如何用QtDBus调用D-Bus并连接到D-Bus信号。
    中级D-Bus编程
    利用QtBus的一些技巧,可以用来解决现实生活中的一些问题。
    创建D-Bus接口
    如何创建和定制D-Bus的接口来增强你的应用程序。教程包含了产生XML描述,运行时实例化接口,用CMake建立联编系统。
    Using Custom Types with D-Bus
    Learn how to use your own types in classes exported on D-Bus. Covers marshaling and unmarshaling of objects, the integration of custom types into XML descriptions and registering the custom types with the Qt Meta Object system.
    D-Bus自动启动服务
    如何把你的程序改装为一个D-Bus自启动的服务。D-Bus的这个功能也被成为"D-Bus自启动服", 他将确保即便你没有启动你的程序,D-Bus后台程序也会在需要时把它起起来。

    Dolphin

    Creating Dolphin Service Menus
    This tutorial shows you how to create mimetype-specific actions in Dolphine's context menu (aka "servicemenus").

    Kross

    Introduction to Kross
    An introduction to the Kross Scripting Framework.
    Hello World
    A first application with working kross code.
    Calling Functions in Kross
    Simple demonstration of calling scripting functions
    Connecting Signals and Slots in Kross
    Simple demonstration of connecting object signals with script slots
    Scripts as Plugins with Kross
    This tutorial provides a step-by-step introduction how to integrate scripts as plugins into a KDE application.
    Placing script actions in your application menus
    Simple demonstration on how to extend you application menus to execute script files.
    How to use an ActionCollection
    A small Tutorial on How to use Kross::ActionCollections.

    Calligra Plugin Tutorials

    Calligra Overview
    This document shows an overview of the different Calligra plugin types and tells you what each of their purpose and strengths are. If you are new with Calligra plugins, this is the place to start.
    Calligra Plugin Creation
    This gives a technical overview of what it means to write a Calligra plugin.
    Creating Calligra Flake Plugins
    This tutorial shows you how you can build a plugin for Calligra applications to allow you embed content in ODF documents using Flake.
    Calligra Words Scripting
    This tutorial shows how to script Calligra Words with Python, or JavaScript using Kross.
    Calligra Sheets Scripting
    This tutorial shows how to script Calligra Sheets with Python, or JavaScript using Kross.

    System Activity

    Writing script actions for the process's context menu
    This tutorial shows how to add a context menu action to show custom information about a process.

    KWin

    KWin Scripting Tutorial
    This tutorial shows how to write a useful script for KWin.
    QML Window Switcher Layouts
    This tutorial documents the new QML layouts for the KWin Window Switcher

    Plugins and KParts

    Using KParts
    A kPart is a plugin that you can just load into your application. For example, it is easy to integrate an editor (the katePart) or a console (the konsolePart) into your application's window.
    Writing kontact plugins
    Kontact plugins are KParts. This tutorial describes how you can write one.
    Writing Qt Designer Plugins
    Add your widgets to Qt Designer and thus make them usable in UI files.
    KCM HowTo
    KCM are plugins which are loaded by System Settings to display configuration elements. They can also be used within an application.

    Hardware Awareness (Solid)

    Introduction to Solid
    An introduction to the Solid effort in general and it library in particular.
    Listing Devices
    How to use the Solid core library to discover the hardware and interact with the system.
    Accessing Network Information
    How to use the Solid system to get information about the network
    Creating a Device Action
    When your application is interested in registering actions with the system for removable hardware

    Authorization and Privilege escalation (KAuth)

    KAuth Basics
    An overview of concepts and basic knowledge required to understand and use KAuth effectively
    Using KAuth actions in your application
    How to execute KAuth actions in your application, and how to integrate them tightly into your UI
    Creating a KAuth helper to perform a privileged action
    You will learn how to use KAuth's helpers and escalation facilities, and how to seamlessly make a privileged and non privileged portion of your application interact
    Creating a KCM requiring authorization upon saving
    Learn how to use the high level KCModule API to create KCModules handling authorization, and its UI integration, on their own

    Multimedia (Phonon)

    Phonon
    Introduction to Phonon tells how to compile and run the code. If you like to work in Python, try this version of the same tutorial
    Writing Backends
    How to start creating a new backend for the multimedia API
    Resources
    Please have a look at the online documentation for information on the Phonon API. If you prefer using Qt Assistant or Qt Creator you can also use our offline documentation.

    Plasma 5

    See Plasma tutorials.

    Personal Information Management (Akonadi)

    Using Akonadi in Applications
    Displaying and modifying data provided by Akonadi
    Developing Akonadi Resources
    Akonadi Resources are agent programs which transport PIM data between Akonadi and a backend (files, servers, etc)
    Using custom data types with Akonadi
    Akonadi can handle arbitrary data as item payloads through the use of a plugin based serialization framework

    Kate / KWrite

    Getting started with KTextEditor plugins
    Creating your first KTextEditor plugin
    Developing a plugin with configuration dialog
    Adding a configuration dialog to the Time & Date example
    A small Editor
    Create a small application using KTextEditor

    KDevelop

    Creating a class template
    Instructions for creating a class template, which can be used to quickly generate classes from KDevelop.
    Creating a project template
    Instructions for creating a project template, which can be used for starting new project with KDevelop.
    KDevelop-PG-Qt Introduction
    Information on the KDevelop parser generator, useful for language plugins.

    Printing

    KDE mostly uses the Qt Printing infrastructure.

    Hello World
    Introduction to the KDE printing system

    kioslaves

    Collaboration

    Open Collaboration Services (libattica)

    Introduction to Attica
    In this tutorial a simple widget showing information about a Person on the server is created.

    Get Hot New Stuff

    Get Hot New Stuff 3 - Download
    How to use KHotNewStuff3 in your application.
    Get Hot New Stuff 3 - Checking for Updates
    How to check whether updates for installed stuff are available without showing the dialog/widget.
    Get Hot New Stuff 3 - Upload
    How to add an upload dialog to your application.

    Other programming languages

    Python (PyQt4)

    Note
    The tutorials below apply to an older version of Qt only. While there are stable Python bindings available for Qt 5, bindings for KDE Frameworks 5 are still under development.
    An Introduction to PyQt
    Starting off with an introduction to PyQt4
    Using PyKDE4
    Introduction to PyKDE4
    PyKDE WebKit Tutorial
    A simple web browser application in PyKDE
    101 Introduction to signals and slots
    A simple introduction to Qt's signal and slot architecture.
    PyKDE DBus Tutorial
    An introduction to DBus communication using PyKDE
    PyKDE KNotify Tutorial
    An introduction to Knotify (Notifications and KJobs) using PyKDE

    Ruby

    Note
    The tutorials below apply to an older version of Qt only. There are currently no Ruby bindings for Qt 5 and KDE Frameworks 5 available.
    KDE Ruby Korundum tutorial
    A ruby version of Antonio Larrosa Jiménez's KDE tutorial by Richard Dale. See the Ruby Developers Corner for Qt tutorials and other info.
    Qt4 Ruby Tutorial
    Nokia's fabulous introductory tutorial to Qt, translated to Ruby.
    Creating a Plasma Widget in Ruby
    Tutorial that shows how to create your first Plasma Applet using the Ruby language.
    Developing Qt4 Applications using Qt Designer and Ruby on Kubuntu
    Tutorial that shows how to design a simple User Interface in Qt Designer and then use the resulting widget in a Qt Ruby application we build from scratch.
    Ruby-Qt/KDE Book
    There is also an approach to create an Ruby-Qt/KDE Book under a free license. The content will be created in this wiki.

    Shell

    Shell Scripting with KDE dialogs (Original Link)
    Tutorial by Brad Hards that describes how to use KDE dialogs in shell scripts with kdialog. It is presented as an example based tutorial.

    Graphics Programming

    QPainter Perfomance
    Hints on avoiding common mistakes leading to poor performance when using QPainter
    HiDPI Support
    How to render sharp GUI for HiDPI display
    Migrate Qt Quick Controls 1
    Qt Quick Controls 1 is not supported so please follow the guide to upgrade to Qt Quick Controls 2

    Using the KDE Games Libraries

    KStandardGameAction
    Using libkdegames to make your game fit the kdegames standard
    Highscores
    Implementing a simple highscore table into your game
    Theme Selector
    Using the libkdegames theme selection dialog
    Palapeli Slicers
    Creating a slicer plugin for Palapeli

    Other tutorials

    2D Plotting (KPlotWidget)

    Using the KDE data-plotting widget
    This tutorial introduces KPlotWidget, which is used for 2-D data plotting. It includes information on simple usage of the widget (including adding and modifying data sets, and customizing the plot axes and labels), and advanced customization (including extending the widget through sub-classing).
    物理模拟
    如何进行物理模拟:动画和图表

    Spelling and Grammar Checking (Sonnet)

    Adding spell-checking or grammar-checking to KDE applications
    This tutorial introduces Sonnet and how one may use it to add language correction to your KDE application. Sonnet's auxiliary features shall be described in a separate tutorial.

    Using the KDE Wallet API for safe storage

    KWallet
    "Brief introduction to the KWallet API which can be used for storing all kinds of sensitive information."

    Deprecated Material

    Warning
    Tutorials in this section are outdated and are no longer relevant to the current state of KDE software. They are being retained here for historical purposes only. Please do not use them.


    Accessibility

    Accessibility Overview
    A list of accessibility tutorials and general information.
    Accessibility Checklist
    What to look for in your application to make it accessible for as many people as possible.
    Screen Reader
    This tutorial will explain some details about using screen readers with KDE applications.
    Text-To-Speech
    How to utilize Jovie text-to-speech service in your application.

    D-Bus

    从DCOP移植到D-Bus
    从DCOP向D-BUS 移植指导手册。

    Personal Information Management (Akonadi)

    Porting Applications which use KResource API
    Applications using KDE's now deprecated KResource APIs, e.g. KABC or KCal, need to be ported to use their Akonadi equivalents

    Get Hot New Stuff

    Old links for KNS2 and KNS1 content:

    Introduction to Get Hot New Stuff 2
    A short tutorial about how to use KHotNewStuff2 in your application. Deprecated, use version 3
    Introduction to Get Hot New Stuff
    An introduction to the developer-friendly network update system that allows KDE applications to fetch new application data at runtime in a user friendly manner.
    KNewStuff Secure (Original Link)
    Tutorial showing how to share resources in a secured way (KDE 3.4 and later). By András Mantia <[email protected]>.

    Goya

    Introduction to Goya usage
    An introduction for the Goya subsystem usage, which allows you to easily add widgets to your itemviews and connect their signals to your code, as they were real widgets.
    Introduction to Goya usage (part 2)
    The second part of the tutorial, with a slightly more complex example than the first part.

    Using the KDE PIM Libraries

    iCalendar functionality
    Using kcal to manage iCalendar files

    Pixmap cache (KPixmapCache)

    Using the KDE pixmap cache
    This tutorial shows how to use KPixmapCache to cache e.g. pixmaps generated from SVGs or some data.

    Porting an application from KSystemTrayIcon to KStatusNotifierItem

    Porting from KSystemTrayIcon to KStatusNotifierItem
    This tutorials shows how to port an application using KSystemTrayIcon to KStatusNotifierItem

    How to edit a wiki with Libmediawiki

    Libmediawiki
    This tutorial present how to edit a wiki with Libmediawiki.

    KDE2 and KDE3 Materials

    KDE3 Tutorials
    These tutorials cover topics related to KDE3.
    KDE2 Tutorials
    These tutorials cover topics related to KDE2.