Difference between revisions of "KWin Rules Window Attributes"

 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=Window Attributes=
+
<languages />
 +
<translate>
  
 +
==Window Attributes== <!--T:1-->
 +
 +
<!--T:2-->
 
[[Image:kwin-window-attributes.png|350px|center]]
 
[[Image:kwin-window-attributes.png|350px|center]]
  
 +
<!--T:3-->
 
The attributes which can be set are grouped by function in three tabs:
 
The attributes which can be set are grouped by function in three tabs:
  
# <menuchoice>Size & Position</menuchoice>
+
<!--T:4-->
# <menuchoice>Arrangement & Access</menuchoice>
+
# <menuchoice>Size & Position</menuchoice></translate>
 +
<translate>
 +
<!--T:5-->
 +
# <menuchoice>Arrangement & Access</menuchoice></translate>
 +
<translate>
 +
<!--T:6-->
 
# <menuchoice>Appearance & Fixes</menuchoice>
 
# <menuchoice>Appearance & Fixes</menuchoice>
  
 +
<!--T:7-->
 
Each attribute has a set of parameters which determines its disposition.
 
Each attribute has a set of parameters which determines its disposition.
  
==Parameters==
+
</translate><span id="Parameters"></span><translate>
 +
 
 +
===Parameters=== <!--T:8-->
 +
 
 +
<!--T:9-->
 
Each attribute, minimally, accepts one of the following parameters.  Additional, attribute-specific arguments are listed within each [[Special:myLanguage/KWin_Rules_Window_Attributes#Attributes|attribute]] definition.
 
Each attribute, minimally, accepts one of the following parameters.  Additional, attribute-specific arguments are listed within each [[Special:myLanguage/KWin_Rules_Window_Attributes#Attributes|attribute]] definition.
  
 +
<!--T:10-->
 
;Do Not Affect
 
;Do Not Affect
: Unset the attribute.
+
: Ensure a subsequent rule, which matches the window, does not affect the attribute.
 +
 
 +
<!--T:11-->
 
;Apply Initially
 
;Apply Initially
 
: Start the window with the attribute and allow it to be changed at run-time.
 
: Start the window with the attribute and allow it to be changed at run-time.
 +
 +
<!--T:12-->
 
;Remember
 
;Remember
 
: Use the attribute setting as defined in the rule and if changed at run-time, save and use the new value instead.
 
: Use the attribute setting as defined in the rule and if changed at run-time, save and use the new value instead.
 +
 +
<!--T:13-->
 
;Force
 
;Force
 
: The setting cannot be changed at run-time.
 
: The setting cannot be changed at run-time.
 +
 +
<!--T:14-->
 
;Apply Now, Force Temporarily
 
;Apply Now, Force Temporarily
: Apply/Force the setting once and unset the attribute.<br><br>The difference between the two is at run-time, '''Apply Now''' allows the attribute to be changed and '''Force Temporarily''' prohibits it to be altered.
+
: Apply/Force the setting once and unset the attribute.<br /><br />The difference between the two is at run-time, '''Apply Now''' allows the attribute to be changed and '''Force Temporarily''' prohibits it to be altered until all affected windows exit.
{{Warning|For '''Apply Now/Force Temporarily''', if the rule has no other attributes set, the rule is deleted after evaluation.}}
+
 
 +
<!--T:15-->
 +
{{Warning|For '''Apply Now''', if the rule has no other attributes set, the rule is deleted after evaluation whereas '''Force Temporarily''', the rule is deleted after the last affected window terminates.}}
 +
 
 +
</translate><span id="Attributes"></span><translate>
  
==Attributes==
+
===Attributes=== <!--T:16-->
  
 +
<!--T:17-->
 
{{Tip|The '''Detect Window Properties''' button back-fills attribute-specific values - for more information see [[Special:myLanguage/KWin_Rules_Window_Matching|Window Matching]].  For example the height and width values of the '''Size''' attribute is set to the height and width of the detected window.}}
 
{{Tip|The '''Detect Window Properties''' button back-fills attribute-specific values - for more information see [[Special:myLanguage/KWin_Rules_Window_Matching|Window Matching]].  For example the height and width values of the '''Size''' attribute is set to the height and width of the detected window.}}
 +
 +
<!--T:18-->
 
{{Tip|'''Yes/No''' arguments are used to toggle on or off attributes.  Leniency with grammar helps one understand how a setting will be processed.  {{Smiley}}  For example, the attribute '''Skip taskbar''', when set to '''No''' means do not skip the taskbar.  In other words, show the window in the taskbar.  {{Smiley}}}}
 
{{Tip|'''Yes/No''' arguments are used to toggle on or off attributes.  Leniency with grammar helps one understand how a setting will be processed.  {{Smiley}}  For example, the attribute '''Skip taskbar''', when set to '''No''' means do not skip the taskbar.  In other words, show the window in the taskbar.  {{Smiley}}}}
  
===Size & Position===
+
</translate><span id="Size_&_Position"></span><translate>
  
 +
====Size & Position==== <!--T:19-->
 +
 +
<!--T:20-->
 
;Position
 
;Position
 
: Position the window's upper left corner at the specified x,y coordinate.
 
: Position the window's upper left corner at the specified x,y coordinate.
 +
 +
<!--T:21-->
 
{{Tip|'''KWin''''s origin, (0,0), is the upper left of the desktop.}}
 
{{Tip|'''KWin''''s origin, (0,0), is the upper left of the desktop.}}
 +
 +
<!--T:22-->
 
;Size
 
;Size
 
: The width and height of the window.
 
: The width and height of the window.
 +
 +
<!--T:23-->
 
;Maximized horizontally, Maximized vertically, Fullscreen
 
;Maximized horizontally, Maximized vertically, Fullscreen
 
: These attributes are used to toggle the maximum horizontal/minimum horizontal/full-screen window attribute.
 
: These attributes are used to toggle the maximum horizontal/minimum horizontal/full-screen window attribute.
 +
 +
<!--T:24-->
 
;Desktop
 
;Desktop
 
: Place the window on the specified ''(Virtual) Desktop''.  Use '''All Desktops''' to place the window on all ''Virtual Desktops''.
 
: Place the window on the specified ''(Virtual) Desktop''.  Use '''All Desktops''' to place the window on all ''Virtual Desktops''.
 +
 +
<!--T:25-->
 
;Minimized, Shaded
 
;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.
 
: 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.
 +
 +
<!--T:26-->
 
{{Tip|Maximized attribute is emulated by using both '''Maximized horizontally''' and '''Maximized vertically''' or '''Initial placement''' with the '''Maximizing''' argument.}}
 
{{Tip|Maximized attribute is emulated by using both '''Maximized horizontally''' and '''Maximized vertically''' or '''Initial placement''' with the '''Maximizing''' argument.}}
 +
 +
<!--T:27-->
 
;Initial placement
 
;Initial placement
: Override the global window placement strategy with one of the following:
+
: Override the global window placement strategy with one of the following:</translate>
:* '''Default''' - use the global window placement strategy.
+
<translate>
:* '''No Placement''' - top-left corner.
+
<!--T:28-->
:* '''Smart''' - place where no other window exists.
+
:* '''Default''' - use the global window placement strategy.</translate>
:* '''Maximizing''' - start the window maximized.
+
<translate>
:* '''Cascade''' - staircase-by-title.
+
<!--T:29-->
:* '''Centered''' - center of the desktop.
+
:* '''No Placement''' - top-left corner.</translate>
:* '''Random'''
+
<translate>
:* '''Top-Left Corner'''
+
<!--T:30-->
:* '''Under Mouse'''
+
:* '''Smart''' - place where no other window exists.</translate>
 +
<translate>
 +
<!--T:31-->
 +
:* '''Maximizing''' - start the window maximized.</translate>
 +
<translate>
 +
<!--T:32-->
 +
:* '''Cascade''' - staircase-by-title.</translate>
 +
<translate>
 +
<!--T:33-->
 +
:* '''Centered''' - center of the desktop.</translate>
 +
<translate>
 +
<!--T:34-->
 +
:* '''Random'''</translate>
 +
<translate>
 +
<!--T:35-->
 +
:* '''Top-Left Corner'''</translate>
 +
<translate>
 +
<!--T:36-->
 +
:* '''Under Mouse'''</translate>
 +
<translate>
 +
<!--T:37-->
 
:* '''On Main Window''' - restrict placement of a child window to the boundaries of the parent window.
 
:* '''On Main Window''' - restrict placement of a child window to the boundaries of the parent window.
 +
 +
<!--T:38-->
 
;Ignore requested geometry
 
;Ignore requested geometry
: Toggle whether to accept or ignore the window's requested geometry position.  Accepting the requested position overrides the placement strategy.
+
: Toggle whether to accept or ignore the window's requested geometry position.  To avoid conflicts between the default placement strategy and the window's request, the placement strategy is ignored when the window's request is accepted.
 +
 
 +
<!--T:39-->
 
;Minimum size, Maximum size
 
;Minimum size, Maximum size
 
: The minimum and maximum size allowed for the window.
 
: The minimum and maximum size allowed for the window.
 +
 +
<!--T:40-->
 
;Obey geometry restrictions
 
;Obey geometry restrictions
: Toggle whether to adhere to the window's requested aspect ratio or ''base increment''.<br><br>In order to understand this attribute, some background is required.  Briefly, windows must request from the Window Manager, a base increment:  the minimum number of ''height'' X ''width'' pixels per re-size request.  Typically, it's 1x1.  Other windows though, for example terminal emulators or editors, use fixed-fonts and request their base-increment according to the size of one character.
+
: Toggle whether to adhere to the window's requested aspect ratio or ''base increment''.<br /><br />In order to understand this attribute, some background is required.  Briefly, windows must request from the Window Manager, a base increment:  the minimum number of ''height'' X ''width'' pixels per re-size request.  Typically, it's 1x1.  Other windows though, for example terminal emulators or editors, use fixed-fonts and request their base-increment according to the size of one character.
  
===Arrangement & Access===
+
</translate><span id="Arrangement_&_Access"></span><translate>
  
 +
====Arrangement & Access==== <!--T:41-->
 +
 +
<!--T:42-->
 
;Keep above, Keep below
 
;Keep above, Keep below
 
: Toggle whether to keep the window above/below all others.
 
: Toggle whether to keep the window above/below all others.
 +
 +
<!--T:43-->
 
;Autogroup with identical
 
;Autogroup with identical
 
: Toggle the grouping (commonly known as ''tabbing'') of windows.
 
: Toggle the grouping (commonly known as ''tabbing'') of windows.
 +
 +
<!--T:44-->
 
;Autogroup in foreground
 
;Autogroup in foreground
: Toggle whether to make the window active when it is added to the '''Autogroup''' group.
+
: Toggle whether to make the window active when it is added to the current Autogroup.
 +
 
 +
<!--T:45-->
 
;Autogroup by ID
 
;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.
 
: 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.
 +
 +
<!--T:46-->
 
;Tiling
 
;Tiling
 
: Override the default window behavior to either '''Tiled''' or '''Floating'''.
 
: Override the default window behavior to either '''Tiled''' or '''Floating'''.
 +
 +
<!--T:47-->
 
;Skip taskbar
 
;Skip taskbar
 
: Toggle whether to display the window in the taskbar.
 
: Toggle whether to display the window in the taskbar.
 +
 +
<!--T:48-->
 
;Skip pager
 
;Skip pager
: Toggle whether to display the window in pager:<br><br>
+
: Toggle whether to display the window in pager:<br /><br />
 
[[Image:pager-4-desktops.png|center]]
 
[[Image:pager-4-desktops.png|center]]
 +
 +
<!--T:49-->
 
;Skip switcher
 
;Skip switcher
 
: Toggle whether to display the window in the '''ALT+TAB''' list.
 
: Toggle whether to display the window in the '''ALT+TAB''' list.
 +
 +
<!--T:50-->
 
;Shortcut
 
;Shortcut
 
: Assign a shortcut to the window.  When '''Edit...''' is clicked, additional instructions are presented.
 
: Assign a shortcut to the window.  When '''Edit...''' is clicked, additional instructions are presented.
  
===Appearance & Fixes===
+
</translate><span id="Appearance_&_Fixes"></span><translate>
 +
 
 +
====Appearance & Fixes==== <!--T:51-->
 +
 
 +
<!--T:52-->
 
;No titlebar and frame
 
;No titlebar and frame
 
: Toggle whether to display the titlebar and frame around the window.
 
: Toggle whether to display the titlebar and frame around the window.
 +
 +
<!--T:53-->
 
;Active/Inactive opacity
 
;Active/Inactive opacity
 
: When the window is active/inactive, set its opacity to the percentage specified.
 
: When the window is active/inactive, set its opacity to the percentage specified.
 +
 +
<!--T:54-->
 
{{Tip|'''Active/Inactive opacity''' can only be affected when '''Desktop Effects''' are enabled.}}
 
{{Tip|'''Active/Inactive opacity''' can only be affected when '''Desktop Effects''' are enabled.}}
 +
 +
<!--T:55-->
 
; Moving/resizing
 
; Moving/resizing
 
: ''Deprecated as of >4.8''
 
: ''Deprecated as of >4.8''
 +
 +
<!--T:56-->
 
;Focus stealing prevention
 
;Focus stealing prevention
: When a window wants focus, control on a scale (from '''None''' to '''Extreme''') whether to honor the request and place above all other windows, or ignore its request (potentially leaving the window behind other windows):
+
: When a window wants focus, control on a scale (from '''None''' to '''Extreme''') whether to honor the request and place above all other windows, or ignore its request (potentially leaving the window behind other windows):</translate>
:* None - Always grant focus to the window.
+
<translate>
:* Low
+
<!--T:57-->
:* Normal
+
:* None - Always grant focus to the window.</translate>
:* High
+
<translate>
 +
<!--T:58-->
 +
:* Low</translate>
 +
<translate>
 +
<!--T:59-->
 +
:* Normal</translate>
 +
<translate>
 +
<!--T:60-->
 +
:* High</translate>
 +
<translate>
 +
<!--T:61-->
 
:* Extreme - The window's focus request is denied.  Focus is only granted by explicitly requesting via the  mousing.
 
:* Extreme - The window's focus request is denied.  Focus is only granted by explicitly requesting via the  mousing.
 +
 +
<!--T:62-->
 
{{Tip|See '''Accept focus''' to make a window read-only - not accept any keyboard input.}}
 
{{Tip|See '''Accept focus''' to make a window read-only - not accept any keyboard input.}}
 +
 +
<!--T:63-->
 
;Accept focus
 
;Accept focus
 
: Toggle whether the window accepts keyboard input.  Make the window read-only.
 
: Toggle whether the window accepts keyboard input.  Make the window read-only.
 +
 +
<!--T:64-->
 
;Ignore global shortcuts
 
;Ignore global shortcuts
: Toggle whether to ignore global shortcuts (as defined by '''kcmshell4 keys''') while the window is active.
+
: Toggle whether to ignore global shortcuts (as defined by <menuchoice>System Settings -> Shortcuts and Gestures -> Global Shortcuts</menuchoice> or by running <code>kcmshell4 keys</code> in '''konsole''') while the window is active.
 +
 
 +
<!--T:65-->
 
; Closeable
 
; Closeable
 
: Toggle whether to display the '''Close''' button on the title bar.
 
: Toggle whether to display the '''Close''' button on the title bar.
 +
 +
<!--T:66-->
 
{{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.}}
 
{{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.}}
 +
 +
<!--T:67-->
 
; Window type
 
; Window type
: Change the window to another type and inherit the characteristics of that window:
+
: Change the window to another type and inherit the characteristics of that window:</translate>
:* Normal Window
+
<translate>
:* Dialog Window
+
<!--T:68-->
:* Utility Window
+
:* Normal Window</translate>
:* Dock (panel)
+
<translate>
:* Toolbar
+
<!--T:69-->
:* Torn-Off Menu
+
:* Dialog Window</translate>
:* Splash Screen
+
<translate>
:* Desktop
+
<!--T:70-->
 +
:* Utility Window</translate>
 +
<translate>
 +
<!--T:71-->
 +
:* Dock (panel)</translate>
 +
<translate>
 +
<!--T:72-->
 +
:* Toolbar</translate>
 +
<translate>
 +
<!--T:73-->
 +
:* Torn-Off Menu</translate>
 +
<translate>
 +
<!--T:74-->
 +
:* Splash Screen</translate>
 +
<translate>
 +
<!--T:75-->
 +
:* Desktop</translate>
 +
<translate>
 +
<!--T:76-->
 
:* Standalone Menubar
 
:* Standalone Menubar
 +
 +
<!--T:77-->
 
{{Warning|Use with care because unwanted results may be introduced.  For example, a '''Splash Screen''' is a automatically closed by '''KWin''' when clicked.}}
 
{{Warning|Use with care because unwanted results may be introduced.  For example, a '''Splash Screen''' is a automatically closed by '''KWin''' when clicked.}}
 +
 +
<!--T:78-->
 
; Block compositing
 
; Block compositing
 
: Toggle whether to disable compositing while the window ''exists''.  If compositing is enabled and the rule specifies to disable compositing, while ''any'' matching window exists, compositing will be disabled.  Compositing is re-enabled when the last matching window terminates.
 
: Toggle whether to disable compositing while the window ''exists''.  If compositing is enabled and the rule specifies to disable compositing, while ''any'' matching window exists, compositing will be disabled.  Compositing is re-enabled when the last matching window terminates.
 +
 +
<!--T:79-->
 +
[[Category:Desktop]]
 +
[[Category:Tutorials]]
 +
 +
</translate>

Latest revision as of 20:50, 9 March 2012

Other languages:
English • ‎dansk • ‎українська

Window Attributes

Kwin-window-attributes.png

The attributes which can be set are grouped by function in three tabs:

  1. Size & Position
  2. Arrangement & Access
  3. Appearance & Fixes

Each attribute has a set of parameters which determines its disposition.

Parameters

Each attribute, minimally, accepts one of the following parameters. Additional, attribute-specific arguments are listed within each attribute definition.

Do Not Affect
Ensure a subsequent rule, which matches the window, does not affect the attribute.
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.

The difference between the two is at run-time, Apply Now allows the attribute to be changed and Force Temporarily prohibits it to be altered until all affected windows exit.
Warning.png
Warning
For Apply Now, if the rule has no other attributes set, the rule is deleted after evaluation whereas Force Temporarily, the rule is deleted after the last affected window terminates.

Attributes

Ktip.png
Tip
The Detect Window Properties button back-fills attribute-specific values - for more information see Window Matching. For example the height and width values of the Size attribute is set to the height and width of the detected window.


Ktip.png
Tip
Yes/No arguments are used to toggle on or off attributes. Leniency with grammar helps one understand how a setting will be processed. Face-smile.png For example, the attribute Skip taskbar, when set to No means do not skip the taskbar. In other words, show the window in the taskbar. Face-smile.png

Size & Position

Position
Position the window's upper left corner at the specified x,y coordinate.
Ktip.png
Tip
KWin's origin, (0,0), is the upper left of the desktop.


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.
Ktip.png
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 - staircase-by-title.
  • Centered - center of the desktop.
  • 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 position. To avoid conflicts between the default placement strategy and the window's request, the placement strategy is ignored when the window's request is accepted.
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 or base increment.

In order to understand this attribute, some background is required. Briefly, windows must request from the Window Manager, a base increment: the minimum number of height X width pixels per re-size request. Typically, it's 1x1. Other windows though, for example terminal emulators or editors, use fixed-fonts and request their base-increment according to the size of one character.

Arrangement & Access

Keep above, Keep below
Toggle whether to keep the window above/below all others.
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 current Autogroup.
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 pager:

Pager-4-desktops.png
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

No titlebar and frame
Toggle whether to display the titlebar and frame around the window.
Active/Inactive opacity
When the window is active/inactive, set its opacity to the percentage specified.
Ktip.png
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 request and place above all other windows, 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 explicitly requesting via the mousing.
Ktip.png
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 (as defined by System Settings -> Shortcuts and Gestures -> Global Shortcuts or by running kcmshell4 keys in konsole) while the window is active.
Closeable
Toggle whether to display the Close button on the title bar.
Ktip.png
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
Warning.png
Warning
Use with care because unwanted results may be introduced. For example, a Splash Screen is a automatically closed by KWin when clicked.


Block compositing
Toggle whether to disable compositing while the window exists. If compositing is enabled and the rule specifies to disable compositing, while any matching window exists, compositing will be disabled. Compositing is re-enabled when the last matching window terminates.

This page was last edited on 9 March 2012, at 20:50. Content is available under Creative Commons License SA 4.0 unless otherwise noted.