summaryrefslogtreecommitdiffstats
path: root/extra/readme-theme_format
blob: df808541053ee3e2f12ebbd658a837a2d63d84a6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
deKorator Theming
=================

 ┌─────┬───────────────────────┬─────┐
 │  1  │           2           │  3  │
 ├──┬──┴┬───┬─────────────┬───┬┴──┬──┤
 │ 4│ 5 │ 6 │      7      │ 8 │ 9 │10│
 ├──┼───┴───┴─────────────┴───┴───┼──┤
 │11│                             │14│
 ├──┤                             ├──┤
 │  │                             │  │
 │12│        Window Content       │15│
 │  │                             │  │
 ├──┤                             ├──┤
 │13│                             │16│
 ├──┴──┬───────────────────────┬──┴──┤
 │  17 │           18          │  19 │
 └─────┴───────────────────────┴─────┘


Border Parts
============

 1: topLeftFrameBg            - Top border, left corner / resize handle
 2: topMidFrameBg             - Top border, middle part (tiled to fill)
 3: topRightFrameBg           - Top border, right corner / resize handle

 4: leftUpperCornerFrameBg    - Left upper corner / resize handle
 5: buttonsLeftBg             - Titlebar part, behind left-side buttons
 6: titleLeftBg               - Titlebar part, separating buttons from middle
 7: titleMidBg                - Titlebar, middle part (tiled to fill)
 8: titleBarRightBg           - Titlebar part, separating buttons from middle
 9: buttonsRightBg            - Titlebar part, behind right-side buttons
10: rightUpperCornerFrameBg   - Right upper corner / resize handle

11: leftUpperFrameBg          - Left border, upper part
12: leftMidFrameBg            - Left border, middle part (tiled to fill)
13: leftLowerCornerFrameBg    - Left border, lower corner / resize handle

14: rightUpperFrameBg         - Right border, upper part
15: rightMidFrameBg           - Right border, middle part (tiled to fill)
16: rightLowerCornerFrameBg   - Right border, lower corner / resize handle

17: bottomLeftFrameBg         - Bottom border, left corner / resize handle
18: bottomMidFrameBg          - Bottom border, middle part (tiled to fill)
19: bottomRightFrameBg        - Bottom border, right corner / resize handle

Optional (shaded windows):
17: bottomShadedLeftFrameBg   - Bottom border, left corner / resize handle
18: bottomShadedMidFrameBg    - Bottom border, middle part (tiled to fill)
19: bottomShadedRightFrameBg  - Bottom border, right corner / resize handle


Element Names
-------------

- All border parts are expected in the `/deco` subfolder.
- Image names can be found in the list above, or the listing below.


Inactive Window Frames
----------------------

- Filenames of all border images end with `Bg`.
- If additional files ending in `InactiveBg` are found:
  - They are used for inactive windows.
  - Fully optional and looked up in a granular fashion
  - Only providing inactive images for selective parts of the frame, or none at all is valid.


Window Frame Structure
----------------------

deKorator frames are composed of:

- Frame parts of top, left, right and bottom borders
- Titlebar parts


Border Parts Details
--------------------

Horizontal
~~~~~~~~~~

 ┌──────────────────┬───────────────────────────────┬───────────────────┐
 │ topLeft          │             topMid            │          topRight │
 └──────────────────┴───────────────────────────────┴───────────────────┘ 
 ┌──────────────────┬───────────────────────────────┬───────────────────┐
 │ bottomLeft       │            bottomMid          │       bottomRight │
 └──────────────────┴───────────────────────────────┴───────────────────┘ 
 ┌──────────────────┬───────────────────────────────┬───────────────────┐
 │ bottomShadedLeft │        bottomShadedMid        │ bottomShadedRight │
 └──────────────────┴───────────────────────────────┴───────────────────┘

Notes:
- Top/bottom borders are at the respective window edges.
- *Left and *Right parts form corners, allow diagonal resizing.
- *Mid parts are tiled to fill the remaining width, for vertical resizing.
- Optional: Top border can be omitted.
  - In this case, the theme uses:
    - Top 5 pixels of titlebar for resizing.
    - Bottom border width for diagonal resizing.
- Optional: BottomShaded border (for shaded windows).
  - Is only shown when drawing borders on shaded windows is enabled in settings.
  - If not found, normal bottom border is used.


Vertical
~~~~~~~~

 ┌──────┐ ┌──────┐
 │ left-│ │right-│
 │Upper-│ │Upper-│
 │Corner│ │Corner│
 ├──────┤ ├──────┤
 │ left-│ │right-│
 │ Upper│ │ Upper│
 ├──────┤ ├──────┤
 │      │ │      │
 │ left-│ │right-│
 │  Mid │ │  Mid │
 │      │ │      │
 ├──────┤ ├──────┤
 │left- │ │right-│
 │Lower-│ │Lower-│
 │Corner│ │Corner│
 └──────┘ └──────┘

Notes:
- Side borders are stacked vertically between titlebar and bottom border.
- [left|light]Upper parts are just below the titlebar.
- [left|light]Mid parts are tiled to fill remaining space.
- [left|light]LowerCorner parts form bottom corners.


Titlebar
~~~~~~~~

 ┌───────────────┬───────────┬────────────┬─────────────┬─────────────┬────────────┬────────────────┐
 │leftUpperCorner│buttonsLeft│titleBarLeft│ titleBarMid │titleBarRight│buttonsRight│rightUpperCorner│
 └───────────────┴───────────┴────────────┴─────────────┴─────────────┴────────────┴────────────────┘

Notes:
- Titlebar is a strip of seven elements.
- [left|light]UpperCorner parts:
  - Form sides of the titlebar.
  - Side parts top corners, allow diagonal resizing.
- buttons[left|light] parts:
  - Tile behind titlebar buttons (if present).
- titleBarMid:
  - Tiled to fill the titlebar center.
  - titleBar[left|light] at the left and right.


Masks
~~~~~

 ┌──────────────────────────────┬─────────────────────────┬───────────────────────────────┐
 │ topLeftCornerBitmap          │      topMidBitMap       │          topRightCornerBitmap │
 └──────────────────────────────┴─────────────────────────┴───────────────────────────────┘
 ┌──────────────────────────────┬─────────────────────────┬───────────────────────────────┐
 │ buttomLeftCornerBitmap       │     buttomMidBitmap     │       buttomRightCornerBitmap │
 └──────────────────────────────┴─────────────────────────┴───────────────────────────────┘ 
 ┌──────────────────────────────┬─────────────────────────┬───────────────────────────────┐
 │ buttomLeftShadedCornerBitmap │ buttomShadedMidBitmap   │ buttomShadedRightCornerBitmap │
 └──────────────────────────────┴─────────────────────────┴───────────────────────────────┘ 

Notes:
- Masks are optional images in black and white, used to determine transparent parts of the frame, if enabled in settings.
  - Black pixels are transparent parts of the frame.



Buttons
=======

Functions:
----------

- buttonAbove:          Enable "Keep on top"
- buttonAboveDown:      Disable "Keep on top"
- buttonBelow:          Enable "Keep below"
- buttonBelowDown:      Disable "Keep below"
- buttonClose:          Close window
- buttonHelp:           Open help (if available)
- buttonMax:            Maximize window
- buttonMenu:           Show window menu (or icon if menu disabled)
- buttonMin:            Iconify window
- buttonRestore:        Unmaximize window
- buttonShade:          Shade (roll into titlebar)
- buttonShadeDown:      Unshade (roll out of titlebar)
- buttonSticky:         Show on all virtual desktops
- buttonStickyDown:     Disable "Show on all desktops"


Image files:
------------

Normal buttons:
  /buttons/normal/[buttonName].png

Hover (mouse over):
  /buttons/hover/[buttonName]Hover.png

Pressed:
  /buttons/press/[buttonName]Press.png

Please note the addition of 'Hover' and 'Press' on the respective buttons, as well as the different paths.

Optional Inactive Images:
- If additional files ending in "Inactive" are found, e.g., `buttonClosePressInactive.png`:
  - The inactive images are looked up per button image, allowing fine grained control.
  - If no inactive part is found, the same image is used on inactive and acrtive window borders.


Theme directory:
----------------

The theme needs to be in a directory called "<name>-theme", wheras <name> can not contain whitespaces, i.e. "default-theme", "templaTor-theme".

Listing of all files, including optional parts:

<name>-theme
├── buttons
│   ├── hover
│   │   ├── buttonAboveDownHoverInactive.png
│   │   ├── buttonAboveDownHover.png
│   │   ├── buttonAboveHoverInactive.png
│   │   ├── buttonAboveHover.png
│   │   ├── buttonBelowDownHoverInactive.png
│   │   ├── buttonBelowDownHover.png
│   │   ├── buttonBelowHoverInactive.png
│   │   ├── buttonBelowHover.png
│   │   ├── buttonCloseHoverInactive.png
│   │   ├── buttonCloseHover.png
│   │   ├── buttonHelpHoverInactive.png
│   │   ├── buttonHelpHover.png
│   │   ├── buttonMaxHoverInactive.png
│   │   ├── buttonMaxHover.png
│   │   ├── buttonMenuHoverInactive.png
│   │   ├── buttonMenuHover.png
│   │   ├── buttonMinHoverInactive.png
│   │   ├── buttonMinHover.png
│   │   ├── buttonRestoreHoverInactive.png
│   │   ├── buttonRestoreHover.png
│   │   ├── buttonShadeDownHoverInactive.png
│   │   ├── buttonShadeDownHover.png
│   │   ├── buttonShadeHoverInactive.png
│   │   ├── buttonShadeHover.png
│   │   ├── buttonStickyDownHoverInactive.png
│   │   ├── buttonStickyDownHover.png
│   │   ├── buttonStickyHoverInactive.png
│   │   └── buttonStickyHover.png
│   ├── normal
│   │   ├── buttonAboveDownInactive.png
│   │   ├── buttonAboveDown.png
│   │   ├── buttonAboveInactive.png
│   │   ├── buttonAbove.png
│   │   ├── buttonBelowDownInactive.png
│   │   ├── buttonBelowDown.png
│   │   ├── buttonBelowInactive.png
│   │   ├── buttonBelow.png
│   │   ├── buttonCloseInactive.png
│   │   ├── buttonClose.png
│   │   ├── buttonHelpInactive.png
│   │   ├── buttonHelp.png
│   │   ├── buttonMaxInactive.png
│   │   ├── buttonMax.png
│   │   ├── buttonMenuInactive.png
│   │   ├── buttonMenu.png
│   │   ├── buttonMinInactive.png
│   │   ├── buttonMin.png
│   │   ├── buttonRestoreInactive.png
│   │   ├── buttonRestore.png
│   │   ├── buttonShadeDownInactive.png
│   │   ├── buttonShadeDown.png
│   │   ├── buttonShadeInactive.png
│   │   ├── buttonShade.png
│   │   ├── buttonStickyDownInactive.png
│   │   ├── buttonStickyDown.png
│   │   ├── buttonStickyInactive.png
│   │   └── buttonSticky.png
│   └── press
│       ├── buttonAboveDownPressInactive.png
│       ├── buttonAboveDownPress.png
│       ├── buttonAbovePressInactive.png
│       ├── buttonAbovePress.png
│       ├── buttonBelowDownPressInactive.png
│       ├── buttonBelowDownPress.png
│       ├── buttonBelowPressInactive.png
│       ├── buttonBelowPress.png
│       ├── buttonClosePressInactive.png
│       ├── buttonClosePress.png
│       ├── buttonHelpPressInactive.png
│       ├── buttonHelpPress.png
│       ├── buttonMaxPressInactive.png
│       ├── buttonMaxPress.png
│       ├── buttonMenuPressInactive.png
│       ├── buttonMenuPress.png
│       ├── buttonMinPressInactive.png
│       ├── buttonMinPress.png
│       ├── buttonRestorePressInactive.png
│       ├── buttonRestorePress.png
│       ├── buttonShadeDownPressInactive.png
│       ├── buttonShadeDownPress.png
│       ├── buttonShadePressInactive.png
│       ├── buttonShadePress.png
│       ├── buttonStickyDownPressInactive.png
│       ├── buttonStickyDownPress.png
│       ├── buttonStickyPressInactive.png
│       └── buttonStickyPress.png
├── deco
│   ├── bottomLeftFrameBg.png
│   ├── bottomLeftFrameInactiveBg.png
│   ├── bottomMidFrameBg.png
│   ├── bottomMidFrameInactiveBg.png
│   ├── bottomRightFrameBg.png
│   ├── bottomRightFrameInactiveBg.png
│   ├── bottomShadedLeftFrameBg.png
│   ├── bottomShadedLeftFrameInactiveBg.png
│   ├── bottomShadedMidFrameBg.png
│   ├── bottomShadedMidFrameInactiveBg.png
│   ├── bottomShadedRightFrameBg.png
│   ├── bottomShadedRightFrameInactiveBg.png
│   ├── buttonsLeftBg.png
│   ├── buttonsLeftInactiveBg.png
│   ├── buttonsRightBg.png
│   ├── buttonsRightInactiveBg.png
│   ├── leftLowerCornerFrameBg.png
│   ├── leftLowerCornerFrameInactiveBg.png
│   ├── leftMidFrameBg.png
│   ├── leftMidFrameInactiveBg.png
│   ├── leftUpperCornerFrameBg.png
│   ├── leftUpperCornerFrameInactiveBg.png
│   ├── leftUpperFrameBg.png
│   ├── leftUpperFrameInactiveBg.png
│   ├── rightLowerCornerFrameBg.png
│   ├── rightLowerCornerFrameInactiveBg.png
│   ├── rightMidFrameBg.png
│   ├── rightMidFrameInactiveBg.png
│   ├── rightUpperCornerFrameBg.png
│   ├── rightUpperCornerFrameInactiveBg.png
│   ├── rightUpperFrameBg.png
│   ├── rightUpperFrameInactiveBg.png
│   ├── titleLeftBg.png
│   ├── titleLeftInactiveBg.png
│   ├── titleMidBg.png
│   ├── titleMidInactiveBg.png
│   ├── titleRightBg.png
│   ├── titleRightInactiveBg.png
│   ├── topLeftFrameBg.png
│   ├── topLeftFrameInactiveBg.png
│   ├── topMidFrameBg.png
│   ├── topMidFrameInactiveBg.png
│   ├── topRightFrameBg.png
│   └── topRightFrameInactiveBg.png
└── masks
    ├── buttomLeftCornerBitmap.png
    ├── buttomMidBitmap.png
    ├── buttomRightCornerBitmap.png
    ├── buttomShadedLeftCornerBitmap.png
    ├── buttomShadedMidBitmap.png
    ├── buttomShadedRightCornerBitmap.png
    ├── topLeftCornerBitmap.png
    ├── topMidBitMap.png
    └── topRightCornerBitmap.png