LatteDock: Difference between revisions

Revision as of 21:24, 19 August 2019

Technical Details

LatteDock

This is an effort to expose some of the Latte tricks and APIs that developers can use in order to leverage Latte Dock capabilities. Two major sections are currently provided, Applets and Indicators. In the Applets section you will understand how a Plasma QML applet can obtain information from Latte and how it can be implemented properly in order to work just fine with parabolic effect. In Indicators section you will learn how you can create your own Latte Indicators.

NOTE: All mentioned APIs are provided since [v0.9.0] and if new properties or functions are added; a relevant reference will be presented, for example [v0.9.4]

Applets

Can a Plasma Applet access Latte Information?

Most definitely! This is very simple. The only thing you need to add in your applet main QML file is:

import QtQuick 2.0

Item {
    id: root

    //! Latte Connection
    property QtObject latteBridge: null
    //!
}

The latteBridge object is assigned from Latte when applet is loaded and it is the “ONE to rule them ALL” way to communicate with Latte. Important thing to mention is that if your applet is using both Compact and FullRepresentation(s) then the relevant code should be placed in CompactRepresentation.

import QtQuick 2.0

Item {
    id: root

    Plasmoid.compactRepresentation: Item {
        //! Latte Connection
        property QtObject latteBridge: null
        //!
    }
}

After adding latteBridge property it is straightforward to identify when your applet is inside a Latte panel/dock or not with:

readonly property bool inLatte: latteBridge !== null

Can a plasma applet behave properly with parabolic effect?

Parabolic effect is not working properly when applets provide different lengths. Applets with large lengths decrease the animations speed and the applets with small lengths increase it. The best way for parabolic effect to work is for all applets to provide a squared layout that does not update its content positioning when zoomed. In order to make things easy for developers Latte can provide you with the best layout to achieve this without needing from you to make any calculations. To do this, you need to set it up as such:

import QtQuick 2.0

import org.kde.plasma.plasmoid 2.0

Item {
    id: root

    Layout.minimumWidth: inLatte && isHorizontal  ? -1 : [plasma case]
    Layout.preferredWidth: inLatte && isHorizontal  ? -1 : [plasma case]
    Layout.maximumWidth: inLatte && isHorizontal  ? -1 : [plasma case]

    Layout.minimumHeight: inLatte && !isHorizontal  ? -1 : [plasma case]
    Layout.preferredHeight: inLatte && !isHorizontal  ? -1 : [plasma case]
    Layout.maximumHeight: inLatte && !isHorizontal  ? -1 : [plasma case]

    readonly property bool isHorizontal: plasmoid.formFactor === PlasmaCore.Types.Horizontal

    //! Latte Connection
    property QtObject latteBridge: null
    readonly property bool inLatte: latteBridge !== null
    //!
}

In the above example you can see that when the applet is not providing any information for its Layout [-1 case] then Latte has the freedom to set it in the best appropriate.

latteBridge

latteBridge <properties>

After the latteBridge Object has been set from Latte you can access the following properties:

version[int] (readonly) : Shows the latteBridge version which coincides with the Latte Dock version. For example, Latte 0.9.0 produces a unique integer that can be used for numeric comparisons for greater than, lower than etc. If you want to make a version comparison, you can try the following in your code.

latteBridge.version >= latteBridge.actions.makeVersion(0,9,2)

applyPalette [bool] (readonly) : true when Latte is advising the applet to use the Latte colors palette in order to draw its contents with proper contrast

inEditMode [bool] (readonly) : true when Latte is in Edit Mode

inEditMode [bool] (readonly) : true when Latte behaves as a Plasma Panel concerning external shadow rendering, transparency levels, etc.

parabolicEffectEnabled [bool] (readonly) : true when Latte Parabolic Effect is enabled.

iconSize[int] (readonly) : the current icon size used for all applets in the containment where this applet is present

maxZoomFactor[real] (readonly) : the current zoom factor with values from 1.0 to 2.0

1 = No Scaling
1.2 = Scale to 120%
2 = Scale to 200%

actions [QtObject] (readonly) : Used to pass information to Latte concerning your applet requirements. This is explained in detail at latteBridge.actions section

palette [SchemeColors *QtObject] (readonly) : the current Latte color scheme palette used. Properties available for color scheme object are provided through schemecolors.h

windowsTracker [QtObject] (readonly) : all windows tracking information that can be used from applets to update their contents. This is explained in detail in the latteBridge.windowsTracker section. Important:You need to enable windowsTrackingEnabled first through latteBridge.actions object.

latteBridge <signals>

broadcasted(string action, variant value)

Applets in Latte can create their own protocols in order to communicate with their neighbour applets. When such signal is received from your applet it means that some other applet is requesting from you to execute “action” with parameter “value”. A good example are the Window Title and Window AppMenu applets. These applets need to communicate with each other in order to hide or show themselves in Unity Mode. Window Title is shown when there is no mouse hovering and Window AppMenu when there is one. All this is orchestrated through applets without Latte taking any responsibility except broadcasting the requested actions to appropriate recipients. How applets are sending such actions through latteBridge.actions is explained in detail at the relevant section. In you want to track this broadcasted signal you can use:

import QtQuick 2.0

Item {
    id: root

    //! Latte Connection
    property QtObject latteBridge: null
    readonly property bool inLatte: latteBridge !== null
    //!

    Connections {
        target: latteBridge
        onBroadcasted: {
            if (action === "actionname1") {
                //! your code here
            } else if (action === "actionname2") {
                //! your code here
            }
        }
    }

}

latteBridge.actions <object>

Through actions an applet can send information to Latte and other neighbour applets. The following functions can be used to accomplish this:

setProperty(appletId, parameter, value)

Applets can set their characteristics and demands through this function. For example when an applet wants to disable the Active Indicator in Latte Side can use:

latteBridge.actions.setProperty(plasmoid.id, “activeIndicatorEnabled”, false);

or when it wants to disable the Latte Side Coloring that overlays the applets monochromatic in Smart Coloring mode then it can use:

latteBridge.actions.setProperty(plasmoid.id, “latteSideColoringEnabled”, false);

getProperty(appletId, parameter)

Applets can read the current assigned characteristics through this function:

var indicatorEnabled = latteBridge.actions.readProperty(plasmoid.id, “activeIndicatorEnabled”);

broadcastToApplet(receiverPluginId, action, value)

Applets can communicate with other neighbour applets. For example when Window Title is informing AppMenu that needs to hide itself it sends:

latteBridge.actions.broadcastToApplet(“ord.kde.windowappmenu”,”setVisible”, false);

version(major, minor, patch)

It is used to produce a unique integer based on major, minor and patch versions in order to compare different versions, for example:

latteBridge.version >= latteBridge.actions.makeVersion(0,9,2)

latteBridge.actions <applet characteristics>

Applets can have different demands and characteristics that can be set and accessed through setProperty and getProperty functions.

activeIndicatorEnabled [bool] : false means Latte will not draw any indicator for this applet, a good example being the Global Menu plasmoid.

latteIconOverlayEnabled [bool] : false means Latte will never try to identify the central icon used in order to make this applet draw itself correctly with parabolic effect. Most applets are using PlasmaCore.IconItem in order to draw the CompactRepresentation icon when they are in a panel, but plasma iconitem does not play nice with parabolic effect. This is why Latte is trying to handle the case and take resposibility by hiding the PlasmaCore.IconItem and draw a LatteComponents.IconItem instead. If you dont want this to happen then you must set this property to false.

latteSideColoringEnabled [bool] : false means Latte will never overlay any color over this applet because applet takes responsibility for painting itself at all cases.

lengthMarginsEnabled [bool] : false means means Latte will not draw any margins around this applet comparing to its neighbours. Good example is the spacer plasmoid that in panel mode does not need any extra margins around it.

parabolicEffectLocked [bool] : true means Latte must disable parabolic effect for that specific applet.

windowsTrackingEnabled [bool] : true means Latte must provide a latteBridge.windowsTracker object through latteBridge

latteBridge.windowsTracker

WindowTracker provides two major objects currentScreen and allScreens in order to filter windows and provide window states information.

latteBridge.windowsTracker.currentScreen <properties>

activeWindowMaximized [bool] (readonly) : true when there is an active and at the same time maximized window in current screen

activeWindowTouching [bool] (readonly) : true when there is an active window in current screen and that window is also touching the Latte dock/panel.

existsWindowActive [bool] (readonly) : true when there is an active window in current screen.

existsWindowMaximized [bool] (readonly) : true when there is a maximized window in current screen independent if it is active or not.

existsWindowTouching [bool] (readonly) : true where there is a window in current screen that is touching the Latte dock/panel independent if it is active or not

activeWindowScheme[SchemeColors *QtObject] (readonly) : color scheme object for window that is touching Latte dock/panel in current screen and null if there is none. Properties provided by scheme objects can be found at schemecolors.h

lastActiveWindow[LastActiveWindow *QtObject] (readonly) : last active window that is still present and shown in the current screen. Properties provided from lastActiveWindow can be found at lastactivewindow.h

latteBridge.windowTracker.allScreens <properties>

activeWindowMaximized [bool] (readonly) : true when there is an active maximized window in any screen.

existsWindowActive [bool] (readonly) : true when there is an active window in any screen.

existsWindowMaximized [bool] (readonly) : true when there is a maximized window in any screen independent if it is active or not.

activeWindowScheme[SchemeColors *QtObject] (readonly) : color scheme object for active window in any screen, and null if there is none. Properties available for color scheme objects are provided through schemecolors.h

lastActiveWindow[LastActiveWindow *QtObject] (readonly) : last active window that is still present and shown in any screen.Properties provided from lastActiveWindow can be found at lastactivewindow.h

Applet Examples

Latte Separator
Latte Spacer
Window Title Applet
Window Buttons Applet
Window AppMenu Applet

Indicators

Introduction

In Latte v0.9 every indicator style has its own standalone qml implementation that can be found in its own package, just like Plasma qml-only applets. In that way every indicator style can support its own specific user settings and also abstract its implementation from the main Latte development. Online Indicators can be found at the kde store and can be installed through Latte → Effects page without needing from the users any special actions to accomplish the task.

Package Structure

The Indicator package should have the following structure:

metadata.desktop [required]
package/ui/main.qml [required]
package/config/main.xml [optional]
package/config/config.qml [optional]

Metadata.desktop

Every indicator needs a desktop file in order to tell Latte where to find its implementation and what its author details are. The format is as such:

[Desktop Entry]
Name=Latte
Comment=Latte default indicator

Encoding=UTF-8
Type=Service [required]
Icon=latte-dock
X-Plasma-API=declarativeappletscript [required]
X-KDE-ServiceTypes=Latte/Indicator [required]

X-Latte-MainScript=ui/main.qml [required]
X-Latte-ConfigUi=config/config.qml [optional]
X-Latte-ConfigXml=config/main.xml [optional]

X-KDE-PluginInfo-Author=KDE Awesome Developer
[email protected]
X-KDE-PluginInfo-Name=org.kde.latte.default
X-KDE-PluginInfo-Version=0.1
X-KDE-PluginInfo-Category=Latte Indicator
X-KDE-PluginInfo-License=GPL v2+
X-KDE-PluginInfo-EnabledByDefault=true

X-Plasma-API : it is required because it defines a qml-only plugin

X-KDE-ServiceTypes : it is required with value Latte/Indicator otherwise the indicator can not be installed and loaded

X-Latte-MainScript: it is required and defines the main qml file for the indicator implementation

X-Latte-ConfigXml : defines the xml settings that are going to be used from indicator implementation and user settings. It is optional and a package may not include it

X-Latte-ConfigUI : defines the qml settings user interface. It is optional and is provided only when the indicator has settings that the user can choose from in order to adjust the indicate apprearance and behaviour

QML Implementation

package/ui/main.qml

Every indicator's main qml file must use LatteComponents.IndicatorItem at its root

import QtQuick 2.0

import org.kde.latte 0.2 as Latte
import org.kde.latte.components 1.0 as LatteComponents

LatteComponents.IndicatorItem {
    id: root

    providesFrontLayer: false
    providesHoveredAnimation: false
    ...

}

The LatteComponents.IndicatorItem provides options to inform Latte what requirements and capabilities this indicator provides in order to appear, function and behave properly. All IndicatorItem options are [optional]:

LatteComponents.IndicatorItem [properties]

needsIconColors [bool] : true when current icon main colors are needed. For example the Unity Indicator draws a background and a glow that are provided from current icon colors.

needsMouseEventCoordinates [bool] : true when mouse event coordinates are needed. An example is the click animation in android style that provides the Plasma Indicator.

providesFrontLayer [bool] : true when a front layer is provided in order to draw contents above the current item/icon.

providesHoveredAnimation [bool] : true if the Latte built-in hovered animation must be disabled

providesClickAnimation [bool] : true if the Latte built-in clicked animation must be disabled

extraMaskThickness [int] : How many pixels are needed above the indicator in order to be drawn correctly. An example is the Latte indicator in reverse mode that supports glowing, but that glow is drawn externally. Latte must be informed for this in order to not visually subtract that glow.

minThicknessPadding [int] : The minimum thickness padding that is needed for the indicator

minThicknessPadding: 0.2 //20% of current icon size

svgImagePaths [Array of strings] : Plasma::SVG files that must be loaded from Latte in order to avoid high memory consumption. An example could be:

svgImagePaths: [‘widgets/panel-background’, ‘../icons/separator.svg’]

In this example the first svg icon is provided from current plasma theme used and the second is located relevant to the package/ui folder.

Tasks/Applets Information

As long as IndicatorItem has been set for the main qml file then the entire indicator qml implementation gains two different objects ( level and indicator ) in order to access tasks/applets and general information.

level <properties>

isBackground [bool] (readonly) : true when the indicator background layer must be painted which is below the current icon/applet.

isForeground [bool] (readonly) : true when the indicator foreground layer needs to be painted which is above the current icon/applet

level <signals>

mousePressed(int x, int y, int button) : can be tracked when needMouseEventSignals property has been enabled in IndicatorItem in order to get mouse x,y coordinates and which mouse button was released.

indicator <properties>

isTask [bool] (readonly) : true when main item is actually a task

isApplet [bool] : true when main item is actually an applet

isLauncher [bool] (readonly) : true when main item is a task in launcher state

isStartup [bool] (readonly) : true when main item is a task in startup state

isWindow [bool] (readonly) : true when main item is a task in window state

isActive [bool] (readonly) : true when main item is active

isGroup [bool] (readonly) : true when main item is a group of tasks

isHovered [bool] (readonly) : true when main item is hovered

isMinimized [bool] (readonly) : true when main item is a task in minimized state

isPressed [bool] (readonly) : true when main item is pressed

inAttention [bool] (readonly) : true when main item requires attention

inRemoving [bool] (readonly) : true when main item is in remove stage

isSquare [bool] (readonly) : true when main item has a squared layout

hasActive [bool] (readonly) : true when a group of tasks has an active item

hasMinimized [bool] (readonly) : true when a group of tasks has at least one minimized window

hasShown [bool] (readonly) : true when a group of tasks has at least one shown (not minimimed) window

windowsCount [int] (readonly) : how many windows exist in a grouped task

windowsMinimizedCount [int] (readonly) : how many minimized windows exist in a grouped task

currentIconSize [int] (readonly) : current icon size used for the entire dock or panel

maxIconSize [int] (readonly) : maximum icon size that can occur from this dock or panel

scaleFactor [real] (readonly) : current scale factor for this item with values from 1.0 to 2.0

1 = Item is not zoomed
1.2 = Item is zoomed by 20%
2 = Item is zoomed by 100%

panelOpacity [real] (readonly) : current panel background opacity

shadowColor [color] (readonly) : current shadow color used for all items

animationsEnabled [bool] (readonly) : true when animations are enabled

durationTime [real] (readonly) : current duration time for animation. It is a multiplier that can be used for animations in order to respect user preference concerning animations speed

usePlasmaTabsStyle [bool] (readonly) : true when the user has disabled latte indicator drawing for applets [you do not have to use it, it is used only from Plasma indicator]

iconBackgroundColor [color] (readonly) : main background color produced from the current icon. [requires from you to have set needsIconColors to true at main IndicatorItem]

iconGlowColor [color] (readonly) : main glow color produced from the current icon. [requires from you to have set needsIconColors to true at main IndicatorItem]

palette [QtObject] (readonly) : current colors palette used. Provides backgroundColor, textColor etc. Take note that this object provides also a scheme string pointing absolute path of the current scheme file. A good example for indicator.scheme is the Window Buttons applet that forwards that information to KDecoration2 in order for plasma window buttons to be drawn. Example code:

property color backColor: indicator.palette.backgroundColor

configuration [QtObject] (readonly) : object to access the user settings specified at the main.xml file

resources [QtObject] (readonly) : object to access memory efficient produced resources such as plasma svgs

resources.svgs [Array] (readonly) : object to access memory efficient produced Plasma/Svgs specified at IndicatorItem.svgImagePaths

import QtQuick 2.0
import org.kde.plasma.core 2.0 as PlasmaCore
import org.kde.latte 0.2 as Latte
import org.kde.latte.components 1.0 as LatteComponents

LatteComponents.IndicatorItem {
    id: root

    svgImagePaths: [‘widgets/panel-background’, ‘../icons/separator.svg’]
    ...
       PlasmaCore.SvgItem {
             id: panelBackgroundSvgItem

        svg: indicator.resources.svgs[0]
   }
   ...
}

User Settings Config File

If you are familiar with plasma applets settings xml files then you are going to feel right at home as indicators follow the same xml scheme.

Example of Latte indicator main.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<kcfg xmlns="http://www.kde.org/standards/kcfg/1.0"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
        http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
    <kcfgfile name=""/>
    <group name="General">
    <entry name="activeStyle" type="Enum">
        <label>Active indicator style</label>
        <choices>
            <choice name="Line"/>
            <choice name="Dot"/>
        </choices>
        <default>0</default>
    </entry>
    <entry name="glowEnabled" type="Bool">
        <default>false</default>
    </entry>
    <entry name="glowApplyTo" type="Enum">
        <label>Glow for active indicators</label>
        <choices>
            <choice name="None"/>
            <choice name="OnActive"/>
            <choice name="All"/>
        </choices>
        <default>2</default>
    </entry>
    <entry name="glow3D" type="Bool">
        <default>true</default>
    </entry>
    <entry name="glowOpacity" type="Double">
        <default>0.35</default>
    </entry>
    <entry name="reversed" type="Bool">
        <default>false</default>
    </entry>
    </group>
</kcfg>

Configuration UI

If you want the users to be able to adjust settings from config xml file then you need to provide a qml interface which is going to be loaded in Latte → Effects page when your indicator is active. As such it is proposed to try to use QML components that dont break consistency and behavior of Latte Settings different pages. LatteComponents are used in most settings pages but nothing forbids you to choose something else. The configuration ui does not belong to any applet or task and as such it provides different options through two very important objects indicator and dialog.

indicator <properties - in configuration user interface>

latteTasksArePresent [bool] (readonly) : true when the dock or panel contains a Latte Tasks plasmoid.

configuration [QtObject] (readonly) : object to access the user settings specified at the main.xml file

Important: all other properties provided by indicator object when is present in a task or applet are not provided here.

dialog <properties - in configuration user interface>

Through dialog object the Indicator's configuration user interface can adjust its layout at the settings popup window flexible design when appropriate.

inConfigureAppletsMode [bool] (readonly) : true when the user is inConfigureApplets edit mode in contrast to liveEditing mode.

optionsWidth [int] (readonly) : the settings popup window current width that can be used from options.

Example from Plasma indicator:

import QtQuick 2.7
import QtQuick.Controls 1.4
import QtQuick.Layouts 1.3
import org.kde.plasma.plasmoid 2.0
import org.kde.plasma.core 2.0 as PlasmaCore
import org.kde.latte 0.2 as Latte
import org.kde.latte.components 1.0 as LatteComponents

ColumnLayout {
    id: root
    Layout.fillWidth: true

    LatteComponents.CheckBoxesColumn {
        Layout.topMargin: 1.5 * units.smallSpacing

        LatteComponents.CheckBox {
            Layout.maximumWidth: dialog.optionsWidth

            text: i18n("Reverse indicator style")
            checked: indicator.configuration.reversed

            onClicked: {
                indicator.configuration.reversed = !indicator.configuration.reversed;
            }
        }

        LatteComponents.CheckBox {
            Layout.maximumWidth: dialog.optionsWidth

            text: i18n("Growing circle animation when clicked")
            checked: indicator.configuration.clickedAnimationEnabled

            onClicked: {
                indicator.configuration.clickedAnimationEnabled = !indicator.configuration.clickedAnimationEnabled;
            }
        }
    }
}

Indicator Examples

Plasma Indicator
Latte Official Indicator
Unity Indicator
DashToPanel Indicator