Development/Tutorials/Plasma4/GettingStarted (ru)

Development/Tutorials/Plasma/GettingStarted

Creating your first Plasmoid

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

Предисловие

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

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=plasma_applet_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 <syntaxhighlight lang="cpp-qt"> // Здесь мы избегаем загрузки заголовков несколько раз

ifndef Tutorial1_HEADER
define Tutorial1_HEADER

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

include <KIcon>

include <Plasma/Applet>
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)

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 <syntaxhighlight lang="cpp-qt">

include "plasma-tutorial1.h"
include <QPainter>
include <QFontMetrics>
include <QSizeF>

include <plasma/svg.h>
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();

}

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)

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

Функция dataUpdated

Если вы хотите обрабатывать какие-либо данные от plasma's data-engines, вам следует реализовать функцию dataUpdated в вашем мини-приложении. Последняя вызывается, если data-engine посылает вам данные, т.е. ваше мини-приложение должно заново рассчитать свое содержимое.

Определение формы и размера апплета: функции geometry() и contentsRect()

Если вы хотите узнать в коде апплета, какого размера апплет и какую он имеет форму, вызовите contentsRect() и contentsRect().size(). Избегайте вызовов функций geometry() и size(), потому что они не берут в расчет размер поля фона по умолчанию устанавливаемый апплетам. Также избегайте использование абсолютных значений для позиционирования содержимого апплета, например таких как QPoint(0, 0) для показа верхней левой точки вашего апплета, вместо этого используйте contentsRect().topLeft().

Построение, файл CMakeLists.txt

Наконец, для связывания всего вместе, вам нужно все это собрать. Для указания cmake что нужно делать, укажем ему на CMakeLists.txt файл.

За деталями работы CMake, пожалуйста, обращайтесь к документации Development/Tutorials/CMake

Проекту конечно же нужно имя

project(plasma-tutorial1)

Поиск требуемых библиотек

find_package(KDE4 REQUIRED)
include(KDE4Defaults)
add_definitions (${QT_DEFINITIONS} ${KDE4_DEFINITIONS})
include_directories(

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

Тут мы добавляем наш исходный код

set(tutorial1_SRCS plasma-tutorial1.cpp)

Убедитесь, что все пути к файлам верны

kde4_add_plugin(plasma_applet_tutorial1 ${tutorial1_SRCS})
target_link_libraries(plasma_applet_tutorial1

                     ${KDE4_PLASMA_LIBS} ${KDE4_KDEUI_LIBS})

install(TARGETS plasma_applet_tutorial1

       DESTINATION ${PLUGIN_INSTALL_DIR})

install(FILES plasma-applet-tutorial1.desktop

       DESTINATION ${SERVICES_INSTALL_DIR})

Тестирование апплета

Если ваша текущая среда разработыки отличается от тестовой установки, вы должны запускать cmake с параметром -DCMAKE_INSTALL_PREFIX=/usr/lib/kde4/ (замените вашей переменной $KDEDIR). Затем запустите make. Если результат успешен, апплет может быть установлен запуском команды sudo make install или

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

и запуском kbuildsycoca4 (так приложения KDE узнают о новых файлах *.desctop) Для тестового запуска вашего апплета вы можете использовать программу plasmoidviewer набрав: plasmoidviewer applet_name

Где applet_name значение, указанное в .desktop для ключа X-KDE-PluginInfo-Name.

Или вы можете перезапустить плазму, так что апплет будет отображен в окне выбора апплетов: kbuildsycoca4 kquitapp plasma plasma

Если так не работает, вам следует перезапустить вашу KDE сессию путем выхода из системы и входа снова.