├── src ├── qmldir ├── plugin.h ├── plugin.cpp ├── i3listener.h ├── workspace.h ├── i3pager.h ├── CMakeLists.txt ├── workspace.cpp ├── i3listener.cpp └── i3pager.cpp ├── .gitmodules ├── .clang-format ├── .gitlab-ci.yml ├── plasmoid ├── contents │ ├── config │ │ ├── config.qml │ │ └── main.xml │ └── ui │ │ ├── screens.js │ │ ├── configGeneral.qml │ │ ├── configScreens.qml │ │ └── main.qml └── metadata.json ├── .github └── workflows │ └── build.yml ├── .gitignore ├── .kde-ci.yml ├── CMakeLists.txt ├── README.md └── LICENSE /src/qmldir: -------------------------------------------------------------------------------- 1 | module org.kde.private.I3Pager 2 | 3 | plugin I3PagerPlugin 4 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "i3ipc++"] 2 | path = i3ipc++ 3 | url = https://github.com/drmgc/i3ipcpp.git 4 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: WebKit 2 | IndentWidth: 4 3 | TabWidth: 4 4 | UseTab: false 5 | BreakBeforeBraces: Attach 6 | 7 | AllowShortIfStatementsOnASingleLine: Never 8 | AllowShortFunctionsOnASingleLine: Inline 9 | AllowShortBlocksOnASingleLine: true 10 | AllowShortLoopsOnASingleLine: true -------------------------------------------------------------------------------- /.gitlab-ci.yml: -------------------------------------------------------------------------------- 1 | # SPDX-FileCopyrightText: None 2 | # SPDX-License-Identifier: CC0-1.0 3 | 4 | variables: 5 | GIT_SUBMODULE_STRATEGY: recursive 6 | 7 | include: 8 | - project: sysadmin/ci-utilities 9 | file: 10 | - /gitlab-templates/linux.yml 11 | - /gitlab-templates/freebsd.yml 12 | - /gitlab-templates/linux-qt6.yml 13 | - /gitlab-templates/freebsd-qt6.yml 14 | -------------------------------------------------------------------------------- /src/plugin.h: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #pragma once 7 | 8 | #include 9 | 10 | class QQmlEngine; 11 | class Plugin : public QQmlExtensionPlugin { 12 | Q_OBJECT 13 | Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QQmlExtensionInterface") 14 | 15 | public: 16 | void registerTypes(const char* uri) override; 17 | }; 18 | -------------------------------------------------------------------------------- /src/plugin.cpp: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #include "plugin.h" 7 | #include "i3pager.h" 8 | #include "workspace.h" 9 | #include 10 | 11 | void Plugin::registerTypes(const char *uri) { 12 | Q_ASSERT(uri == QLatin1String("org.kde.private.I3Pager")); 13 | qRegisterMetaType(); 14 | qRegisterMetaType>(); 15 | qmlRegisterType(uri, 1, 0, "I3Pager"); 16 | } 17 | -------------------------------------------------------------------------------- /plasmoid/contents/config/config.qml: -------------------------------------------------------------------------------- 1 | /* -*- qml -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | import QtQuick 2.15 7 | import org.kde.plasma.configuration 8 | 9 | ConfigModel { 10 | ConfigCategory { 11 | name: i18n("General") 12 | icon: "configure" 13 | source: "configGeneral.qml" 14 | } 15 | ConfigCategory { 16 | name: i18n("Screens") 17 | icon: "monitor" 18 | source: "configScreens.qml" 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/i3listener.h: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #pragma once 7 | 8 | #include 9 | 10 | class I3ListenerThread : public QThread { 11 | Q_OBJECT 12 | 13 | public: 14 | explicit I3ListenerThread(QObject* parent = 0); 15 | void run() override; 16 | void stop(); 17 | 18 | Q_SIGNALS: 19 | void workspacesChanged(); 20 | void modeChanged(const QString& mode); 21 | 22 | private: 23 | bool stopping = false; 24 | void handleI3Events(); 25 | }; 26 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build plasmoid plugin 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | name: Linux Latest x64 8 | runs-on: ubuntu-latest 9 | 10 | steps: 11 | - uses: actions/checkout@v2 12 | with: 13 | submodules: recursive 14 | 15 | - name: Installing system libs 16 | run: | 17 | sudo apt update 18 | sudo apt install libkf5plasma-dev extra-cmake-modules qtbase5-dev qtdeclarative5-dev libsigc++-2.0-dev libjsoncpp-dev i3-wm 19 | 20 | - name: Configure 21 | run: cmake -DCMAKE_INSTALL_PREFIX=$(kf5-config --prefix) -DCI_ERRORS=on -B build . 22 | 23 | - name: Build 24 | run: make -j $(nproc) -C build 25 | 26 | - name: Install 27 | run: sudo make -C build install 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | CMakeLists.txt.user 2 | CMakeCache.txt 3 | CMakeFiles 4 | CMakeScripts 5 | Testing 6 | Makefile 7 | cmake_install.cmake 8 | install_manifest.txt 9 | compile_commands.json 10 | CTestTestfile.cmake 11 | _deps 12 | build/ 13 | 14 | # Prerequisites 15 | *.d 16 | 17 | # Compiled Object files 18 | *.slo 19 | *.lo 20 | *.o 21 | *.obj 22 | 23 | # Precompiled Headers 24 | *.gch 25 | *.pch 26 | 27 | # Compiled Dynamic libraries 28 | *.so 29 | *.dylib 30 | *.dll 31 | 32 | # Fortran module files 33 | *.mod 34 | *.smod 35 | 36 | # Compiled Static libraries 37 | *.lai 38 | *.la 39 | *.a 40 | *.lib 41 | 42 | # Executables 43 | *.exe 44 | *.out 45 | *.app 46 | 47 | .vscode/ 48 | ecm_uninstall.cmake 49 | *_autogen/ 50 | *.appdata.xml 51 | *-metadata.json 52 | prefix.sh 53 | regenerateindex.sh 54 | -------------------------------------------------------------------------------- /plasmoid/metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "KPlugin": { 3 | "Authors": [ 4 | { 5 | "Email": "christian@duvholt.net", 6 | "Name": "Christian duvholt" 7 | }, 8 | { 9 | "Email": "bjorn.bidar@thaodan.de", 10 | "Name": "Björn Bidar" 11 | } 12 | 13 | ], 14 | "Description": "i3 Pager", 15 | "Id": "org.kde.I3Pager", 16 | "License": "GPL-3.0-or-later", 17 | "Name": "i3Pager", 18 | "ServiceTypes": [ 19 | "Plasma/Applet" 20 | ], 21 | "Version": "1.0", 22 | "Website": "https://github.com/duvholt/i3-pager" 23 | }, 24 | "X-Plasma-API": "declarativeappletscript", 25 | "X-Plasma-API-Minimum-Version": "6.0", 26 | "X-Plasma-MainScript": "ui/main.qml" 27 | } 28 | -------------------------------------------------------------------------------- /.kde-ci.yml: -------------------------------------------------------------------------------- 1 | Dependencies: 2 | - 'on': ['Linux/Qt5', 'FreeBSD/Qt5'] 3 | 'require': 4 | 'frameworks/extra-cmake-modules': '@stable' 5 | 'frameworks/kcoreaddons': '@stable' 6 | 'frameworks/kconfig': '@stable' 7 | 'frameworks/kconfigwidgets': '@stable' 8 | 'frameworks/ki18n': '@stable' 9 | 'frameworks/knotifications': '@stable' 10 | 'frameworks/krunner': '@stable' 11 | 'frameworks/kcmutils': '@stable' 12 | 'frameworks/kguiaddons': '@stable' 13 | 'plasma/libplasma': '@stable' 14 | 15 | - 'on': ['Linux/Qt6', 'FreeBSD/Qt6'] 16 | 'require': 17 | 'frameworks/extra-cmake-modules': '@latest-kf6' 18 | 'frameworks/kcoreaddons': '@latest-kf6' 19 | 'frameworks/kconfig': '@latest-kf6' 20 | 'frameworks/kconfigwidgets': '@latest-kf6' 21 | 'frameworks/ki18n': '@latest-kf6' 22 | 'frameworks/knotifications': '@latest-kf6' 23 | 'frameworks/krunner': '@latest-kf6' 24 | 'frameworks/kcmutils': '@latest-kf6' 25 | 'frameworks/kguiaddons': '@latest-kf6' 26 | 'plasma/libplasma': '@latest-kf6' 27 | -------------------------------------------------------------------------------- /src/workspace.h: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #pragma once 7 | 8 | #include 9 | 10 | class Workspace { 11 | Q_GADGET 12 | Q_PROPERTY(QString id MEMBER id) 13 | Q_PROPERTY(QString index MEMBER index) 14 | Q_PROPERTY(QString name MEMBER name) 15 | Q_PROPERTY(QString icon MEMBER icon) 16 | Q_PROPERTY(QString output MEMBER output) 17 | Q_PROPERTY(bool focused MEMBER focused) 18 | Q_PROPERTY(bool visible MEMBER visible) 19 | Q_PROPERTY(bool urgent MEMBER urgent) 20 | public: 21 | static QList filterByCurrentScreen(QList inputWorkspaces, QString currentScreen); 22 | static QList orderByName(QList inputWorkspaces); 23 | static QList orderByOutput(QList inputWorkspaces, QList workspaceNameList); 24 | QString id; 25 | QString index; 26 | QString name; 27 | QString icon; 28 | QString output; 29 | bool focused; 30 | bool visible; 31 | bool urgent; 32 | }; 33 | 34 | Q_DECLARE_METATYPE(Workspace) 35 | -------------------------------------------------------------------------------- /src/i3pager.h: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #pragma once 7 | 8 | #include "workspace.h" 9 | #include 10 | 11 | class I3ListenerThread; 12 | class Workspace; 13 | 14 | class I3Pager : public QObject { 15 | Q_OBJECT 16 | Q_PROPERTY(QString currentScreen READ getCurrentScreen WRITE setCurrentScreen) 17 | Q_PROPERTY(QString mode READ getMode NOTIFY modeChanged) 18 | 19 | public: 20 | explicit I3Pager(QObject* parent = 0); 21 | ~I3Pager(); 22 | 23 | QString getCurrentScreen() const; 24 | void setCurrentScreen(QString screen); 25 | Q_INVOKABLE void activateWorkspace(QString workspace); 26 | 27 | public Q_SLOTS: 28 | QString getCurrentScreen(); 29 | QList getWorkspaces(bool filterByCurrentScreen, QString orderWorkspacesBy, QList screenOrder); 30 | QList getScreenNames(); 31 | QString getMode(); 32 | 33 | Q_SIGNALS: 34 | void workspacesChanged(); 35 | void modeChanged(); 36 | 37 | private: 38 | I3ListenerThread* i3ListenerThread; 39 | QString currentScreenPrivate; 40 | QString mode; 41 | }; 42 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.16.0) 2 | 3 | project(I3Pager) 4 | 5 | find_package(ECM REQUIRED NO_MODULE) 6 | 7 | set(CMAKE_CXX_STANDARD 17) 8 | set(QT_MAJOR_VERSION "6") 9 | set(QT_MIN_VERSION "6.4.0") 10 | set(KF_MIN_VERSION "6.0.0") 11 | set(KF_MAJOR_VERSION "6") 12 | 13 | set(CMAKE_MODULE_PATH ${ECM_MODULE_PATH} ${ECM_KDE_MODULE_DIR} ${CMAKE_MODULE_PATH}) 14 | 15 | include(ECMQtDeclareLoggingCategory) 16 | include(KDEInstallDirs) 17 | include(KDECMakeSettings) 18 | include(KDECompilerSettings) 19 | include(FeatureSummary) 20 | 21 | find_package(Qt${QT_MAJOR_VERSION} ${QT_MIN_VERSION} 22 | CONFIG REQUIRED 23 | Quick 24 | Concurrent 25 | # Plugin 26 | Widgets 27 | ) 28 | find_package(KF${KF_MAJOR_VERSION} ${KF6_MIN_VERSION} 29 | REQUIRED COMPONENTS 30 | WindowSystem 31 | # Pulled in by Plasma 32 | Config 33 | 34 | ) 35 | find_package(Plasma) 36 | 37 | 38 | plasma_install_package(plasmoid org.kde.I3Pager) 39 | 40 | ADD_DEFINITIONS(-DQT_NO_KEYWORDS) 41 | 42 | SET(BUILD_SHARED_LIBS OFF) 43 | add_subdirectory(i3ipc++) 44 | 45 | target_compile_options(i3ipc++ PRIVATE -fexceptions -fPIC -Wno-deprecated-declarations) 46 | add_subdirectory(src) 47 | 48 | feature_summary(WHAT ALL FATAL_ON_MISSING_REQUIRED_PACKAGES) 49 | -------------------------------------------------------------------------------- /src/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | set(I3PagerPlugin_SRCS 2 | plugin.cpp 3 | plugin.h 4 | i3pager.cpp 5 | i3pager.h 6 | i3listener.cpp 7 | i3listener.h 8 | workspace.cpp 9 | workspace.h) 10 | 11 | ecm_qt_declare_logging_category(I3PagerPlugin_SRCS 12 | HEADER i3pager_debug.h 13 | IDENTIFIER I3PAGER 14 | CATEGORY_NAME org.kde.I3Pager 15 | DESCRIPTION "I3Pager Plasmoid" 16 | EXPORT I3Pager 17 | ) 18 | 19 | add_library(I3PagerPlugin SHARED ${I3PagerPlugin_SRCS}) 20 | target_compile_options(I3PagerPlugin PRIVATE -fexceptions) 21 | 22 | set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g3") 23 | set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O2") 24 | 25 | if (CI_ERRORS) 26 | target_compile_options(I3PagerPlugin PRIVATE -Werror -Wall -Wextra -pedantic-errors) 27 | endif() 28 | 29 | include_directories(${I3IPCpp_INCLUDE_DIRS}) 30 | link_directories(${I3IPCpp_LIBRARY_DIRS}) 31 | 32 | target_link_libraries(I3PagerPlugin 33 | Qt${QT_MAJOR_VERSION}Quick 34 | Qt${QT_MAJOR_VERSION}::Widgets 35 | KF${KF_MAJOR_VERSION}::WindowSystem 36 | ${I3IPCpp_LIBRARIES} 37 | Plasma::Plasma) 38 | 39 | # install plugin 40 | install(TARGETS I3PagerPlugin DESTINATION ${KDE_INSTALL_QMLDIR}/org/kde/private/I3Pager) 41 | install(FILES qmldir DESTINATION ${KDE_INSTALL_QMLDIR}/org/kde/private/I3Pager) 42 | ecm_qt_install_logging_categories(EXPORT I3PAGER 43 | FILE org.kde.i3pager.categories 44 | DESTINATION ${KDE_INSTALL_LOGGINGCATEGORIESDIR}) 45 | -------------------------------------------------------------------------------- /plasmoid/contents/config/main.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 7 | 8 | 9 | 10 | true 11 | 12 | 13 | 14 | 15 | true 16 | 17 | 18 | 19 | 20 | true 21 | 22 | 23 | 24 | 25 | default 26 | 27 | 28 | 29 | 30 | true 31 | 32 | 33 | 34 | 35 | line 36 | 37 | 38 | 39 | 40 | bottom 41 | 42 | 43 | 44 | 45 | 46 | 47 | false 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 0.5 57 | 58 | 59 | 60 | 61 | -------------------------------------------------------------------------------- /src/workspace.cpp: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #include "workspace.h" 7 | #include "i3pager_debug.h" 8 | #include 9 | #include 10 | 11 | QList Workspace::filterByCurrentScreen(QList inputWorkspaces, QString currentScreen) { 12 | QList outputWorkspaces; 13 | qCDebug(I3PAGER) << "Filtering by current screen:" << currentScreen; 14 | for (auto workspace : inputWorkspaces) { 15 | if (currentScreen == workspace.output) { 16 | qCDebug(I3PAGER) << "Added workspace:" << workspace.name << "output:" << workspace.output; 17 | outputWorkspaces.append(workspace); 18 | } else { 19 | qCDebug(I3PAGER) << "Removed workspace:" << workspace.name << "output:" << workspace.output; 20 | } 21 | } 22 | return outputWorkspaces; 23 | } 24 | 25 | QList Workspace::orderByName(QList inputWorkspaces) { 26 | std::sort(inputWorkspaces.begin(), inputWorkspaces.end(), [](Workspace a,Workspace b) { 27 | return (a.name < b.name); 28 | }); 29 | return inputWorkspaces; 30 | } 31 | 32 | QList Workspace::orderByOutput(QList inputWorkspaces, QList outputList) { 33 | QList outputWorkspaces; 34 | qCDebug(I3PAGER) << "Ordering workspaces by screens:" << outputList; 35 | for (auto output : outputList) { 36 | for (auto workspace : inputWorkspaces) { 37 | if (workspace.output == output) { 38 | qCDebug(I3PAGER) << "Added workspace:" << workspace.name << "output:" << workspace.output; 39 | outputWorkspaces.append(workspace); 40 | } 41 | } 42 | } 43 | 44 | return outputWorkspaces; 45 | } 46 | -------------------------------------------------------------------------------- /plasmoid/contents/ui/screens.js: -------------------------------------------------------------------------------- 1 | /* -*- qml -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | function saveConfig() { 7 | console.log("Saving config") 8 | cfg_screenNameList = []; 9 | cfg_screenColorList = []; 10 | 11 | for (var i = 0; i < screenListModel.count; i++) { 12 | var name = screenListModel.get(i).screenName; 13 | var color = qColorFromString(screenListModel.get(i).screenColor); 14 | color.a = cfg_screenColorOpacity; 15 | 16 | cfg_screenNameList.push(name); 17 | cfg_screenColorList.push(color); 18 | } 19 | } 20 | 21 | function loadConfig() { 22 | for (var i = 0; i < cfg_screenNameList.length; i++) { 23 | var name = cfg_screenNameList[i]; 24 | var color = qColorFromString(cfg_screenColorList[i]); 25 | color.a = 1; 26 | 27 | screenListModel.append({screenName: name, screenColor: color}); 28 | } 29 | } 30 | 31 | function loadNewScreens() { 32 | var defaultColors = ["#004040", "#007D7D", "#00D7D7"]; 33 | for (var screenName of i3pager.getScreenNames()) { 34 | if (!isScreenNameOnList(screenName, cfg_screenNameList)) { 35 | var colorIndex = Math.min(screenListModel.count, defaultColors.length - 1); 36 | screenListModel.append({screenName: screenName, screenColor: defaultColors[colorIndex]}); 37 | } 38 | } 39 | } 40 | 41 | function isScreenNameOnList(name, list) { 42 | for (var screenName of list) { 43 | if (name == screenName) { 44 | return true; 45 | } 46 | } 47 | return false; 48 | } 49 | 50 | /* This is a helper function. There is no 51 | * function for creating QColor from string, 52 | * therefore we use Qt.lighter with the 53 | * factor of 1 as a workaround. */ 54 | function qColorFromString(stringColor) { 55 | return Qt.lighter(stringColor, 1); 56 | } 57 | -------------------------------------------------------------------------------- /src/i3listener.cpp: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #include "i3listener.h" 7 | #include "i3pager_debug.h" 8 | #include 9 | #include 10 | #include 11 | #include 12 | 13 | I3ListenerThread::I3ListenerThread(QObject* parent) 14 | : QThread(parent) { 15 | } 16 | 17 | void I3ListenerThread::run() { 18 | while (!stopping) { 19 | this->handleI3Events(); 20 | // sleep 100ms to avoid log spamming on i3 crash or reload 21 | this->msleep(100); 22 | } 23 | } 24 | 25 | void I3ListenerThread::handleI3Events() { 26 | try { 27 | i3ipc::connection conn; 28 | conn.subscribe(i3ipc::ET_WORKSPACE | i3ipc::ET_BINDING | i3ipc::ET_MODE); 29 | 30 | // Workspace events handler 31 | conn.signal_workspace_event.connect([this](const i3ipc::workspace_event_t& ev) { 32 | qCDebug(I3PAGER) << "workspace_event: " << (char)ev.type; 33 | if (ev.current) { 34 | qCDebug(I3PAGER) << "\tSwitched to #" << ev.current->num << " - \"" << QString::fromStdString(ev.current->name) << '"'; 35 | Q_EMIT workspacesChanged(); 36 | } 37 | }); 38 | 39 | // Mode events handler 40 | conn.signal_mode_event.connect([this](const i3ipc::mode_t& i3mode) { 41 | const auto mode = QString::fromStdString(i3mode.change); 42 | qCDebug(I3PAGER) << "mode: " << mode; 43 | Q_EMIT modeChanged(mode); 44 | }); 45 | 46 | while (!stopping) { 47 | conn.handle_event(); 48 | } 49 | } catch (std::exception const& e) { 50 | qCWarning(I3PAGER) << "Exception in i3listener handle events:" << e.what(); 51 | } 52 | } 53 | 54 | void I3ListenerThread::stop() { 55 | this->stopping = true; 56 | // Not good practice, but i3ipc::conn.handle_event is blocking on read 57 | // and I don't know how to interrupt that 58 | this->terminate(); 59 | } 60 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # i3-pager 2 | 3 | A plasmoid for integrating i3 with KDE Plasma. 4 | 5 | ![image](https://user-images.githubusercontent.com/1637715/72685652-676b4e80-3aec-11ea-8173-4c20daaa584e.png) 6 | 7 | ## Plasma 6 8 | 9 | The main branch only supports Plasma 6. Checkout the [plasma5](https://github.com/duvholt/i3-pager/tree/plasma5) branch for the last working Plasma 5 code. 10 | 11 | ## Installation 12 | 13 | + Install system dependencies (for Debian based distros): 14 | 15 | ```sh 16 | sudo apt install -y libsigc++-2.0-dev libjsoncpp-dev extra-cmake-modules qml-module-qt-labs-qmlmodels make cmake libkf5plasma-dev qtbase5-dev qtdeclarative5-dev 17 | ``` 18 | 19 | + Build and install i3-pager: 20 | 21 | ```bash 22 | git clone https://github.com/duvholt/i3-pager.git --recurse-submodules 23 | cd i3-pager 24 | cmake -DCMAKE_INSTALL_PREFIX=$(kf5-config --prefix) -DCMAKE_BUILD_TYPE=Release -B build 25 | make -j $(nproc) -C build 26 | sudo make -C build install 27 | ``` 28 | 29 | + Add i3-pager plasmoid to either Plasma dock or Latte-dock. 30 | 31 | ## Features 32 | 33 | + Shows current mode 34 | + Shows workspaces 35 | + Allows filtering by the current screen 36 | + Show workspace icons using `Font Awesome` 37 | 38 | ## Configuration 39 | 40 | ### Multiple screens 41 | 42 | If you have multiple screens you need to either put i3-pager on both or you need to disable `Filter workspaces by current screen` in the plasmoid setting. Otherwise you are only going to see the workspaces on the current screen. 43 | 44 | ### Workspace name and icon 45 | 46 | i3-pager supports setting name and icon per workspace using `Font Awesome`. 47 | 48 | ```bash 49 | # :: 50 | set $ws1 "1:General:�~J�" 51 | set $ws2 "2:Chat:�~B~F" 52 | set $ws3 "3:Code:�~D�" 53 | set $ws4 "4:Terminal:�~D| " 54 | 55 | # Use $ws1 etc as you normally would e.g: 56 | bindsym $mod+1 workspace number $ws1 57 | bindsym $mod+2 workspace number $ws2 58 | bindsym $mod+3 workspace number $ws3 59 | bindsym $mod+4 workspace number $ws4 60 | ``` 61 | 62 | Available icons are listed [here](https://fontawesome.com/icons?d=gallery&s=solid&m=free). 63 | 64 | Select an icon and click `Copy Unicode Glyph`. 65 | 66 | If you can't see any icons make sure `Font Awesome` is installed as `Font Awesome 5 Free Solid`. Try running `fc-match "Font Awesome 5 Free Solid"` and see if you get a match. 67 | 68 | You can choose to hide workspace names in the plasmoid settings. 69 | 70 | ## Development 71 | 72 | Build with debug mode: 73 | 74 | ```bash 75 | cmake -DCMAKE_INSTALL_PREFIX=$(kf5-config --prefix) -DCMAKE_BUILD_TYPE=Debug -B build 76 | make -C build 77 | sudo make -C build install 78 | ``` 79 | 80 | This will install the plasmoid globally as I'm not aware of a way to access the plasmoid C++ plugin without globally installing it. To see changes restart Plasma: 81 | 82 | ``` 83 | killall plasmashell; kstart5 plasmashell 84 | ``` 85 | 86 | ### Plasmoid 87 | 88 | The `plasmoid` folder contains the code for the widget and settings. 89 | 90 | To quickly prototype changes use plasmoidviewer: 91 | 92 | ```bash 93 | plasmoidviewer --applet plasmoid 94 | ``` 95 | 96 | For better logging override QT's log format: 97 | 98 | ``` 99 | QT_MESSAGE_PATTERN="[%{type}] (%{function}:%{line}) - %{message}" plasmoidviewer --applet plasmoid 100 | ``` 101 | 102 | To see changes in plasmoidviewer has to be restarted, but there is no need to run make unless there are changes in the C++ plugin. 103 | -------------------------------------------------------------------------------- /src/i3pager.cpp: -------------------------------------------------------------------------------- 1 | /* -*- c++ -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | #include "i3pager.h" 7 | 8 | #include 9 | #include "i3pager_debug.h" 10 | #include "i3listener.h" 11 | #include 12 | #include 13 | 14 | 15 | I3Pager::I3Pager(QObject* parent) 16 | : QObject(parent) { 17 | currentScreenPrivate = QString(); 18 | mode = "default"; 19 | 20 | qCDebug(I3PAGER) << "Starting i3 listener"; 21 | this->i3ListenerThread = new I3ListenerThread(this); 22 | connect(i3ListenerThread, &I3ListenerThread::modeChanged, this, [=](const QString& mode) { 23 | this->mode = mode; 24 | Q_EMIT modeChanged(); 25 | }); 26 | connect(i3ListenerThread, &I3ListenerThread::workspacesChanged, this, [=]() { 27 | Q_EMIT workspacesChanged(); 28 | }); 29 | connect(i3ListenerThread, &I3ListenerThread::finished, i3ListenerThread, &QObject::deleteLater); 30 | i3ListenerThread->start(); 31 | qCDebug(I3PAGER) << "i3 listener started"; 32 | } 33 | 34 | I3Pager::~I3Pager() { 35 | qCDebug(I3PAGER) << "I3Pager destructor"; 36 | this->i3ListenerThread->stop(); 37 | this->i3ListenerThread->wait(); 38 | qCDebug(I3PAGER) << "I3Pager destructor done"; 39 | } 40 | 41 | QList I3Pager::getScreenNames() { 42 | QList screenList; 43 | try { 44 | i3ipc::connection conn; 45 | auto screens = conn.get_outputs(); 46 | 47 | for (auto& screen : screens) { 48 | if (screen->active) { 49 | screenList.append(QString::fromStdString(screen->name)); 50 | qCDebug(I3PAGER) << "Screen name:" << QString::fromStdString(screen->name); 51 | } 52 | } 53 | } catch (std::exception const& e) { 54 | qCWarning(I3PAGER) << "Exception while retrieving screen names: " << e.what(); 55 | } 56 | 57 | return screenList; 58 | } 59 | 60 | QList I3Pager::getWorkspaces(bool filterByCurrentScreen, QString orderWorkspacesBy, QList screenOrder) { 61 | QList workspaceList; 62 | try { 63 | i3ipc::connection conn; 64 | auto i3workspaceList = conn.get_workspaces(); 65 | qCDebug(I3PAGER) << "Loading workspaces:"; 66 | 67 | for (auto& i3workspace : i3workspaceList) { 68 | Workspace workspace; 69 | 70 | auto splitName = QString::fromStdString(i3workspace->name).split(':'); 71 | workspace.id = QString::fromStdString(i3workspace->name); 72 | workspace.index = splitName[0]; 73 | workspace.name = splitName.size() == 1 ? splitName[0] : splitName[1]; 74 | workspace.icon = splitName.size() == 3 ? splitName[2] : ""; 75 | 76 | workspace.output = QString::fromStdString(i3workspace->output); 77 | workspace.focused = i3workspace->focused; 78 | workspace.visible = i3workspace->visible; 79 | workspace.urgent = i3workspace->urgent; 80 | 81 | qCDebug(I3PAGER) << "i3Workspace name:" << QString::fromStdString(i3workspace->name); 82 | qCDebug(I3PAGER) << "Workspace:" 83 | << "id:" << workspace.id 84 | << "index:" << workspace.index 85 | << "name:" << workspace.name 86 | << "icon:" << workspace.icon 87 | << "focused:" << workspace.focused 88 | << "urgent:" << workspace.urgent 89 | << "visible:" << workspace.visible 90 | << "output:" << workspace.output; 91 | workspaceList.append(workspace); 92 | } 93 | } catch (std::exception const& e) { 94 | qCWarning(I3PAGER) << "Exception while retrieving workspaces:" << e.what(); 95 | } 96 | 97 | if (filterByCurrentScreen) { 98 | workspaceList = Workspace::filterByCurrentScreen(workspaceList, this->currentScreenPrivate); 99 | } 100 | 101 | if (orderWorkspacesBy == "screen" && !screenOrder.isEmpty()) { 102 | workspaceList = Workspace::orderByOutput(workspaceList, screenOrder); 103 | } 104 | else if (orderWorkspacesBy == "name") { 105 | workspaceList = Workspace::orderByName(workspaceList); 106 | } 107 | 108 | return workspaceList; 109 | } 110 | 111 | void I3Pager::activateWorkspace(QString workspace) { 112 | i3ipc::connection conn; 113 | conn.send_command("workspace " + workspace.toStdString()); 114 | } 115 | 116 | void I3Pager::setCurrentScreen(QString screen) { 117 | this->currentScreenPrivate = screen; 118 | Q_EMIT workspacesChanged(); 119 | } 120 | 121 | QString I3Pager::getMode() { 122 | return mode; 123 | } 124 | 125 | QString I3Pager::getCurrentScreen() { 126 | return this->currentScreenPrivate; 127 | } 128 | -------------------------------------------------------------------------------- /plasmoid/contents/ui/configGeneral.qml: -------------------------------------------------------------------------------- 1 | /* -*- qml -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | import QtQuick 2.15 7 | import QtQuick.Controls 8 | import QtQuick.Layouts 9 | import org.kde.kirigami as Kirigami 10 | import org.kde.kcmutils as KCM 11 | 12 | KCM.SimpleKCM { 13 | 14 | property alias cfg_showWorkspaceNames: showWorkspaceNames.checked 15 | property alias cfg_filterByCurrentScreen: filterByCurrentScreen.checked 16 | property alias cfg_urgentColorWholeWorkspace: urgentColorWholeWorkspace.checked 17 | property alias cfg_rounded: rounded.checked 18 | property var cfg_orderWorkspacesBy 19 | property var cfg_style 20 | property var cfg_styleDefault 21 | property var cfg_indicatorPosition 22 | property var cfg_colorWorkspaceByScreen 23 | property var cfg_colorWorkspaceByScreenDefault 24 | property var cfg_filterByCurrentScreenDefault 25 | property var cfg_indicatorPositionDefault 26 | property var cfg_orderWorkspacesByDefault 27 | property var cfg_roundedDefault 28 | property var cfg_screenColorList 29 | property var cfg_screenColorListDefault 30 | property var cfg_screenColorOpacity 31 | property var cfg_screenColorOpacityDefault 32 | property var cfg_screenNameList 33 | property var cfg_screenNameListDefault 34 | property var cfg_showWorkspaceNamesDefault 35 | property var cfg_urgentColorWholeWorkspaceDefault 36 | 37 | Kirigami.FormLayout { 38 | id: page 39 | 40 | ColumnLayout { 41 | Kirigami.FormData.label: i18n("Basic:") 42 | Kirigami.FormData.buddyFor: showWorkspaceNames 43 | 44 | CheckBox { 45 | id: showWorkspaceNames 46 | text: i18n("Show workspace names") 47 | checked: plasmoid.configuration.showWorkspaceNames 48 | onCheckedChanged: plasmoid.configuration.showWorkspaceNames = checked 49 | } 50 | 51 | CheckBox { 52 | id: filterByCurrentScreen 53 | text: i18n("Filter workspaces by current screen") 54 | checked: plasmoid.configuration.filterByCurrentScreen 55 | onCheckedChanged: plasmoid.configuration.filterByCurrentScreen = checked 56 | } 57 | 58 | CheckBox { 59 | id: urgentColorWholeWorkspace 60 | text: i18n("Color the whole workspace if urgent") 61 | checked: plasmoid.configuration.urgentColorWholeWorkspace 62 | onCheckedChanged: plasmoid.configuration.urgentColorWholeWorkspace = checked 63 | } 64 | 65 | CheckBox { 66 | id: rounded 67 | text: i18n("Rounded corners") 68 | checked: plasmoid.configuration.rounded 69 | onCheckedChanged: plasmoid.configuration.rounded = checked 70 | } 71 | } 72 | 73 | Item { 74 | Kirigami.FormData.isSection: true 75 | } 76 | 77 | ColumnLayout { 78 | Kirigami.FormData.label: i18n("Order workspaces by:") 79 | Kirigami.FormData.buddyFor: orderWorkspacesByDefaultRadio 80 | 81 | RadioButton { 82 | id: orderWorkspacesByDefaultRadio 83 | text: i18n("Default") 84 | checked: cfg_orderWorkspacesBy == "default" 85 | onClicked: { 86 | cfg_orderWorkspacesBy = "default" 87 | } 88 | } 89 | 90 | RadioButton { 91 | id: orderWorkspacesByScreenRadio 92 | text: i18n("Screen") 93 | checked: cfg_orderWorkspacesBy == "screen" 94 | onClicked: { 95 | cfg_orderWorkspacesBy = "screen" 96 | } 97 | } 98 | 99 | RadioButton { 100 | id: orderWorkspacesByName 101 | text: i18n("Name") 102 | checked: cfg_orderWorkspacesBy == "name" 103 | onClicked: { 104 | cfg_orderWorkspacesBy = "name" 105 | } 106 | } 107 | } 108 | 109 | Item { 110 | Kirigami.FormData.isSection: true 111 | } 112 | 113 | ColumnLayout { 114 | Kirigami.FormData.label: i18n("Indicator style:") 115 | Kirigami.FormData.buddyFor: styleUnderlineRadio 116 | 117 | RadioButton { 118 | id: styleUnderlineRadio 119 | text: i18n("Line") 120 | checked: cfg_style == "line" 121 | onClicked: { 122 | cfg_style = "line" 123 | } 124 | } 125 | 126 | RadioButton { 127 | id: styleBorderRadio 128 | text: i18n("Border") 129 | checked: cfg_style == "border" 130 | onClicked: { 131 | cfg_style = "border" 132 | } 133 | } 134 | } 135 | 136 | Item { 137 | Kirigami.FormData.isSection: true 138 | } 139 | 140 | ColumnLayout { 141 | Kirigami.FormData.label: i18n("Indicator position:") 142 | Kirigami.FormData.buddyFor: indicatorPositionTopRadio 143 | visible: cfg_style == "line" 144 | 145 | RadioButton { 146 | id: indicatorPositionTopRadio 147 | text: i18n("Top") 148 | checked: cfg_indicatorPosition == "top" 149 | onClicked: { 150 | cfg_indicatorPosition = "top" 151 | } 152 | } 153 | 154 | RadioButton { 155 | id: indicatorPositionBottomRadio 156 | text: i18n("Bottom") 157 | checked: cfg_indicatorPosition == "bottom" 158 | onClicked: { 159 | cfg_indicatorPosition = "bottom" 160 | } 161 | } 162 | } 163 | } 164 | } 165 | -------------------------------------------------------------------------------- /plasmoid/contents/ui/configScreens.qml: -------------------------------------------------------------------------------- 1 | /* -*- qml -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | import QtQuick 2.15 7 | import QtQuick.Controls as QQC2 8 | import QtQuick.Dialogs 9 | import QtQuick.Layouts 1.3 10 | 11 | import org.kde.plasma.plasmoid 2.0 12 | import org.kde.kquickcontrols 2.0 as KQC 13 | import org.kde.kirigami 2.10 as Kirigami 14 | import org.kde.kitemmodels 1.0 15 | import org.kde.kcmutils as KCM 16 | 17 | import org.kde.private.I3Pager 18 | import "screens.js" as ScreensJS 19 | 20 | KCM.ScrollViewKCM { 21 | 22 | property var cfg_screenNameList 23 | property var cfg_screenColorList 24 | property var cfg_screenColorOpacity 25 | property alias cfg_colorWorkspaceByScreen: colorWorkspaceByScreen.checked 26 | property var cfg_orderWorkspacesBy 27 | property var cfg_style 28 | property var cfg_styleDefault 29 | property var cfg_indicatorPosition 30 | property var cfg_colorWorkspaceByScreenDefault 31 | property var cfg_filterByCurrentScreenDefault 32 | property var cfg_indicatorPositionDefault 33 | property var cfg_orderWorkspacesByDefault 34 | property var cfg_roundedDefault 35 | property var cfg_screenColorListDefault 36 | property var cfg_filterByCurrentScreen 37 | property var cfg_showWorkspaceNamesDefault 38 | property var cfg_urgentColorWholeWorkspaceDefault 39 | property var cfg_urgentColorWholeWorkspace 40 | property var cfg_rounded 41 | property var cfg_screenColorOpacityDefault 42 | property var cfg_screenNameListDefault 43 | property var cfg_showWorkspaceNames 44 | 45 | id: page 46 | Layout.fillWidth: true 47 | 48 | I3Pager { 49 | id: i3pager 50 | } 51 | 52 | header: Kirigami.FormLayout { 53 | QQC2.CheckBox { 54 | Kirigami.FormData.label: i18n("Color workspaces by screen:") 55 | 56 | id: colorWorkspaceByScreen 57 | checked: plasmoid.configuration.colorWorkspaceByScreen 58 | onCheckedChanged: plasmoid.configuration.colorWorkspaceByScreen = checked 59 | } 60 | 61 | RowLayout { 62 | Kirigami.FormData.label: i18n("Workspace color opacity:") 63 | 64 | QQC2.Slider { 65 | id: screenColorOpacity 66 | from: 0 67 | to: 1 68 | stepSize: 0.05 69 | snapMode: QQC2.Slider.SnapAlways 70 | value: cfg_screenColorOpacity 71 | onMoved: { 72 | cfg_screenColorOpacity = value; 73 | ScreensJS.saveConfig(); 74 | } 75 | } 76 | 77 | QQC2.SpinBox { 78 | from: 0 79 | to: 100 80 | stepSize: 5 81 | value: cfg_screenColorOpacity * 100 82 | onValueModified: { 83 | cfg_screenColorOpacity = value / 100; 84 | ScreensJS.saveConfig(); 85 | } 86 | } 87 | } 88 | } 89 | 90 | view: ListView { 91 | id: screensListView 92 | clip: true 93 | 94 | property real colorColumnWidth: Kirigami.Units.gridUnit 95 | property real actionsColumnWidth: Kirigami.Units.gridUnit 96 | 97 | Component.onCompleted: { 98 | ScreensJS.loadConfig(); 99 | ScreensJS.loadNewScreens(); 100 | ScreensJS.saveConfig(); 101 | } 102 | 103 | model: ListModel { 104 | id: screenListModel 105 | dynamicRoles: true 106 | } 107 | reuseItems: true 108 | 109 | header: RowLayout { 110 | width: screensListView.width 111 | spacing: Kirigami.Units.smallSpacing 112 | 113 | Kirigami.Heading { 114 | text: i18n("Name") 115 | textFormat: Text.PlainText 116 | level: 2 117 | Layout.fillWidth: true 118 | } 119 | Kirigami.Heading { 120 | text: i18n("Color") 121 | textFormat: Text.PlainText 122 | level: 2 123 | Layout.preferredWidth: screensListView.colorColumnWidth 124 | Component.onCompleted: screensListView.colorColumnWidth = Math.max(implicitWidth, screensListView.colorColumnWidth) 125 | } 126 | Kirigami.Heading { 127 | text: i18n("Actions") 128 | level: 2 129 | Layout.preferredWidth: screensListView.actionsColumnWidth 130 | Component.onCompleted: screensListView.actionsColumnWidth = Math.max(implicitWidth, screensListView.actionsColumnWidth) 131 | } 132 | } 133 | 134 | delegate: QQC2.ItemDelegate { 135 | highlighted: false 136 | hoverEnabled: false 137 | down: false 138 | width: screensListView.width 139 | 140 | contentItem: FocusScope { 141 | implicitHeight: childrenRect.height 142 | 143 | RowLayout { 144 | width: parent.width 145 | spacing: Kirigami.Units.smallSpacing 146 | 147 | QQC2.Label { 148 | Layout.fillWidth: true 149 | text: screenName 150 | } 151 | 152 | MouseArea { 153 | hoverEnabled: true 154 | cursorShape: Qt.PointingHandCursor 155 | Layout.fillHeight: true 156 | Layout.minimumWidth: screensListView.colorColumnWidth 157 | Layout.preferredWidth: screensListView.colorColumnWidth 158 | Component.onCompleted: screensListView.colorColumnWidth = Math.max(implicitWidth, screensListView.colorColumnWidth) 159 | 160 | onClicked: { 161 | colorDialog.selectedColor = screenColor; 162 | colorDialog.open(); 163 | } 164 | 165 | Rectangle { 166 | id: colorRectangle 167 | width: parent.width 168 | height: parent.height 169 | color: screenColor 170 | } 171 | 172 | ColorDialog { 173 | id: colorDialog 174 | title: "Please choose a screen color" 175 | onAccepted: { 176 | screenListModel.set(index, { 177 | screenName: screenName, 178 | screenColor: colorDialog.selectedColor 179 | }); 180 | ScreensJS.saveConfig(); 181 | } 182 | } 183 | } 184 | 185 | RowLayout { 186 | Layout.minimumWidth: screensListView.actionsColumnWidth 187 | Layout.preferredWidth: screensListView.actionsColumnWidth 188 | Component.onCompleted: screensListView.actionsColumnWidth = Math.max(implicitWidth, screensListView.actionsColumnWidth) 189 | 190 | QQC2.Button { 191 | enabled: index != 0 192 | icon.name: "arrow-up" 193 | onClicked: { 194 | screenListModel.move(index, index - 1, 1); 195 | ScreensJS.saveConfig(); 196 | } 197 | } 198 | QQC2.Button { 199 | enabled: index != (screenListModel.count - 1) 200 | icon.name: "arrow-down" 201 | 202 | onClicked: { 203 | screenListModel.move(index, index + 1, 1); 204 | ScreensJS.saveConfig(); 205 | } 206 | } 207 | } 208 | } 209 | } 210 | } 211 | } 212 | } 213 | -------------------------------------------------------------------------------- /plasmoid/contents/ui/main.qml: -------------------------------------------------------------------------------- 1 | /* -*- qml -*- 2 | * SPDX-License-Identifier: GPL-3.0-or-later 3 | * 4 | */ 5 | 6 | import QtQuick 2.15 7 | import QtQuick.Layouts 8 | import QtQuick.Controls 9 | import QtQuick.Dialogs 10 | import QtQuick.Window 11 | import org.kde.plasma.plasmoid 12 | import org.kde.kirigami as Kirigami 13 | import org.kde.private.I3Pager 14 | 15 | 16 | PlasmoidItem { 17 | id: root 18 | readonly property color defaultWorkspace: "transparent" 19 | readonly property color focusedWorkspace: Kirigami.Theme.positiveTextColor 20 | readonly property color visibleWorkspace: Kirigami.Theme.neutralTextColor 21 | readonly property color urgentWorkspace: Kirigami.Theme.negativeTextColor 22 | readonly property color mouseWorkspace: Kirigami.Theme.linkColor 23 | 24 | preferredRepresentation: fullRepresentation 25 | 26 | Layout.minimumWidth: workspaceRow.implicitWidth + Kirigami.Units.smallSpacing 27 | 28 | ColumnLayout { 29 | id: rootColumnLayout 30 | 31 | I3Pager { 32 | id: i3pager 33 | currentScreen: Screen.name 34 | onWorkspacesChanged: { 35 | updateWorkspaces(); 36 | } 37 | function updateWorkspaces() { 38 | var screenNameList = [] 39 | for (var screenName of plasmoid.configuration.screenNameList) { 40 | screenNameList.push(screenName); 41 | } 42 | repeater.model = i3pager.getWorkspaces(plasmoid.configuration.filterByCurrentScreen, plasmoid.configuration.orderWorkspacesBy, screenNameList); 43 | } 44 | } 45 | 46 | Connections { 47 | target: plasmoid.configuration 48 | function onFilterByCurrentScreenChanged() { 49 | i3pager.updateWorkspaces(); 50 | } 51 | function onOrderWorkspacesByChanged() { 52 | i3pager.updateWorkspaces(); 53 | } 54 | function onScreenNameListChanged() { 55 | i3pager.updateWorkspaces(); 56 | } 57 | function onIndicatorPositionChanged() { 58 | i3pager.updateWorkspaces(); 59 | } 60 | } 61 | 62 | // Hack to update current screen 63 | Screen.onNameChanged: { 64 | i3pager.currentScreen = Screen.name 65 | } 66 | 67 | Row { 68 | id: workspaceRow 69 | Layout.alignment: Layout.AlignVCenter | Layout.AlignHCenter 70 | spacing: 2 71 | 72 | Repeater { 73 | id: repeater 74 | 75 | MouseArea { 76 | id: mouseArea 77 | hoverEnabled: true 78 | cursorShape: Qt.PointingHandCursor 79 | onClicked: { 80 | i3pager.activateWorkspace(modelData.id) 81 | } 82 | width: textRow.width 83 | height: root.height 84 | function getIndicatorColor() { 85 | if (mouseArea.containsMouse) { 86 | return mouseWorkspace; 87 | } else if (modelData.urgent && !plasmoid.configuration.urgentColorWholeWorkspace) { 88 | return urgentWorkspace; 89 | } else if (modelData.focused) { 90 | return focusedWorkspace; 91 | } else if (modelData.visible) { 92 | return visibleWorkspace; 93 | } 94 | return defaultWorkspace; 95 | } 96 | function getFillColor() { 97 | if (modelData.urgent && plasmoid.configuration.urgentColorWholeWorkspace) { 98 | return urgentWorkspace; 99 | } else if (!plasmoid.configuration.colorWorkspaceByScreen) { 100 | return "transparent"; 101 | } 102 | var indexOfScreen = plasmoid.configuration.screenNameList.indexOf(modelData.output); 103 | var screenColor = plasmoid.configuration.screenColorList[indexOfScreen]; 104 | return screenColor; 105 | } 106 | function getRadius() { 107 | return plasmoid.configuration.rounded ? 3: 0; 108 | } 109 | 110 | Rectangle { // Border style 111 | visible: plasmoid.configuration.style === "border" 112 | color: mouseArea.getFillColor() 113 | radius: getRadius() 114 | height: textRow.height 115 | width: textRow.width 116 | border { 117 | width: 2 118 | color: mouseArea.getIndicatorColor() 119 | } 120 | } 121 | 122 | Rectangle { // Underline style 123 | visible: plasmoid.configuration.style === "line" 124 | color: mouseArea.getFillColor() 125 | radius: getRadius() 126 | height: textRow.height 127 | width: textRow.width 128 | 129 | Rectangle { 130 | Component.onCompleted: { 131 | if (plasmoid.configuration.indicatorPosition === "top") { 132 | anchors.top = parent.top; 133 | } else { 134 | anchors.bottom = parent.bottom; 135 | } 136 | } 137 | 138 | height: 5 139 | width: textRow.width 140 | radius: getRadius() 141 | color: mouseArea.getIndicatorColor() 142 | } 143 | } 144 | 145 | RowLayout { 146 | id: textRow 147 | height: parent.height 148 | 149 | Rectangle { 150 | width: 5 151 | } 152 | Text { 153 | font.family: Kirigami.Theme.defaultFont.family 154 | height: textRow.height 155 | minimumPixelSize: Kirigami.Theme.smallFont.pixelSize 156 | font.pixelSize: Math.min(textRow.height * 0.5, 1.5 * Kirigami.Theme.defaultFont.pixelSize) 157 | fontSizeMode: Text.VerticalFit 158 | color: Kirigami.Theme.textColor 159 | text: modelData.index 160 | verticalAlignment: Text.AlignHCenter 161 | } 162 | Label { 163 | id: icon 164 | rightPadding: 3 165 | leftPadding: 3 166 | bottomPadding: 0 167 | height: textRow.height 168 | minimumPixelSize: Kirigami.Theme.smallFont.pixelSize 169 | font.pixelSize: Math.min(textRow.height * 0.5, 1.5 * Kirigami.Theme.defaultFont.pixelSize) 170 | fontSizeMode: Text.VerticalFit 171 | font.family: "Font Awesome" 172 | font.styleName: "Solid" 173 | color: Kirigami.Theme.textColor 174 | text: modelData.icon 175 | verticalAlignment: Text.AlignHCenter 176 | visible: plasmoid.configuration.showWorkspaceNames 177 | } 178 | Text { 179 | height: textRow.height 180 | minimumPixelSize: Kirigami.Theme.smallFont.pixelSize 181 | font.pixelSize: Math.min(textRow.height * 0.5, 1.5 * Kirigami.Theme.defaultFont.pixelSize) 182 | fontSizeMode: Text.VerticalFit 183 | font.family: Kirigami.Theme.defaultFont.family 184 | color: Kirigami.Theme.textColor 185 | text: modelData.name 186 | verticalAlignment: Text.AlignHCenter 187 | visible: plasmoid.configuration.showWorkspaceNames 188 | } 189 | Rectangle { 190 | width: 5 191 | } 192 | } 193 | } 194 | } 195 | Item { 196 | width: modeText.width 197 | height: modeText.height 198 | anchors.verticalCenter: parent.verticalCenter 199 | visible: i3pager.mode !== "default" 200 | Rectangle { 201 | color: "#e5c07b" 202 | height: parent.height 203 | width: parent.width 204 | } 205 | Text { 206 | id: modeText 207 | rightPadding: 10 208 | leftPadding: 10 209 | minimumPixelSize: Kirigami.Theme.smallFont.pixelSize 210 | font.pixelSize: Math.min(root.height * 0.5, 1.5 * Kirigami.Theme.defaultFont.pixelSize) 211 | fontSizeMode: Text.VerticalFit 212 | font.family: Kirigami.Theme.defaultFont.family 213 | color: "#333333" 214 | text: i3pager.mode 215 | } 216 | } 217 | } 218 | } 219 | } 220 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------