KWin Rules: Difference between revisions

From KDE UserBase Wiki
No edit summary
 
(56 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.
<translate>


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.
==Overview== <!--T:1-->


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.
<!--T:2-->
{{Tip|Panels can also be affected.}}
'''KWin''' allows the end-user to define rules to alter an application's window attributes.


==Examples==
<!--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.


The environment in these examples has eight ''Virtual Desktops''.
<!--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]].


The first example details all the steps.  Subsequent examples only list steps specific to the example.
</translate><span id="Examples_and_Application_Workaround"></span><translate>


===Pin a Window to a Desktop and with a favorite Size and Position===
==Examples and Application Workaround== <!--T:5-->


Pin '''Akregator''' to ''Virtual Desktop 2''.  Additionally, start the application with a preferred size and position.
<!--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 '''KWin''' rule is created as follows:
<!--T:7-->
A special page is dedicated to address [[Special:myLanguage/KWin_Rules_Application_Workarounds|Application Workaround]].


# Start '''Akregator''' on ''desktop two'', size and place it to suit:[[Image:akregator-fav.png|350px|center]]
</translate><span id="KWin_Rule_Editor"></span><translate>
# Right-click on the menu bar and select '''Configure Window Behavior...''':[[Image:config-win-behavior.png|center]]
# Select the '''Window Rules''' option in the left column and click on the '''New...''' button:[[Image:kwin-rules-main.png|350px|center]]
# The '''Edit Window-Specific Settings''' window is displayed.  The '''Window matching''' tab is the default tab:[[Image:window-matching-init.png|350px|center]]
# Click on '''Detect Window Properties''' and with '''0s delay''' the cursor immediately turns into cross-hairs.  Click (anywhere) inside the '''Akregator''' window (but not the title bar).  The window criteria are presented.  Match only by '''primary class name''' so leave the check boxes unchecked:[[Image:akgregator-info.png|350px|center]]
# Clicking '''OK''' in the previous window back-fills the results in the '''Window Matching''' tab.  Enter a meaningful '''Description''' (which is displayed in the '''KWin Rule''' window):[[Image:window-matching-ready-akregator.png|350px|center]]
# Enable the window attributes: '''Position''', '''Size''' and '''Desktop'''.  The values are automatically set by '''Detect Window Properties''':[[Image:akregator-attributes.png|350px|center]]
# Clicking '''OK''' in the previous window returns to the main '''KWin Rules'''.  The new rule with its '''Description''' is listed:[[Image:kwin-rules-main-n-akregator.png|350px|center]]
# Click '''OK''' to close the window.
# Done.


===Display Application on all Desktops and treat certain Child Windows Differently===
==KWin Rule Editor== <!--T:8-->


Except for conversation windows, display '''Kopete''' and its children windows on all desktops and skip the systray and pager (the '''Virtual Desktop''' view in systray).  For conversation windows, treat them as the parent window except show them in systray.
</translate><span id="Invoking_the_KWin_Rule_Editor"></span><translate>


'''.... order of creation matters! <----- confirm with understanding ... '''
===Invoking the KWin Rule Editor=== <!--T:9-->


====Kopete Chat Rule====
<!--T:10-->
 
[[Image:kwin-rules-ordering.png|350px|center]]
Assuming a '''Kopete Chat''' window is open:
 
# Use '''Detect Window Properties''' and select the '''Kopete  Chat''' window.  Check the '''Window role''' box to restrict the criteria to chat windows:[[Image:kopete-chat-info.png|350px|center]]
# Clicking '''OK''' in the previous window back-fills the results in the '''Window Matching''' tab.  Enter a meaningful '''Description''':[[Image:window-matching-kopete-chat.png|350px|center]]
# Enable the following attributes:[[Image:kopete-chat-attribute-1.png|350px|center]][[Image:kopte-chat-attribute-2.png|350px|center]]
# Click through to complete entry of the rule.
{{Note|The '''Skip taskbar''' attribute is set to '''No''' to display the window in the taskbar: ''no'' '''skip taskbar''' or ''do not skip taskbar''.}}
 
====Kopete Rule====
{{Being_Edited}}


'''Copied from Kopete Chat ... tweak and add images for Kopete'''
<!--T:11-->
There are several ways to invoke the '''KWin''' Rule Editor.  Below are two:


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


# Use '''Detect Window Properties''' and select the '''Kopete  Chat''' window.  Check the '''Window role''' box to restrict the criteria to chat windows:[[Image:kopete-chat-info.png|350px|center]]
<!--T:13-->
# Clicking '''OK''' in the previous window back-fills the results in the '''Window Matching''' tab.  Enter a meaningful '''Description''':[[Image:window-matching-kopete-chat.png|350px|center]]
* <menuchoice>System Settings -> Window Behavior -> Window Rules</menuchoice>
# Enable the following attributes:[[Image:kopete-chat-attribute-1.png|350px|center]][[Image:kopte-chat-attribute-2.png|350px|center]]
# Click through to complete entry of the rule.
{{Note|The '''Skip taskbar''' attribute is set to '''No''' to display the window in the taskbar: ''no'' '''skip taskbar''' or ''do not skip taskbar''.}}


===Suppress a Window showing on Pager===
<!--T:14-->
The main window is used to:


''Good for knotes''
<!--T:15-->
* Affect rules with <menuchoice>New...</menuchoice>, <menuchoice>Modify...</menuchoice> and <menuchoice>Delete</menuchoice>


===Force a Window to the Top===
<!--T:16-->
* Share rules with others via <menuchoice>Import</menuchoice> and <menuchoice>Export</menuchoice>


===Multiple Rules per Application===
<!--T:17-->
* Ensure desired [[Special:myLanguage/KWin_Rules#Rule_Evaluation|rule evaluation]] using <menuchoice>Move Up</menuchoice> and <menuchoice>Move Down</menuchoice>


''e.g. Thunderbird on one desktop and composition window on any''
</translate><span id="Rule_Evaluation"></span><translate>


===Pop Active Window to the Front/Top===
====Rule Evaluation==== <!--T:18-->


==KWin Rule Editor==
<!--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. 


[[Image:kwin-rules-ordering.png|350px|center]]
<!--T:20-->
Should two or more matching rules enable the same attribute, the setting in the ''first'' rule in the list is used.


===Invoking the Editor===


There are several ways one can invoke the Rules editor. Below are a couple:
<!--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.}}


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


===Anatomy===
===Rule Editor=== <!--T:22-->


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


<!--T:24-->
The editor is composed of four tabs:
The editor is composed of four tabs:


# <menuchoice>Window matching</menuchoice>
<!--T:25-->
# <menuchoice>Size & Position</menuchoice>
# <menuchoice>Window matching</menuchoice></translate>
# <menuchoice>Arrangement & Access</menuchoice>
<translate>
<!--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>


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.
<!--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.


===Rule Evaluation===
<!--T:30-->
 
{{Tip|Panels can also be affected.}}
When an application starts (or the rules are modified), '''KWin''' evaluates the rules from the top of the list until either a matching rule is found or the list is exhausted.  If a rule matches, the attributes set in the rule are applied to the window and the window is displayed.
 
{{Tip|When creating multiple rules for an application, list the rules with more restrictive matching criteria first.}}
 
===Window Matching===
 
[[Image:kwin-window-matching.png|350px|center]]
 
The <menuchoice>Window Matching</menuchoice> tab provides a series of matching-criteria fields used to identify application windows:
 
* <menuchoice>Window class (application)</menuchoice> - match this window and all its children windows.
** and <menuchoice>Match whole window class</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.
 
{{Tip|While it's possible to manually enter the above information, the preferred method is to use the <menuchoice>Detect Window Properties</menuchoice> button.}}
 
For each field, the following operators can be applied against the field value:
 
* <menuchoice>Unimportant</menuchoice>
* <menuchoice>Exact Match</menuchoice> - case insensitive.
* <menuchoice>Substring Match</menuchoice>
* <menuchoice>Regular Expression</menuchoice> - Qt's regular expressions are implemented.  For additional information, web search ''qt regex nokia''.
 
=====Detect Window Properties=====
 
[[Image:kwin-detect-window.png|350px|center]]
 
The <menuchoice>Detect Window Properties</menuchoice> function simplifies the process of entering the matching-criteria. 
 
# For the application you'd like to create a rule, start the application.
# Next, in the <menuchoice>Window matching</menuchoice> tab, 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)'''
 
Click the <menuchoice>OK</menuchoice> button to back-fill the <menuchoice>Window Matching</menuchoice> criteria.
 
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'''.
 
===Window Attributes===
 
[[Image:kwin-window-attributes.png|350px|center]]
 
The attributes which can be set are grouped in three tabs:
 
# <menuchoice>Size & Position</menuchoice>
# <menuchoice>Arrangement & Access</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.
 
====Parameters====
Each attribute minimally accepts one of the following parameters.  Additional, attribute-specific arguments are listed within each attribute definition.
 
;Do Not Affect
: Unset the attribute.
{{Tip|As rules are evaluated from the top of the list to the bottom, a generic rule can be written to default a certain attribute for all windows.  Subsequent, restrictive rules can be created to unset the attribute for different windows.}}
;Apply Initially
: Start the window with the attribute and allow it to be changed at run-time.
;Remember
: Use the attribute setting as defined in the rule and if changed at run-time, save and use the new value instead.
;Force
: The setting cannot be changed at run-time.
;Apply Now, Force Temporarily
: Apply/Force the setting once and unset the attribute.<br />'''Apply Now''' allows the attribute to be changed at run-time.  Use '''Force Temporarily''' to not allow the attribute to be changed.
{{Warning|If the rule has not other attributes set, the rule is deleted.}}


====Attributes====
</translate><span id="Window_Matching"></span><translate>


{{Tip|Using <menuchoice>Detect Window Properties</menuchoice> back-fills values for attributes.  For example the height and width arguments of the '''Size''' attribute is set to the height and width of the detected window.}}
====Window Matching==== <!--T:31-->
{{Tip|'''Yes/No''' arguments are used to toggle attributes.  For example, if a window's default behavior is to start horizontally maximized and you wish to disable this behavior, specify '''No''' as the argument to <menuchoice>Maximized horizontally</menuchoice>, on the other hand if you wish to force a window to start horizontally maximized, specify '''Yes'''.}}


=====Size & Position=====
<!--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.


;Position
</translate><span id="Window_Attributes"></span><translate>
: Position the window's upper left corner at the specified x,y coordinate.
{{Tip|'''KWin''''s origin, (0,0), is the upper left.}}
;Size
: The width and height of the window.
;Maximized horizontally, Maximized vertically, Fullscreen
: These attributes are used to toggle the maximum horizontal/minimum horizontal/full-screen window attribute.
;Desktop
: Place the window on the specified ''(Virtual) Desktop''.  Use '''All Desktops''' to place the window on all ''Virtual Desktops''.
;Minimized, Shaded
: Toggle the Minimize and Shading window attribute.  For example, a window can be started Minimized or if it is started Minimized, it can be forced to not.
{{Tip|Maximized attribute is emulated by using both '''Maximized horizontally''' and '''Maximized vertically''' or '''Initial placement''' with the '''Maximizing''' argument.}}
;Initial placement
: Override the global window placement strategy with one of the following:
:* '''Default''' - use the global window placement strategy.
:* '''No Placement''' - top-left corner.
:* '''Smart''' - place where no other window exists.
:* '''Maximizing''' - start the window maximized.
:* '''Cascade'''
:* '''Centered'''
:* '''Random'''
:* '''Top-Left Corner'''
:* '''Under Mouse'''
:* '''On Main Window''' - restrict placement of a child window to the boundaries of the parent window.
;Ignore requested geometry
: Toggle whether to accept or ignore the window's requested geometry and ignore the global placement strategy.
;Minimum size, Maximum size
: The minimum and maximum size allowed for the window.
;Obey geometry restrictions
: Toggle whether to adhere to the window's requested aspect ratio.


=====Arrangement & Access=====
====Window Attributes==== <!--T:33-->


;Keep above, Keep below
<!--T:34-->
: Toggle whether to keep the window above/below all others.
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'''.
;Autogroup with identical
: Toggle the grouping (commonly known as ''tabbing'') of windows.
;Autogroup in foreground
: Toggle whether to make the window active when it is added to the group.
;Autogroup by ID
: Create a group via a user-defined ID.  More than one rule can share the same ID to allow for seemingly unrelated windows to be grouped.
;Tiling
: Override the default window behavior to either '''Tiled''' or '''Floating'''.
;Skip taskbar
: Toggle whether to display the window in the taskbar.
;Skip pager
: Toggle whether to display the window in the virtual desktop list.
;Skip switcher
: Toggle whether to display the window in the '''ALT+TAB''' list.
;Shortcut
: Assign a shortcut to the window.  When '''Edit...''' is clicked, additional instructions are presented.


=====Appearance & Fixes=====
<!--T:35-->
;No titlebar and frame
[[Category:Desktop]]
: Toggle whether to display the titlebar and frame.
[[Category:Tutorials]]
;Active/Inactive opacity
</translate>
: When the window is active/inactive, set its opacity to the percentage specified.
{{Tip|'''Active/Inactive opacity''' can only be affected when '''Desktop Effects''' are enabled.}}
; Moving/resizing
: ''Deprecated as of >4.8''
;Focus stealing prevention
: When a window wants focus, control on a scale (from '''None''' to '''Extreme''') whether to honor the focus request and place the window on top above all other windows and give it focus, or ignore its request (potentially leaving the window behind other windows).
:* None - Always grant focus to the window.
:* Low
:* Normal
:* High
:* Extreme - The window's focus request is denied.  Focus is only granted by mousing to the window.
{{Tip|See '''Accept focus''' to make a window read-only - not accept any keyboard input.}}
;Accept focus
: Toggle whether the window accepts keyboard input.  Make the window read-only.
;Ignore global shortcuts
: Toggle whether to ignore global shortcuts while the window is active.
; Closeable
: Toggle whether to display the '''Close''' button on the title bar.
{{Tip|A terminal window may still be closed by the end user by ending the shell session however using '''Accept focus''' to disable keyboard input will make it more difficult to close the window.}}
; Window type
: Change the window to another type and inherit the characteristics of that window:
:* Normal Window
:* Dialog Window
:* Utility Window
:* Dock (panel)
:* Toolbar
:* Torn-Off Menu
:* Splash Screen
:* Desktop
:* Standalone Menubar
; Block compositing
: Toggle whether to disable compositing while the window ''exists''.  If compositing is enabled and the rule specifies to disable compositing, once the window exists, compositing will be re-activated.

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://userbase.kde.org/index.php?title=KWin_Rules&oldid=463345"