Development/Tutorials/Plasma4/GettingStarted (ru)

Development/Tutorials/Plasma/GettingStarted

Languages: عربي | Asturianu | Català | Česky | Kaszëbsczi | Dansk | Deutsch | English | Esperanto | Español | Eesti | فارسی | Suomi | Français | Galego | Italiano | 日本語 | 한국어 | Norwegian | Polski | Português Brasileiro | Română | Русский | Svenska | Slovenčina | Slovenščina | српски | Türkçe | Tiếng Việt | Українська | 简体中文 | 繁體中文

Creating your first Plasmoid

Tutorial Series	Plasma Tutorial
Previous	C++, Qt, KDE4 development environment
What's Next
Further Reading	CMake

Предисловие

Данное руководство требует для удачной сборки kde 4.1. В данном руководстве мы создадим простое мини-приложение. Чтобы сохранить простоту мы создадим статическое мини-приложение с использованием следующих компонентов:

• SVG рисунок
• Иконка
• Какой-либо простой текст

Код мини-приложения

.desktop файл

Каждое мини-приложение должно иметь в своём составе .desktop файл для указания плазме как и под каким именем его запускать.

plasma-applet-tutorial1.desktop [Desktop Entry] Name=Tutorial 1 Comment=Plasma Tutorial 1 Type=Service

X-KDE-ServiceTypes=Plasma/Applet X-KDE-Library=plasma_applet_tutorial1 X-KDE-PluginInfo-Author=Bas Grolleman [email protected] X-KDE-PluginInfo-Name=tutorial1 X-KDE-PluginInfo-Version=0.1 X-KDE-PluginInfo-Website=http://plasma.kde.org/ X-KDE-PluginInfo-Category=Examples X-KDE-PluginInfo-Depends= X-KDE-PluginInfo-License=GPL X-KDE-PluginInfo-EnabledByDefault=true

Наиболее важными являются пункты X-KDE-Library и X-KDE-PluginInfo-Name, они являются "клеем" между вашим классом и плазмой, без них ничего не заработает. Для X-KDE-PluginInfo-Category, см. PIG.

Файл заголовка

Это пример файла заголовка. Комментарии в код добавлены для ясности.

plasma-tutorial1.h // Здесь мы избегаем загрузки заголовков несколько раз

1. ifndef Tutorial1_HEADER
2. define Tutorial1_HEADER

// Нам необходимо загрузить заголовок Applet плазмы

1. include <KIcon>

1. include <Plasma/Applet>
2. include <Plasma/Svg>

class QSizeF;

// Определяем наш Applet плазмы class PlasmaTutorial1 : public Plasma::Applet {

   Q_OBJECT
   public:
       // Базовые конструктор и деструктор
       PlasmaTutorial1(QObject *parent, const QVariantList &args);
       ~PlasmaTutorial1();

       // paintInterface - процедура рисующая Applet на экране
       void paintInterface(QPainter *painter,
               const QStyleOptionGraphicsItem *option,
               const QRect& contentsRect);

void init();

   private:
       Plasma::Svg m_svg;
       KIcon m_icon;

};

// Данная команда связывает ваш Applet с .desktop файлом K_EXPORT_PLASMA_APPLET(tutorial1, PlasmaTutorial1)

1. endif

Метод QRectF boundingRect()

Функция boundingRect() сообщает плазме актуальные размеры мини-приложения. Это важно, так как мы должны знать сколько местя занимаем на экране.

Tip

Если у вас есть проблемы с неправильной отрисовкой вашего мини-приложения, то обычно это результат неправильной работы функции boundingRect().

Метод void paintInterface(QRectF contentsRect)

Эта функция считается главной, так как рисует мини-приложение на экране. Здесь вы можете определить, как ваше приложение будет выглядеть. Вы должны рисовать в пределах, определённых через contentsRect и избегать выхода за них с помощью функции geometry(). Когда мини-приложение не имеет собственного стандартного фона, например он был отключён в функции setBackgroundHints() или он является панелью, geometry() и boundingRect() ведут себя так же, однако, когда стандартный фон включены (обычный случай), аплет будет иметь места, где лучше не рисовать.

Макрос K_EXPORT_PLASMA_APPLET ( <name>, <class> )

Это маленькая, но очень важная часть связывающая имя вашего класса с именем апплета, определённом в .desktop файле.

Если ваш апплет не загружается. то одной из причин может быть именно несоответствие в этом месте.

Tip

Макрос K_EXPORT_PLASMA_APPLET добавляет "plasma_applet_", пожалуйста, учитывайте это, когда настраиваете ваш .desktop файл, чтобы избежать различий в именах.

Главный рабочий файл

Здесь описано содержимое фнукций с коментариями.

plasma-tutorial1.cpp

1. include "plasma-tutorial1.h"
2. include <QPainter>
3. include <QFontMetrics>
4. include <QSizeF>

1. include <plasma/svg.h>
2. include <plasma/theme.h>

PlasmaTutorial1::PlasmaTutorial1(QObject *parent, const QVariantList &args)

   : Plasma::Applet(parent, args),
   m_svg(this),
   m_icon("document")

{

   m_svg.setImagePath("widgets/background");
   // получаем устанавливаем стандартный фон апплета, бесплатно!
   setBackgroundHints(DefaultBackground);
   resize(200, 200);

}

PlasmaTutorial1::~PlasmaTutorial1() {

   if (hasFailedToLaunch()) {
       // Действия по очистке
   } else {
       // Сохраняйте настройки
   }

}

void PlasmaTutorial1::init() {

   // Небольшая демонстрация вызова функции setFailedToLaunch
   if (m_icon.isNull()) {
       setFailedToLaunch(true, "Нет мира, которому можно сказать привет :(");
   }

}

void PlasmaTutorial1::paintInterface(QPainter *p,

       const QStyleOptionGraphicsItem *option, const QRect &contentsRect)

{

   p->setRenderHint(QPainter::SmoothPixmapTransform);
   p->setRenderHint(QPainter::Antialiasing);

   // Сейчас мы отрисуем наш апплет, начнём с нашего svg
   m_svg.resize((int)contentsRect.width(), (int)contentsRect.height());
   m_svg.paint(p, (int)contentsRect.left(), (int)contentsRect.top());

   // Поместим иконку и текст на апплет.
   p->drawPixmap(7, 0, m_icon.pixmap((int)contentsRect.width(),(int)contentsRect.width()-14));
   p->save();
   p->setPen(Qt::white);
   p->drawText(contentsRect,
               Qt::AlignBottom | Qt::AlignHCenter,
               "Привет, Plasmoid!");
   p->restore();

}

1. include "plasma-tutorial1.moc"

Класс Plasma/Svg

Как вы могли увидеть из кода, мы использовали Plasma::Svg объект, достаточно важный, чтобы отметить его здесь.

Сперва мы выставляем относительный путь к файлу widgets/background для Plasma::Svg который используется в Plasma::Theme для нахождения SVG данных. Пока Plasma::Svg не поддерживает загрузку произвольных файлов с полными путями, используйте относительные пути из темы как можно чаще. так как это позволяет отдельным плазмоидам выглядеть одинаково, используя опреелённый в данный момент стиль Plasma. Список доступных картинок можно найти на Plasma Theme page.

В любом режиме, Plasma::Svg может использоваться для разбора состовляющего SVG файлов, извлекая из них элементы по идентификаторам, которые содержатся в документе SVG. Хороший пример: если вы откроете файл clock.svg то он будет открыт с темой по умолчанию, вы должны будете увидеть фон, 3 стрелки и задний фон (прозрачность). Из-за возможности поместить все элементы в один файл SVG, файл покажет часы. Это намного удобнее, чем редактировать 5 различных файлов когда они должны находится друг над другом, а также это улучшает производительность при разборе SVG файла и чтения его с диска.

Метод setBackgroundHints(DefaultBackground)

Поскольку рисование фона является общей функцией есть быстрый и простой способ отрисовать его. При добавлении setBackgroundHints(DefaultBackground) в ваш код, стандартный фон Plasma будет рисоваться позади вашего мини-приложения. Это не только экономит Ваше время и количество кода, но и создает более последовательное представление для пользователя.

Метод init()

В конструкторе вы говорите плазме только о фоне приложения и конфигурационном файле, если етакие имеются. Вы также можете выставлять размеры мини-приложения в конструкторе. После этого плазма позаботится об изменении размеров и вы можете не беспокоиться по этому поводу. В методе init() вы можете инициализировать всё что пожелаете, например считывание информации из конфигурационного файла.

Метод hasFailedToLaunch()

Если в некоторых случаях мини-приложение не может быть запущено (например не загружены некоторые библиотеки, отсутствуют драйвера для некоторого оборудования и т.д.) этот метод вернёт значение true. Использование этого метода даст вашему приложению способноть выполнить некоторую очистку перед завершением.

setFailedToLaunch(bool, QString)

When your application is unable to start, this function allows you to inform Plasma and give an optional reason why. Plasma will then draw a standardized error interface to inform the user of the situation and your applet will not be called upon to do any drawing on its own from that point forward. If your plasmoid becomes more complex and depends on multiple factors this is the nicest way to cleanup.

dataUpdated

If you would connect to any of plasma's data-engines you would have to implement a function called dataUpdated in your plasmoid. The latter is called if the data-engine sends you data, i.e. your plasmoid should recalculate its contents.

Determine the applet size and geometry: geometry() and contentsRect()

If you need to know, in your applet code, what the applet size and geometry is, call contentsRect() and contentsRect().size(). Avoid calling geometry() and size() because they don't take into account the margin's size set by the applets default background. Also avoid using absolute numbers to position items in the applet like QPoint(0, 0) to indicate the top-left point of your applet, instead use contentsRect().topLeft().

Building it all, the CMakeLists.txt

Finally, to put everything together you need to build everything. To tell cmake what needs to go where there is the CMakeLists.txt file.

For more details on CMake please read Development/Tutorials/CMake

1. Project Needs a name ofcourse

project(plasma-tutorial1)

1. Find the required Libaries

find_package(KDE4 REQUIRED) include(KDE4Defaults) find_package(Plasma REQUIRED)

add_definitions (${QT_DEFINITIONS} ${KDE4_DEFINITIONS}) include_directories(

  ${CMAKE_SOURCE_DIR}
  ${CMAKE_BINARY_DIR}
  ${KDE4_INCLUDES}
  )

1. We add our source code here

set(tutorial1_SRCS plasma-tutorial1.cpp)

1. Now make sure all files get to the right place

kde4_add_plugin(plasma_applet_tutorial1 ${tutorial1_SRCS}) target_link_libraries(plasma_applet_tutorial1

                     ${PLASMA_LIBS} ${KDE4_KDEUI_LIBS})

install(TARGETS plasma_applet_tutorial1

       DESTINATION ${PLUGIN_INSTALL_DIR})

install(FILES plasma-applet-tutorial1.desktop

       DESTINATION ${SERVICES_INSTALL_DIR})

Testing the Applet

If your current Development Environment differs from the Test Installation, you have to run cmake with -DCMAKE_INSTALL_PREFIX=/usr/lib/kde4/ (replace with your $KDEDIR). Then run make. If succesfull the applet can be installed by running sudo make install or

• cp ./lib/plasma_applet_tutorial1.so $KDEDIR/lib
• cp ./plasma-applet-tutorial1.desktop $KDEDIR/share/kde4/services/

and run kbuildsycoca4 (so that KDE apps will know about the new desktop files). In order to test your Applet you can use the plasmoidviewer program: plasmoidviewer applet_name

Where applet_name is the value specified into .desktop for the X-KDE-PluginInfo-Name key.

Otherwise you can restart plasma, so the Applet will be displayed in the Applet Browser: kbuildsycoca4 kquitapp plasma plasma

If that doesn't work you will have to restart your KDE session by logging out and back in.