You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
latte-dock/containment/package/contents/ui/applet/communicator/LatteBridge.qml

82 lines
3.3 KiB
QML

/*
* Copyright 2018 Michail Vourlakos <mvourlakos@gmail.com>
*
* This file is part of Latte-Dock
*
* Latte-Dock is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License, or (at your option) any later version.
*
* Latte-Dock is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
import QtQuick 2.7
Item{
id: settings
// NAME: version
// USAGE: read-only
// EXPLANATION: Latte communication version in order for the applet to use only properties
// and parameters that are valid
// @since: 0.9
readonly property int version: 9
// NAME: inEditMode
// USAGE: read-only
// EXPLANATION: Latte sets it to true when this applet is in a Latte containment and Latte
// is also in EditMode, that means when the user is altering applets and Latte dock settings
// @since: 0.9
readonly property bool inEditMode: root.editMode
// NAME: palette
// USAGE: read-only
// EXPLANATION: Latte updates it to its coloring palette in order for the applet
// to take resposibility of its coloring.
// USE CASE: when Latte is transparent and applets colors need to be adjusted in order
// to look consistent with the underlying desktop background
// @since: 0.9
readonly property QtObject palette: disableLatteSideColoring ? colorizerManager : null
// NAME: applyPalette
// USAGE: read-only
// EXPLANATION: Latte updates it to TRUE when the applet must use the provided
// Latte "palette" and FALSE otherwise
// USE CASE: when Latte is transparent and applets colors need to be adjusted in order
// to look consistent with the underlying desktop background
// @since: 0.9
readonly property bool applyPalette: disableLatteSideColoring ? colorizerManager.mustBeShown : false
property Item actions: Actions{}
// NAME: disableLatteSideColoring
// TYPE: bool
// USAGE: writable through actions.setProperty
// EXPLANATION: when is TRUE, Latte is not painting/colorizing this applet
// in any case. In such case the applet can use 'palette'
// in order to access the color palette used at all cases from Latte
// USE CASE: when Latte is transparent and applets colors need to be adjusted in order
// to look consistent with the underlying desktop background OR the applet
// is not using monochromatic icons but rather colorful ones.
// @since: 0.9
// NAME: disableLatteIconOverlay
// TYPE: bool
// USAGE: writable through actions.setProperty
// EXPLANATION: when is TRUE, Latte is not overlaying any icons above
// the applet or alters the applet visual in any sense.
// That means that the applet is responsible to provide a conherent
// parabolic effect experience.
// @since: 0.9
}