shift-shell/components/shellsettingsplugin/mobileshellsettings.cpp
Devin Lin 28f7224a5b gestures: Add optional gesture guide panel
This adds a gesture handle mode to the navigation panel, which can be
enabled during gesture-only mode. This reserves space for the system
gesture to be able to be used, allowing us to extend the height in KWin
of the gesture recognition area (which is currently far too short for devices such as Pixel 3a).

This also allows for navigation with a mouse; clicking on the handle
triggers the task switcher, holding it triggers the "home" action.
2025-12-14 18:36:42 -05:00

327 lines
12 KiB
C++

/*
* SPDX-FileCopyrightText: 2022 Devin Lin <devin@kde.org>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "mobileshellsettings.h"
#include <KIO/CommandLauncherJob>
#include <KNotificationJobUiDelegate>
#include <KPluginFactory>
#include <KRuntimePlatform>
#include <QDBusConnection>
#include <QDBusMessage>
#include <QDBusPendingCall>
#include <QDebug>
const QString CONFIG_FILE = QStringLiteral("plasmamobilerc");
const QString GENERAL_CONFIG_GROUP = QStringLiteral("General");
const QString LOCKSCREEN_CONFIG_GROUP = QStringLiteral("Lockscreen");
const QString QUICKSETTINGS_CONFIG_GROUP = QStringLiteral("QuickSettings");
MobileShellSettings::MobileShellSettings(QObject *parent)
: QObject{parent}
, m_config{KSharedConfig::openConfig(CONFIG_FILE)}
{
m_configWatcher = KConfigWatcher::create(m_config);
connect(m_configWatcher.data(), &KConfigWatcher::configChanged, this, [this](const KConfigGroup &group, const QByteArrayList &names) -> void {
Q_UNUSED(names)
if (group.name() == GENERAL_CONFIG_GROUP) {
Q_EMIT vibrationsEnabledChanged();
Q_EMIT vibrationDurationChanged();
Q_EMIT animationsEnabledChanged();
Q_EMIT dateInStatusBarChanged();
Q_EMIT statusBarScaleFactorChanged();
Q_EMIT showBatteryPercentageChanged();
Q_EMIT navigationPanelEnabledChanged();
Q_EMIT gesturePanelEnabledChanged();
Q_EMIT alwaysShowKeyboardToggleOnNavigationPanelChanged();
Q_EMIT keyboardButtonEnabledChanged();
Q_EMIT taskSwitcherPreviewsEnabledChanged();
Q_EMIT actionDrawerTopLeftModeChanged();
Q_EMIT actionDrawerTopRightModeChanged();
Q_EMIT convergenceModeEnabledChanged();
Q_EMIT autoHidePanelsEnabledChanged();
Q_EMIT allowLogoutChanged();
}
if (group.name() == LOCKSCREEN_CONFIG_GROUP) {
Q_EMIT lockscreenLeftButtonActionChanged();
Q_EMIT lockscreenRightButtonActionChanged();
}
if (group.name() == QUICKSETTINGS_CONFIG_GROUP) {
Q_EMIT quickSettingsColumnsChanged();
}
});
}
bool MobileShellSettings::vibrationsEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("vibrationsEnabled", true);
}
void MobileShellSettings::setVibrationsEnabled(bool vibrationsEnabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("vibrationsEnabled", vibrationsEnabled, KConfigGroup::Notify);
m_config->sync();
}
int MobileShellSettings::vibrationDuration() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("vibrationDuration", 10);
}
void MobileShellSettings::setVibrationDuration(int vibrationDuration)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("vibrationDuration", vibrationDuration, KConfigGroup::Notify);
m_config->sync();
}
bool MobileShellSettings::animationsEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("animationsEnabled", true);
}
void MobileShellSettings::setAnimationsEnabled(bool animationsEnabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("animationsEnabled", animationsEnabled, KConfigGroup::Notify);
m_config->sync();
}
bool MobileShellSettings::dateInStatusBar() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("dateInStatusBar", false);
}
void MobileShellSettings::setDateInStatusBar(bool dateInStatusBar)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("dateInStatusBar", dateInStatusBar, KConfigGroup::Notify);
m_config->sync();
}
float MobileShellSettings::statusBarScaleFactor() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("statusBarScaleFactor", 1.0);
}
void MobileShellSettings::setStatusBarScaleFactor(float statusBarScaleFactor)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("statusBarScaleFactor", statusBarScaleFactor, KConfigGroup::Notify);
m_config->sync();
}
bool MobileShellSettings::showBatteryPercentage() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("showBatteryPercentage", true);
}
void MobileShellSettings::setShowBatteryPercentage(bool showBatteryPercentage)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("showBatteryPercentage", showBatteryPercentage, KConfigGroup::Notify);
m_config->sync();
}
bool MobileShellSettings::navigationPanelEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("navigationPanelEnabled", true);
}
void MobileShellSettings::setNavigationPanelEnabled(bool navigationPanelEnabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("navigationPanelEnabled", navigationPanelEnabled, KConfigGroup::Notify);
m_config->sync();
updateNavigationBarsInPlasma();
}
bool MobileShellSettings::gesturePanelEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("gesturePanelEnabled", true);
}
void MobileShellSettings::setGesturePanelEnabled(bool gesturePanelEnabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("gesturePanelEnabled", gesturePanelEnabled, KConfigGroup::Notify);
m_config->sync();
updateNavigationBarsInPlasma();
}
bool MobileShellSettings::alwaysShowKeyboardToggleOnNavigationPanel() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("alwaysShowKeyboardToggleOnNavigationPanel", false);
}
void MobileShellSettings::setAlwaysShowKeyboardToggleOnNavigationPanel(bool alwaysShowKeyboardToggleOnNavigationPanel)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("alwaysShowKeyboardToggleOnNavigationPanel", alwaysShowKeyboardToggleOnNavigationPanel, KConfigGroup::Notify);
m_config->sync();
}
MobileShellSettings::ActionDrawerMode MobileShellSettings::actionDrawerTopLeftMode() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return (ActionDrawerMode)group.readEntry("actionDrawerTopLeftMode", (int)ActionDrawerMode::Pinned);
}
void MobileShellSettings::setActionDrawerTopLeftMode(ActionDrawerMode actionDrawerMode)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("actionDrawerTopLeftMode", (int)actionDrawerMode, KConfigGroup::Notify);
m_config->sync();
}
int MobileShellSettings::quickSettingsColumns() const
{
auto group = KConfigGroup{m_config, QUICKSETTINGS_CONFIG_GROUP};
return group.readEntry("quickSettingsColumns", 3);
}
void MobileShellSettings::setQuickSettingsColumns(int columns)
{
auto group = KConfigGroup{m_config, QUICKSETTINGS_CONFIG_GROUP};
group.writeEntry("quickSettingsColumns", columns, KConfigGroup::Notify);
m_config->sync();
}
MobileShellSettings::ActionDrawerMode MobileShellSettings::actionDrawerTopRightMode() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return (ActionDrawerMode)group.readEntry("actionDrawerTopRightMode", (int)ActionDrawerMode::Expanded);
}
void MobileShellSettings::setActionDrawerTopRightMode(ActionDrawerMode actionDrawerMode)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("actionDrawerTopRightMode", (int)actionDrawerMode, KConfigGroup::Notify);
m_config->sync();
}
bool MobileShellSettings::convergenceModeEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("convergenceModeEnabled", false);
}
void MobileShellSettings::setConvergenceModeEnabled(bool enabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("convergenceModeEnabled", enabled, KConfigGroup::Notify);
m_config->sync();
// update environment settings
auto *job = new KIO::CommandLauncherJob(QStringLiteral("plasma-mobile-envmanager --apply-settings"), {});
job->setUiDelegate(new KNotificationJobUiDelegate(KJobUiDelegate::AutoErrorHandlingEnabled));
job->setDesktopName(QStringLiteral("org.kde.plasma-mobile-envmanager"));
job->start();
}
bool MobileShellSettings::autoHidePanelsEnabled() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("autoHidePanelsEnabled", false);
}
void MobileShellSettings::setAutoHidePanelsEnabled(bool enabled)
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
group.writeEntry("autoHidePanelsEnabled", enabled, KConfigGroup::Notify);
m_config->sync();
}
void MobileShellSettings::updateNavigationBarsInPlasma()
{
// Do not update panels when not in Plasma Mobile
bool isMobilePlatform = KRuntimePlatform::runtimePlatform().contains("phone");
if (!isMobilePlatform) {
return;
}
auto message = QDBusMessage::createMethodCall(QLatin1String("org.kde.plasmashell"),
QLatin1String("/PlasmaShell"),
QLatin1String("org.kde.PlasmaShell"),
QLatin1String("evaluateScript"));
if (navigationPanelEnabled() || gesturePanelEnabled()) {
QString createNavigationPanelScript = R"(
let allPanels = panels();
let foundPanel = false;
for (var i = 0; i < allPanels.length; i++) {
if (allPanels[i].type === "org.kde.plasma.mobile.taskpanel") {
foundPanel = true;
}
}
if (!foundPanel) {
loadTemplate("org.kde.plasma.mobile.defaultNavigationPanel");
}
)";
message << createNavigationPanelScript;
} else {
QString deleteNavigationPanelScript = R"(
let allPanels = panels();
for (var i = 0; i < allPanels.length; i++) {
if (allPanels[i].type === "org.kde.plasma.mobile.taskpanel") {
allPanels[i].remove();
}
}
)";
message << deleteNavigationPanelScript;
}
// TODO check for error response
QDBusConnection::sessionBus().asyncCall(message);
}
bool MobileShellSettings::allowLogout() const
{
auto group = KConfigGroup{m_config, GENERAL_CONFIG_GROUP};
return group.readEntry("allowLogout", true);
}
MobileShellSettings::LockscreenButtonAction MobileShellSettings::lockscreenLeftButtonAction() const
{
auto group = KConfigGroup{m_config, LOCKSCREEN_CONFIG_GROUP};
return (LockscreenButtonAction)group.readEntry("lockscreenLeftButtonAction", (int)LockscreenButtonAction::None);
}
void MobileShellSettings::setLockscreenLeftButtonAction(const LockscreenButtonAction action)
{
auto group = KConfigGroup{m_config, LOCKSCREEN_CONFIG_GROUP};
group.writeEntry("lockscreenLeftButtonAction", (int)action, KConfigGroup::Notify);
m_config->sync();
}
MobileShellSettings::LockscreenButtonAction MobileShellSettings::lockscreenRightButtonAction() const
{
auto group = KConfigGroup{m_config, LOCKSCREEN_CONFIG_GROUP};
return (LockscreenButtonAction)group.readEntry("lockscreenRightButtonAction", (int)LockscreenButtonAction::None);
}
void MobileShellSettings::setLockscreenRightButtonAction(const LockscreenButtonAction action)
{
auto group = KConfigGroup{m_config, LOCKSCREEN_CONFIG_GROUP};
group.writeEntry("lockscreenRightButtonAction", (int)action, KConfigGroup::Notify);
m_config->sync();
}