1cd9b93a22
- point to main Calamares site in the 'part of' headers instead of to github (this is the "this file is part of Calamares" opening line for most files). - remove boilerplate from all source files, CMake modules and completions, this is the 3-paragraph summary of the GPL-3.0-or-later, which has a meaning entirely covered by the SPDX tag.
91 lines
2.9 KiB
C++
91 lines
2.9 KiB
C++
/* === This file is part of Calamares - <https://calamares.io> ===
|
|
*
|
|
* SPDX-FileCopyrightText: 2020 Adriaan de Groot <groot@kde.org>
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* Calamares is Free Software: see the License-Identifier above.
|
|
*
|
|
*/
|
|
|
|
#ifndef UTILS_QML_H
|
|
#define UTILS_QML_H
|
|
|
|
#include "DllMacro.h"
|
|
|
|
#include "modulesystem/InstanceKey.h"
|
|
#include "utils/NamedEnum.h"
|
|
|
|
#include <QDir>
|
|
|
|
class QQuickItem;
|
|
|
|
namespace CalamaresUtils
|
|
{
|
|
/// @brief the extra directory where Calamares searches for QML files
|
|
UIDLLEXPORT QDir qmlModulesDir();
|
|
/// @brief sets specific directory for searching for QML files
|
|
UIDLLEXPORT void setQmlModulesDir( const QDir& dir );
|
|
|
|
/** @brief initialize QML search path with branding directories
|
|
*
|
|
* Picks a suitable branding directory (from the build-dir in debug mode,
|
|
* otherwise based on the branding directory) and adds it to the
|
|
* QML modules directory; returns @c false if none is found.
|
|
*/
|
|
UIDLLEXPORT bool initQmlModulesDir();
|
|
|
|
/** @brief Sets up global Calamares models for QML
|
|
*
|
|
* This needs to be called at least once to make the global Calamares
|
|
* models (Branding, ViewManager, ...) available to QML.
|
|
*
|
|
* The following objects are made available globally:
|
|
* - `io.calamares.ui.Branding` (an object, see Branding.h)
|
|
* - `io.calamares.core.ViewManager` (a model, see ViewManager.h)
|
|
* - `io.calamares.core.Global` (an object, see GlobalStorage.h)
|
|
* Additionally, modules based on QmlViewStep have a context
|
|
* property `config` referring to that module's configuration (if any).
|
|
*/
|
|
UIDLLEXPORT void registerQmlModels();
|
|
|
|
/** @brief Calls the QML method @p method on @p qmlObject
|
|
*
|
|
* Pass in only the name of the method (e.g. onActivate). This function
|
|
* checks if the method exists (with no arguments) before trying to
|
|
* call it, so that no warnings are printed due to missing methods.
|
|
*
|
|
* If there is a return value from the QML method, it is logged (but not otherwise used).
|
|
*/
|
|
UIDLLEXPORT void callQmlFunction( QQuickItem* qmlObject, const char* method );
|
|
|
|
/** @brief Search modes for loading Qml files.
|
|
*
|
|
* A QML file could be compiled into QRC, or it could live
|
|
* in the branding directory (and, in debug-runs, in
|
|
* the current-directory). Modules have some control
|
|
* over where the search is done.
|
|
*/
|
|
enum class QmlSearch
|
|
{
|
|
QrcOnly,
|
|
BrandingOnly,
|
|
Both
|
|
};
|
|
|
|
/// @brief Names for the search terms (in config files)
|
|
UIDLLEXPORT const NamedEnumTable< QmlSearch >& qmlSearchNames();
|
|
|
|
/** @brief Find a suitable QML file, given the search method and name hints
|
|
*
|
|
* Returns QString() if nothing is found (which would mean the module
|
|
* is badly configured).
|
|
*/
|
|
UIDLLEXPORT QString searchQmlFile( QmlSearch method,
|
|
const QString& configuredName,
|
|
const Calamares::ModuleSystem::InstanceKey& i );
|
|
UIDLLEXPORT QString searchQmlFile( QmlSearch method, const QString& fileNameNoSuffix );
|
|
|
|
} // namespace CalamaresUtils
|
|
|
|
#endif
|