Changeset View
Changeset View
Standalone View
Standalone View
plugins/kdecorations/aurorae/theme-description
| 1 | DESCRIPTION OF AURORAE | 1 | DESCRIPTION OF AURORAE | ||
|---|---|---|---|---|---|
| 2 | ====================== | 2 | ====================== | ||
| 3 | 3 | | |||
| 4 | Aurorae is a theme engine for KWin window decorations. It is built against the unstable API of KWin | 4 | Aurorae is a theme engine for KWin window decorations. It is built against the unstable API of KWin | ||
| 5 | in KDE 4.3. Aurorae uses SVG to render the decoration and buttons and there is a simple config file | 5 | in KDE 4.3. Aurorae uses SVG to render the decoration and buttons and there is a simple config file | ||
| 6 | for configuring the theme details. | 6 | for configuring the theme details. | ||
| 7 | 7 | | |||
| 8 | This theme engine uses Plasma technologie to render the window decoration. Every detail can be | 8 | This theme engine uses Plasma technologie to render the window decoration. Every detail can be | ||
| 9 | themed by the usage of SVG. The theme engine uses Plasma's FrameSvg, so you can provide SVG files | 9 | themed by the usage of SVG. The theme engine uses Plasma's FrameSvg, so you can provide SVG files | ||
| 10 | containing borders. This is described in more detail in techbase: | 10 | containing borders. This is described in more detail in techbase: | ||
| 11 | http://techbase.kde.org/Projects/Plasma/Theme#Backgrounds | 11 | https://techbase.kde.org/Projects/Plasma/Theme#Backgrounds | ||
yurchor: https://techbase.kde.org/Development/Tutorials/Plasma5/ThemeDetails | |||||
| 12 | 12 | | |||
| 13 | The theme consists of one folder containing svgz files for decoration and buttons, one KConfig file | 13 | The theme consists of one folder containing svgz files for decoration and buttons, one KConfig file | ||
| 14 | for the theme details and one metadata.desktop file which you can use to name your theme, author | 14 | for the theme details and one metadata.desktop file which you can use to name your theme, author | ||
| 15 | information, etc. | 15 | information, etc. | ||
| 16 | 16 | | |||
| 17 | Although the engine uses Plasma technology, it isn't Plasma. So it does not know anything about | 17 | Although the engine uses Plasma technology, it isn't Plasma. So it does not know anything about | ||
| 18 | Plasmoids and you will never be able to put Plasmoids into the decoration. That is out of scope of | 18 | Plasmoids and you will never be able to put Plasmoids into the decoration. That is out of scope of | ||
| 19 | this engine. | 19 | this engine. | ||
| Show All 36 Lines | |||||
| 56 | The following fallback strategy is used: if inactive is not present it falls back to the active. | 56 | The following fallback strategy is used: if inactive is not present it falls back to the active. | ||
| 57 | If opaque is not present it falls back to the translucent. If none of the maximized elements are | 57 | If opaque is not present it falls back to the translucent. If none of the maximized elements are | ||
| 58 | present the center element of the decoration is used! | 58 | present the center element of the decoration is used! | ||
| 59 | 59 | | |||
| 60 | In order to support Fitts' Law all TitleEdge Settings are set to 0. So the buttons will be directly | 60 | In order to support Fitts' Law all TitleEdge Settings are set to 0. So the buttons will be directly | ||
| 61 | next to the screen edges. You have the possibility to overwrite these settins (see below). | 61 | next to the screen edges. You have the possibility to overwrite these settins (see below). | ||
| 62 | 62 | | |||
| 63 | Buttons | 63 | Buttons | ||
| 64 | ======= | 64 | ======= | ||
Lint: Unresolved merge conflict: This syntax indicates there is an unresolved merge conflict. | |||||
| 65 | You have to provide a svgz file for each button your theme should contain. If you do not provide a | 65 | You have to provide a svgz file for each button your theme should contain. If you do not provide a | ||
| 66 | file for a button type the engine will not include that button, so your decoration will miss it. | 66 | file for a button type the engine will not include that button, so your decoration will miss it. | ||
| 67 | There is no fallback to a default theme. The buttons are rendered using Plasma's FrameSvg as well. | 67 | There is no fallback to a default theme. The buttons are rendered using Plasma's FrameSvg as well. | ||
| 68 | So you have to provide the "center" element. Borders are not supported | 68 | So you have to provide the "center" element. Borders are not supported | ||
| 69 | 69 | | |||
| 70 | You can provide the following buttons: | 70 | You can provide the following buttons: | ||
| 71 | * close | 71 | * close | ||
| 72 | * minimize | 72 | * minimize | ||
| ▲ Show 20 Lines • Show All 91 Lines • Show Last 20 Lines | |||||
https://techbase.kde.org/Development/Tutorials/Plasma5/ThemeDetails