Libauroraapp

Пространство имён Aurora::Application позволяет создавать приложения ОС Аврора. Подробнее...

Подключение: #include <auroraapp.h>

Функции

QGuiApplication *	application(int &argc, char **argv)
QDir	cacheDir(bool shared)
QQuickView *	createView()
QDir	filesDir(bool shared)
QString	getPath(Aurora::Application:PathType type)
int	main(int &argc, char **argv)
QDir	organizationCacheDir(bool shared)
QDir	organizationFilesDir(bool shared)
QUrl	organizationPathTo(const QString &filename)
QUrl	pathTo(const QString &filename)
QUrl	pathToMainQml()

Подробное описание

При разработке приложений под ОС Аврора следует использовать библиотеку libauroraapp, которая предоставляет API для инициализации приложения и получения корректных путей к файлам и директориям приложения во время его работы.

Пространство имён:

namespace Aurora::Application

Для подключения libauroraapp в проекте необходимо выполнить следующие шаги:

Добавить BuildRequires: pkgconfig(auroraapp) в файл .spec.
Установить TARGET = <orgname>.<appname> в файле .pro. Например org.example.appname.
Добавить PKGCONFIG += auroraapp в файл .pro.
Включить auroraapp.h в файл .cpp:

#include <auroraapp.h>

Пример использования:

#include <QtQuick>
#include <auroraapp.h>

using namespace Aurora;

int main(int argc, char *argv[])
{
    QScopedPointer<QGuiApplication> app(Application::application(argc, argv));
    QScopedPointer<QQuickView> view(Application::createView());

    view->setSource(Application::pathTo(QString("qml/main.qml")));
    view->show();

    return app->exec();
}

Описание функций

QGuiApplication *application(int &argc, char **argv)

Создаёт новый экземпляр QGuiApplication, который сконфигурирован для использования в ОС Аврора.

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

Возвращённый экземпляр QGuiApplication принадлежит приложению, поэтому его следует удалить, когда он больше не требуется.

Параметры argc и argv — это параметры командной строки, которые нужно передать для интерпретации. Параметр argv — это массив указателей на нуль-терминированные строки, которые нужно интерпретировать, а argc — это длина этого массива (количество параметров для интерпретации).

Возвращает новый экземпляр QGuiApplication для использования в приложении.

QDir cacheDir(bool shared)

Возвращает каталог, предназначенный для хранения кэша приложения.

Параметр shared указывает, нужно ли возвращать каталог, разделяемый между пользователями системы, или нет.

QQuickView *createView()

Создаёт новый экземпляр QQuickView, который приложение может использовать для отображения пользовательского интерфейса. QQuickView можно использовать, например, для установки корневой страницы QML, которая будет отображаться приложением.

Возвращённый экземпляр QQuickView принадлежит приложению, поэтому его следует удалить, когда он больше не требуется.

Возвращает новый экземпляр QQuickView для использования в пользовательском интерфейсе.

QDir filesDir(bool shared)

Возвращает каталог, предназначенный для хранения данных приложения.

Параметр shared указывает, нужно ли возвращать каталог, разделяемый между пользователями системы, или нет.

QString getPath(Aurora::Application::PathType type);

Используется для получения пути к определенному ресурсу или файлу на устройстве. Функция на основе константы возвращает QString, содержащий абсолютный путь. PathType type — это константа из пространства имён Aurora::Application, указывающая на путь к стандартному каталогу. Функция может быть полезна, например, для загрузки файлов, доступа к конфигурационным файлам, получения пути к базе данных, изображениям и другим ресурсам, необходимым для работы приложения. По полученному пути можно загрузить или использовать файл внутри кода приложения.

Пример использования:

#include <auroraapp.h>

QString localFilesPath = Aurora::Application::getPath(Aurora::Application::AppLocalDataLocation);

int main(int &argc, char **argv)

Готовая функция для запуска простых QML-приложений.

Если приложение в основном использует QML с ограниченной потребностью во взаимодействии с C++, то можно использовать эту функцию, чтобы приложение запускалось наиболее быстро и безболезненно. Следует убедиться, что имеется файл QML с именем qml/$$TARGET.qml внутри каталога установки данных приложения (обычно это файл /usr/share/$$TARGET/qml/$$TARGET.qml ).

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

Возвращает результат выполнения приложения. Ноль для нормального выхода, ненулевые значения для всего остального.

QDir organizationCacheDir(bool shared)

Возвращает каталог, предназначенный для хранения кэша организации.

Параметр shared указывает, нужно ли возвращать каталог, разделяемый между пользователями системы, или нет.

QDir organizationFilesDir(bool shared)

Возвращает каталог, предназначенный для хранения данных организации.

Параметр shared указывает, нужно ли возвращать каталог, разделяемый между пользователями системы, или нет.

QUrl organizationPathTo(const QString &filename)

Функция преобразует относительный путь до файла организации в полный путь, специфичный для приложения.

Используется для получения полного пути к файлу, содержащемуся в каталоге данных организации. Параметр filename должен указывать на файл относительно каталога данных организации. Возвращённый URL-адрес будет полным путём, указывающим на файл.

Каталог данных обычно находится в /usr/share/common/<orgname>, поэтому для организации с названием org.example и исходного имени файла "res/component.qml" файл с результатом будет можно найти по адресу /usr/share/common/org.example/res/component.qml.

Параметр filename содержит путь относительно каталога данных организации.

Возвращает полный путь, указывающий на файл.

QUrl pathTo(const QString &filename)

Функция преобразует относительный путь к ресурсу в полный путь, специфичный для приложения.

Используется для получения полного пути к файлу, содержащемуся в каталоге данных приложения. Параметр filename должен указывать на файл относительно каталога данных приложения. Возвращенный URL-адрес будет полным путём, указывающим на файл.

Каталог данных обычно находится в /usr/share/$$TARGET (где $$TARGET — это имя приложения), поэтому для приложения с именем org.example.appname и исходного имени файла "qml/main.qml" файл с результатом будет можно найти по адресу /usr/share/org.example.appname/qml/main.qml.

Параметр filename содержит путь относительно каталога данных приложения.

Возвращает полный путь, указывающий на файл.

QUrl pathToMainQml()

Возвращает путь к файлу QML, используемому в качестве корня пользовательского интерфейса приложения.

Эта функция используется для получения в локальной файловой системе пути к файлу QML, который открывается при запуске приложения, и который будет формировать корень всех других файлов QML, отображаемых приложением. Файл должен содержать тип ApplicationWindow, который ссылается на начальную страницу приложения, и обложку, которая будет использоваться на экране приложения. Пример:

import QtQuick 2.0
import Sailfish.Silica 1.0

ApplicationWindow {
    initialPage: Component { MainPage { } }
        // ... Указывает на первую страницу для отображения
    cover: Qt.resolvedUrl("cover/CoverPage.qml")
        // ... Указывает на файл, который будет использоваться для обложки приложения
    allowedOrientations: defaultAllowedOrientations
}

Возвращаемый путь обычно имеет вид /usr/share/$$TARGET/qml/$$TARGET.qml (где $$TARGET — это имя приложения), поэтому для приложения с именем appname возвращаемый путь будет /usr/share/appname/qml/appname.qml.

Возвращает полный путь, указывающий на файл.