├── makefile
├── README.md
├── metadata.desktop
└── contents
    ├── config
        └── main.xml
    ├── code
        └── kwin-desktop-pin.js
    └── ui
        └── config.ui


/makefile:
--------------------------------------------------------------------------------
 1 | install:
 2 | 	plasmapkg2 --type kwinscript -i .
 3 | 	mkdir -p ~/.local/share/kservices5
 4 | 	ln -sf ~/.local/share/kwin/scripts/desktop-pin/metadata.desktop ~/.local/share/kservices5/kwin-script-desktop-pin.desktop
 5 | 
 6 | uninstall:
 7 | 	plasmapkg2 --type kwinscript -r desktop-pin
 8 | 	rm ~/.local/share/kservices5/kwin-script-desktop-pin.desktop
 9 | 
10 | debug:
11 | 	QT_LOGGING_RULES="kwin_*.debug=true" kwin --replace && tail -f ~/.xsession-errors


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ### desktop pin
 2 | 
 3 | kwin script for making windows inside/outside a specified area pin to all desktops
 4 | 
 5 | i pretty much just use this to make the desktops act like gnome, where only the primary monitor switches
 6 | 
 7 | `make install`: install the plugin
 8 | 
 9 | `make uninstall`: uninstall the plugin
10 | 
11 | `make debug`: replace kwin with debug logging enabled and tail the log (you need to re-run kwin --replace from krunner after using this)


--------------------------------------------------------------------------------
/metadata.desktop:
--------------------------------------------------------------------------------
 1 | [Desktop Entry]
 2 | Name=Desktop Pin
 3 | Comment=Pin monitors inside/outside a defined area to all desktops
 4 | Icon=preferences-system-windows-script-test
 5 | 
 6 | X-Plasma-API=javascript
 7 | X-Plasma-MainScript=code/kwin-desktop-pin.js
 8 | 
 9 | X-KDE-PluginInfo-Name=desktop-pin
10 | X-KDE-PluginInfo-Version=0.0.1
11 | X-KDE-PluginInfo-Author=Leigh Oliver
12 | X-KDE-PluginInfo-Website=github.com/leigholiver/kwin-desktop-pin
13 | X-KDE-PluginInfo-Email=leigholiver@users.noreply.github.com
14 | X-KDE-PluginInfo-Depends=
15 | X-KDE-PluginInfo-License=GPL
16 | X-KDE-ServiceTypes=KWin/Script,KCModule
17 | 
18 | X-KDE-Library=kwin/effects/configs/kcm_kwin4_genericscripted
19 | X-KDE-PluginKeyword=desktop-pin
20 | X-KDE-ParentComponents=desktop-pin
21 | 
22 | Type=Service
23 | 


--------------------------------------------------------------------------------
/contents/config/main.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <kcfg xmlns="http://www.kde.org/standards/kcfg/1.0"
 3 |       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4 |       xsi:schemaLocation="http://www.kde.org/standards/kcfg/1.0
 5 |       http://www.kde.org/standards/kcfg/1.0/kcfg.xsd" >
 6 |     <kcfgfile name=""/>
 7 |     <group name="">
 8 |         <entry name="x" type="int">
 9 |           <label>Area X Pos</label>
10 |           <default>0</default>
11 |         </entry>
12 |         <entry name="y" type="int">
13 |           <label>Area Y Pos</label>
14 |           <default>0</default>
15 |         </entry>
16 |         <entry name="width" type="int">
17 |           <label>Area Width</label>
18 |           <default>1920</default>
19 |         </entry>
20 |         <entry name="height" type="int">
21 |           <label>Area Height</label>
22 |           <default>1080</default>
23 |         </entry>
24 |         <entry name="pinmode" type="bool">
25 |           <label>Pin Mode</label>
26 |         </entry>
27 |         <entry name="excludes" type="string">
28 |           <label>Window captions to ignore</label>
29 |         </entry>
30 |     </group>
31 | </kcfg>
32 | 


--------------------------------------------------------------------------------
/contents/code/kwin-desktop-pin.js:
--------------------------------------------------------------------------------
 1 | var excludes = readConfig("excludes", "");
 2 | var config = {
 3 |     // defines the area
 4 |     x: readConfig("x", 0),
 5 |     y: readConfig("y", 0),
 6 |     width: readConfig("width", 1920),
 7 |     height: readConfig("height", 1080),
 8 |     
 9 |     // if false, any windows outside the area will stick
10 |     // if true, any windows inside the area will stick
11 |     include: readConfig("pinmode", false),
12 | 
13 | // list of clients to exclude
14 |     excludes: [
15 |           "Desktop — Plasma",
16 |           "Latte Shell — Latte Dock",
17 |           "Latte Dock"
18 |     ].concat((excludes == "" ? [] : ("" + excludes).split("\n")))
19 | };
20 | startDesktopPin();
21 | 
22 | function calcPins(client) {
23 |     if (clientIsExcluded(client)) return
24 | 
25 |     var midPointX = client.geometry.x + (client.geometry.width / 2);
26 |     var midPointY = client.geometry.y + (client.geometry.height/ 2);
27 |     var isInArea = (midPointX >= config.x && midPointX <= config.x + config.width) && (midPointY >= config.y && midPointY <= config.y + config.height);
28 |     client.onAllDesktops = (config.include == isInArea);
29 |     print(client.caption + " in area?: " + isInArea + " setting on all desktops to: " + client.onAllDesktops);
30 | }
31 | 
32 | function startDesktopPin() {   
33 |     var clients = workspace.clientList();
34 |     for (var i = clients.length; i > 0; i--) {
35 |         onClientAdded(clients[i]);
36 |     }
37 |     workspace.clientAdded.connect(onClientAdded);
38 |     workspace.clientRemoved.connect(onClientRemoved);
39 | }
40 | 
41 | function onClientMoved(client) {
42 |     if (typeof client === 'undefined') {
43 |         return;
44 |     }
45 |     calcPins(client);
46 | }
47 | 
48 | function onClientAdded(client) {
49 |     if (typeof client === 'undefined') {
50 |         return;
51 |     }
52 |     client.clientFinishUserMovedResized.connect(onClientMoved);
53 |     calcPins(client);
54 | }
55 | 
56 | function onClientRemoved(client) {
57 |     if (typeof client === 'undefined') {
58 |         return;
59 |     }
60 |     client.clientFinishUserMovedResized.disconnect(onClientMoved);
61 | }
62 | 
63 | function clientIsExcluded(client) {
64 |     for(var i=0; i<config.excludes.length; i++) {        
65 |         var result = client.caption.match(new RegExp(config.excludes[i])) != null;
66 |         if (result) {
67 |             print(client.caption + " is in our exclude list, skipping");
68 |             return result;
69 |         }
70 |     }
71 |     return false;
72 | }


--------------------------------------------------------------------------------
/contents/ui/config.ui:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <ui version="4.0">
  3 |  <class>KWin::DesktopPinConfigForm</class>
  4 |  <widget class="QWidget" name="KWin::DesktopPinConfigForm">
  5 |   <property name="geometry">
  6 |    <rect>
  7 |     <x>0</x>
  8 |     <y>0</y>
  9 |     <width>263</width>
 10 |     <height>285</height>
 11 |    </rect>
 12 |   </property>
 13 |   <property name="windowTitle">
 14 |    <string>Form</string>
 15 |   </property>
 16 |   <layout class="QHBoxLayout" name="horizontalLayout_5">
 17 |    <item>
 18 |     <layout class="QVBoxLayout" name="verticalLayout">
 19 |      <item>
 20 |       <layout class="QHBoxLayout" name="horizontalLayout">
 21 |        <item>
 22 |         <widget class="QLabel" name="label">
 23 |          <property name="text">
 24 |           <string>Area X Pos</string>
 25 |          </property>
 26 |         </widget>
 27 |        </item>
 28 |        <item>
 29 |         <widget class="QSpinBox" name="kcfg_x">
 30 |          <property name="value">
 31 |           <number>0</number>
 32 |          </property>
 33 |           <property name="minimum">
 34 |           <number>0</number>
 35 |          </property>
 36 |          <property name="maximum">
 37 |           <number>9999</number>
 38 |          </property>
 39 |         </widget>
 40 |        </item>
 41 |       </layout>
 42 |      </item>
 43 |      <item>
 44 |       <layout class="QHBoxLayout" name="horizontalLayout_3">
 45 |        <item>
 46 |         <widget class="QLabel" name="label_3">
 47 |          <property name="text">
 48 |           <string>Area Y Pos</string>
 49 |          </property>
 50 |         </widget>
 51 |        </item>
 52 |        <item>
 53 |         <widget class="QSpinBox" name="kcfg_y">
 54 |          <property name="value">
 55 |           <number>0</number>
 56 |          </property>
 57 |         <property name="minimum">
 58 |           <number>0</number>
 59 |          </property>
 60 |          <property name="maximum">
 61 |           <number>9999</number>
 62 |          </property>
 63 |         </widget>
 64 |        </item>
 65 |       </layout>
 66 |      </item>
 67 |      <item>
 68 |       <layout class="QHBoxLayout" name="horizontalLayout_4">
 69 |        <item>
 70 |         <widget class="QLabel" name="label_4">
 71 |          <property name="text">
 72 |           <string>Area Width</string>
 73 |          </property>
 74 |         </widget>
 75 |        </item>
 76 |        <item>
 77 |         <widget class="QSpinBox" name="kcfg_width">
 78 |          <property name="value">
 79 |           <number>1920</number>
 80 |          </property>
 81 |           <property name="minimum">
 82 |           <number>0</number>
 83 |          </property>
 84 |          <property name="maximum">
 85 |           <number>9999</number>
 86 |          </property>
 87 |         </widget>
 88 |        </item>
 89 |       </layout>
 90 |      </item>
 91 |      
 92 |      <item>
 93 |       <layout class="QHBoxLayout" name="horizontalLayout_5">
 94 |        <item>
 95 |         <widget class="QLabel" name="label_5">
 96 |          <property name="text">
 97 |           <string>Area Height</string>
 98 |          </property>
 99 |         </widget>
100 |        </item>
101 |        <item>
102 |         <widget class="QSpinBox" name="kcfg_height">
103 |          <property name="value">
104 |           <number>1080</number>
105 |          </property>
106 |         <property name="minimum">
107 |           <number>0</number>
108 |          </property>
109 |          <property name="maximum">
110 |           <number>9999</number>
111 |          </property>
112 |         </widget>
113 |        </item>
114 |       </layout>
115 |      </item>
116 |     <item>
117 |       <layout class="QHBoxLayout" name="horizontalLayout_6">
118 |        <item>
119 |         <widget class="QLabel" name="label_6">
120 |          <property name="text">
121 |           <string>Pin Windows</string>
122 |          </property>
123 |         </widget>
124 |        </item>
125 |        <item>
126 |         <widget class="QComboBox" name="kcfg_pinmode">
127 |          <item>
128 |           <property name="text">
129 |            <string>Outside</string>
130 |           </property>
131 |          </item>
132 |          <item>
133 |           <property name="text">
134 |            <string>Inside</string>
135 |           </property>
136 |          </item>
137 |         </widget>
138 |        </item>
139 |       </layout>
140 |      </item>
141 |      <item>
142 |         <layout class="QHBoxLayout" name="horizontalLayout_7">
143 |          <item>
144 |           <widget class="QLabel" name="label_7">
145 |            <property name="text">
146 |             <string>Window captions to exclude (each caption on a new line, regex supported)</string>
147 |            </property>
148 |           </widget>
149 |          </item>
150 |          <item>
151 |           <widget class="QPlainTextEdit" name="kcfg_excludes"></widget>
152 |          </item>
153 |         </layout>
154 |        </item>
155 |     </layout>
156 |    </item>
157 |   </layout>
158 |  </widget>
159 |  <resources/>
160 |  <connections/>
161 | </ui>


--------------------------------------------------------------------------------