KWin Rules: Difference between revisions

Revision as of 09:23, 25 March 2012

Other languages:

Overview

KWin allows the end-user to define rules to alter an application's window attributes.

For example, when an application is started, it can be forced to always run on Virtual Desktop 2. Or a defect in an application can be worked-around to force the window above others.

Step-by-step examples are provided along with detailed information on using the KWin Rule Editor to specify Window Matching and Window Attributes.

Examples and Application Workaround

To see what's possible, detailed examples are provided which can also be used to model your own rules.

A special page is to dedicated to address Application Workaround.

KWin Rule Editor

Invoking the KWin Rule Editor

There are several ways to invoke the KWin Rule Editor. Below are two:

Right-click on the title-bar of any window, choose Configure Window Settings... and in the Configure window, select Window Rules or

Information

Pre 4.9: choose Configure Window Behavior...

System Settings -> Window Behavior -> Window Rules

The main window is used to:

Affect rules with New..., Modify... and Delete

Share rules with others via Import and Export

Ensure desired rule evaluation using Move Up and Move Down

Rule Evaluation

When an application starts (or the rules are modified), KWin evaluates the rules from the top of the list to the bottom. For all rules which match a window, the collective set of attributes are applied to the window, then the window is displayed.

Should two or more matching rules enable the same attribute, the setting in the first rule in the list is used.

Tip

You can tailor children windows for the application by placing the more restrictive rules first - see the Kopete and Kopete Chat Window example.

Rule Editor

The editor is composed of four tabs:

Window matching
Size & Position
Arrangement & Access
Appearance & Fixes

As the name implies, Window matching is used to specify criteria to match one or more windows. The other three tabs are used to alter the attributes of the matching windows.

Tip

Panels can also be affected.

Window Matching

Each window rule has user specified Window Matching criteria. KWin uses the criteria to determine whether the rule is applicable for an application.

Window Attributes

Along with Window Matching criteria, each window rule has a set of Window Attributes. The attributes override the corresponding application's settings and are applied before the window is displayed by KWin.

@@ Line 1: / Line 1: @@
 <languages />
-<span id="Overview"></span><translate>
+<translate>
 ==Overview== <!--T:1-->
 <!--T:2-->
-'''KWin''' allows the end-user to define rules to alter the behavior of an application's window attributes.
+'''KWin''' allows the end-user to define rules to alter an application's window attributes.
 <!--T:3-->
@@ Line 39: / Line 39: @@
 <!--T:12-->
-* Right-click on the title-bar of any window, choose <menuchoice>Configure Window Behavior ...</menuchoice> and in the '''Configure''' window, select <menuchoice>Window Rules</menuchoice> or
+* Right-click on the title-bar of any window, choose <menuchoice>Configure Window Settings...</menuchoice> and in the '''Configure''' window, select <menuchoice>Window Rules</menuchoice> or
+<!--T:36-->
+{{Info|Pre 4.9:  choose <menuchoice>Configure Window Behavior...</menuchoice>}}
 <!--T:13-->
@@ Line 48: / Line 51: @@
 <!--T:15-->
-* Affect rules with '''New...''', '''Modify...''' and '''Delete'''
+* Affect rules with <menuchoice>New...</menuchoice>, <menuchoice>Modify...</menuchoice> and <menuchoice>Delete</menuchoice>
 <!--T:16-->
-* Share rules with others via '''Import''' and '''Export'''
+* Share rules with others via <menuchoice>Import</menuchoice> and <menuchoice>Export</menuchoice>
 <!--T:17-->
-* Ensure desired [[Special:myLanguage/KWin_Rules#Rule_Evaluation|rule evaluation]] using '''Move Up''' and '''Move Down'''
+* Ensure desired [[Special:myLanguage/KWin_Rules#Rule_Evaluation|rule evaluation]] using <menuchoice>Move Up</menuchoice> and <menuchoice>Move Down</menuchoice>
 </translate><span id="Rule_Evaluation"></span><translate>
@@ Line 68: / Line 71: @@
 <!--T:21-->
-{{Tip|You can tailor children windows for the application by placing the more restrictive rules first - see the
+{{Tip|You can tailor children windows for the application by placing the more restrictive rules first - see the [[Special:myLanguage/KWin_Rules_Examples#Application_on_all_Desktops_and_Handle_One_Child_Window_Uniquely|Kopete and Kopete Chat Window]] example.}}
-[[Special:myLanguage/KWin_Rules_Examples#Application_on_all_Desktops_and_Handle_One_Child_Window_Uniquely|Kopete and Kopete Chat Window]] example.}}
 </translate><span id="Rule_Editor"></span><translate>
@@ Line 111: / Line 113: @@
 <!--T:34-->
-Along with '''Window Matching''' criteria, each window rule has a set of [[Special:myLanguage/KWin_Rules_Window_Attributes|Window Attributes]].  The attributes override the corresponding application's settings and are applied before the window is displayed by '''KWin'''.
+Along with Window Matching criteria, each window rule has a set of [[Special:myLanguage/KWin_Rules_Window_Attributes|Window Attributes]].  The attributes override the corresponding application's settings and are applied before the window is displayed by '''KWin'''.
 <!--T:35-->