KWin Rules: Difference between revisions

From KDE Wiki Sandbox
No edit summary
 
(114 intermediate revisions by 6 users not shown)
Line 1: Line 1:
==Overview==
<languages />
'''KWin''' allows the end-user to define rules to alter the behavior of an application's windows.
<!--T:73-->
{{Tip|Plasmoids, Workspaces can also be affected.}}
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 by using a rule to, say, always force the window on top of all others.


This page will define the different settings and the attributes.  For the impatient folks, working examples will be listed.  Whenever possible, screen shots will be used to show example settings.
<translate>


==KWin Rule Editor==
==Overview== <!--T:1-->


[[Image:kwin-rules-ordering.png|250px|center]]
<!--T:2-->
'''KWin''' allows the end-user to define rules to alter an application's window attributes.


===Invoking the Editor===
<!--T:3-->
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.


There are several ways one can invoke the Rules editor. Below are a couple:
<!--T:4-->
Step-by-step [[Special:myLanguage/KWin_Rules_Examples|examples]] are provided along with detailed information on using the [[Special:myLanguage/KWin_Rules#KWin_Rule_Editor|'''KWin''' Rule Editor]] to specify [[Special:myLanguage/KWin_Rules_Window_Matching|Window Matching]] and [[Special:myLanguage/KWin_Rules_Window_Attributes|Window Attributes]].


* 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
</translate><span id="Examples_and_Application_Workaround"></span><translate>
* <menuchoice>Configure Desktop -> Window Behavior -> Window Rules</menuchoice>


===Anatomy===
==Examples and Application Workaround== <!--T:5-->


[[Image:kwin-rule-editor.png|250px|center]]
<!--T:6-->
To see what's possible, detailed [[Special:myLanguage/KWin_Rules_Examples|examples]] are provided which can also be used to model your own rules.


The editor is composed of four tabs:
<!--T:7-->
 
A special page is dedicated to address [[Special:myLanguage/KWin_Rules_Application_Workarounds|Application Workaround]].
# <menuchoice>Window matching</menuchoice>
# <menuchoice>Size & Position</menuchoice>
# <menuchoice>Arrangement & Access</menuchoice>
# <menuchoice>Appearance & Fixes</menuchoice>


As the name implies, <menuchoice>Window matching</menuchoice> is used to specify criteria to match one or more windows.  The other three tabs are used to alter the characteristics of the matching windows.
</translate><span id="KWin_Rule_Editor"></span><translate>


===Rules===
==KWin Rule Editor== <!--T:8-->


====Evaluation====
</translate><span id="Invoking_the_KWin_Rule_Editor"></span><translate>
KWin evaluates the rules when an application starts and after editing rules.  Any matching rule's attribute(s) override the application's corresponding attribute(s).


====Precedence====
===Invoking the KWin Rule Editor=== <!--T:9-->
In the <menuchoice>Window Rules</menuchoice> window, the rules are listed in the order in which they are processed.


The rule at the top of the list is processed first, followed by the next rule until the end of the list is reached.
<!--T:10-->
[[Image:kwin-rules-ordering.png|350px|center]]


====Conflicts====
<!--T:11-->
In the event two rules match a window and affect the same attribute, the first rule in the list takes precedence.
There are several ways to invoke the '''KWin''' Rule Editor.  Below are two:


===Window Matching===
<!--T:12-->
* Right-click on the title-bar of any window, choose <menuchoice>More Actions</menuchoice>, <menuchoice>Configure Special Window Settings...</menuchoice> or


[[Image:kwin-window-matching.png|250px|center]]
<!--T:13-->
* <menuchoice>System Settings -> Window Behavior -> Window Rules</menuchoice>


The <menuchoice>Window Matching</menuchoice> tab provides a series of matching-criteria fields used to identify application windows:
<!--T:14-->
The main window is used to:


* <menuchoice>Window class (application)</menuchoice> - match this window and all its children windows.
<!--T:15-->
** and <menuchoice>Match whole window class</menuchoice>
* Affect rules with <menuchoice>New...</menuchoice>, <menuchoice>Modify...</menuchoice> and <menuchoice>Delete</menuchoice>
* <menuchoice>Window role</menuchoice> - restrict the match to the function of the window (e.g. a ''main window'', a ''chat window'', etc.)
* <menuchoice>Window types</menuchoice> - restrict the match to the type of window:  '''Normal Window''', '''Dialog Window''', etc.
* <menuchoice>Window title</menuchoice> - restrict the match to the title of the window.
* <menuchoice>Machine (hostname)</menuchoice> - restrict the match to the host name associated with the window.


<!--T:73-->
<!--T:16-->
{{Tip|While it's possible to manually enter the above information, the preferred method is to use the <menuchoice>Detect Window Properties</menuchoice> button.}}
* Share rules with others via <menuchoice>Import</menuchoice> and <menuchoice>Export</menuchoice>


For each field, the following operators can be applied against the field value:
<!--T:17-->
* Ensure desired [[Special:myLanguage/KWin_Rules#Rule_Evaluation|rule evaluation]] using <menuchoice>Move Up</menuchoice> and <menuchoice>Move Down</menuchoice>


* '''Unimportant'''
</translate><span id="Rule_Evaluation"></span><translate>
* '''Exact Match'''
* '''Substring Match'''
* '''Regular Expression''' - Qt's regular expressions are implemented.  For additional information, web search ''qt regex nokia''.


=====Detect Window Properties=====
====Rule Evaluation==== <!--T:18-->


[[Image:kwin-detect-window.png|250px|center]]
<!--T:19-->
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.


The <menuchoice>Detect Window Properties</menuchoice> function simplifies the process of entering the matching-criteria.
<!--T:20-->
Should two or more matching rules enable the same attribute, the setting in the ''first'' rule in the list is used.


# For the application you'd like to create a rule, start the application.
# Next, set the number of seconds of delay before the <menuchoice>Detect Window Properties</menuchoice> function starts.  The default is zero seconds.
# Click on <menuchoice>Detect Window Properties</menuchoice> and
# When the mouse-cursor turns to cross-hairs, place it inside the application window and left-click.
# A new window is presented with information about the selected window:
#* '''Class'''
#* '''Role'''
#* '''Type'''
#* '''Title'''
#* '''Machine (hostname)'''


<!--T:21-->
{{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.}}


The information is used to back-fill the <menuchoice>Window Matching</menuchoice> criteria.
</translate><span id="Rule_Editor"></span><translate>


By using a combination of the information, you can tailor whether a rule applies to an entire application (by '''Class''') or a to a specific window '''Type''' within the '''Class''' - say a '''Toolbar'''.
===Rule Editor=== <!--T:22-->


===Window Attributes===
<!--T:23-->
[[Image:kwin-rule-editor.png|350px|center]]


[[Image:kwin-window-attributes.png|250px|center]]
<!--T:24-->
The editor is composed of four tabs:


The attributes which can be set are grouped in three tabs:
<!--T:25-->
 
# <menuchoice>Window matching</menuchoice></translate>
# <menuchoice>Size & Position</menuchoice>
<translate>
# <menuchoice>Arrangement & Access</menuchoice>
<!--T:26-->
# <menuchoice>Size & Position</menuchoice></translate>
<translate>
<!--T:27-->
# <menuchoice>Arrangement & Access</menuchoice></translate>
<translate>
<!--T:28-->
# <menuchoice>Appearance & Fixes</menuchoice>
# <menuchoice>Appearance & Fixes</menuchoice>


Each attribute has additional settings which determine when they're applied and depending on the attribute, there may be an additional argument.
<!--T:29-->
 
As the name implies, <menuchoice>Window matching</menuchoice> 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.
====Attributes====
;Position
: Def
; Size
: Def
 
====Attribute Disposition====
;Do Not Affect
: Definition
;Apply Initially
: Definition
;Remember
: Def
;Force
: Def
;Apply Now
: Def
;Force Temporarily
: Def


==Examples==
<!--T:30-->
{{Tip|Panels can also be affected.}}


===Force a Window on a Desktop===
</translate><span id="Window_Matching"></span><translate>


===Force a Window on all Desktops===
====Window Matching==== <!--T:31-->


===Suppress a Window showing on Pager===
<!--T:32-->
Each window rule has user specified [[Special:myLanguage/KWin_Rules_Window_Matching|Window Matching]] criteria.  '''KWin''' uses the criteria to determine whether the rule is applicable for an application.


===Force a Window to the Top===
</translate><span id="Window_Attributes"></span><translate>


''Good for knotes''
====Window Attributes==== <!--T:33-->


===Multiple Rules per Application===
<!--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'''.


''e.g. Thunderbird on one desktop and composition window on any''
<!--T:35-->
[[Category:Desktop]]
[[Category:Tutorials]]
</translate>

Latest revision as of 22:44, 22 January 2021

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 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 More Actions, Configure Special Window Settings... or
  • 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

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:

  1. Window matching
  2. Size & Position
  3. Arrangement & Access
  4. 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.

Retrieved from "https://wikisandbox.kde.org/index.php?title=KWin_Rules&oldid=463345"