KWin Rules Examples

Examples

Note

The first example details all the necessary steps to create the rules. In order to keep this page a manageable size, subsequent examples only list steps specific to the example.

Note

The Pager attribute refers to the Virtual Desktop Manager typically found in the systray.

Pin a Window to a Desktop and set other Attributes

Pin Akregator to Virtual Desktop 2. Additionally, start the application with a preferred size and position. For each attribute, use the Apply Initially parameter so it can be overridden at run-time.

The KWin rule is created as follows:

1. Start Akregator on desktop two, size and position it to suit:

   

2. Right-click on the menu bar and select Configure Window Behavior...:

   

3. Select the Window Rules option in the left column and click on the New... button:

   

4. The Edit Window-Specific Settings window is displayed. The Window matching tab is the default tab:

   

5. 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 - for additional information see window matching:

   

6. 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):

   

7. Enable the window attributes: Position, Size and Desktop. The initial values are set by Detect Window Properties and can be overridden:

   

8. Clicking OK in the previous window returns to the main KWin Rules. The new rule with its Description is listed:

   

9. Click OK to close the window.
10. Done.

Application on all Desktops and Handle One Child Window Uniquely

Except for conversation windows, display Kopete and its children windows on all desktops and skip the systray and pager. For children conversation windows, treat them as the parent window except show them in systray.

For each attribute, use the Force parameter so it can not be overridden.

In order to implement the above, two rules need to be created:

1. A rule for Kopete Chat and
2. A rule for Kopete

The Kopete Chat rule's matching-criteria is more restrictive than the Kopete rule as it needs to match a specific Window Role: the chat window. Due to rule evaluation processing, the Kopete Chat rule must precede the Kopete rule in the KWin Rule list for Kopete.

Kopete Chat Rule

Assuming a Kopete Chat window is open:

1. Use Detect Window Properties and select the Kopete Chat window. Check the Window role box to restrict the criteria to chat windows - for additional information see window matching:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the following attributes:

   

   

4. Click through to complete entry of the rule.

Note

The Skip taskbar attribute is set to No to display the window in the taskbar which loosely translates to: no do not skip taskbar .

Kopete Rule

Assuming Kopete is open:

1. Use Detect Window Properties and select the Kopete window. Check the Secondary class name box to include all of Kopetes children windows - for additional information see window matching:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the following attributes:

   

   

4. Click through to complete entry of the rule.

Kopete KWin Rule List

As mentioned, due to rule evaluation processing, the Kopete Chat rule must precede the Kopete rule:

Suppress a Window from showing on Pager

KNotes currently does not allow for its notes to skip the pager however a rule easily solves this shortcoming.

Assuming a sticky note' window is available:

1. Use Detect Window Properties and select any sticky note window. Match only by primary class name so leave the check boxes unchecked - for additional information see window matching:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the Skip Pager attribute with the Force the parameter:

   

4. Click through to complete entry of the rule.

Force a Window to the Top

To pop an active window to the top, set its Focus stealing prevention attribute to None, typically, in conjunction with the Force parameter:

Multiple Rules per Application

Thunderbird has several different child windows. This example:

• Pin Thunderbird's main window on Virtual Desktop 1 with a specific size and location on the desktop.
• Allow the Thunderbird composer window to reside on any desktop and when activated, force focus and pop it to the top of all windows.
• Pop the Thunderbird reminder to the top and do not give it focus so it isn't inadvertently dismissed.

Each rule's matching criteria is sufficiently restrictive so their order within the main KWin window is not important to affect Special:myLanguage/KWin_Rules#Rule_Evaluation/rule evaluation.

Thunderbird - Main

Assuming the Thunderbird Main window is open:

1. Use Detect Window Properties and select the Thunderbird Main window. Check the Window role box to restrict the criteria to the main window:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the following attributes:

   

4. Click through to complete entry of the rule.

Thunderbird - Composer

Assuming a Thunderbird Composer window is open:

1. Use Detect Window Properties and select the Thunderbird Compose window. Check the Window role and Window type boxes to restrict the criteria to composition windows:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the following attributes:

   

4. Click through to complete entry of the rule.

Thunderbird - Reminder

Assuming a Thunderbird Reminder window is open:

1. Use Detect Window Properties and select the Thunderbird Reminder window. Check the Secondary class name and Window Type boxes to restrict the criteria to reminder windows:

   

2. Clicking OK in the previous window back-fills the results in the Window Matching tab. Enter a meaningful Description:

   

3. Enable the following attributes:

   

   

4. Click through to complete entry of the rule.