Help:Actions

From Openbox

(Difference between revisions)
Jump to: navigation, search
Line 33: Line 33:
 
<keybind key="W-t">
 
<keybind key="W-t">
 
   <action name="Execute"><execute>xterm</execute></action>
 
   <action name="Execute"><execute>xterm</execute></action>
 +
</keybind>
 +
</pre></code>
 +
 +
=== NextWindow ===
 +
Cycles focus to the next window.
 +
{|
 +
!Option
 +
!Default Value
 +
!Description
 +
|-
 +
|<dialog>
 +
|style="text-align:center"|yes
 +
|A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
 +
|-
 +
|<allDesktops>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
 +
|-
 +
|<panels>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar.  This can be combined with <desktop>.
 +
|-
 +
|<desktop>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE).  This can be combined with <panels>.
 +
|-
 +
|<linear>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.
 +
|}
 +
 +
Example:
 +
<code><pre>
 +
<keybind key="A-Tab">
 +
  <action name="NextWindow"/>
 +
</keybind>
 +
<keybind key="C-A-Tab">
 +
  <action name="NextWindow">
 +
    <panels>yes</panels>
 +
    <desktop>yes</desktop>
 +
  </action>
 +
</keybind>
 +
</pre></code>
 +
 +
=== PreviousWindow ===
 +
Cycles focus to the previous window.
 +
{|
 +
!Option
 +
!Default Value
 +
!Description
 +
|-
 +
|<dialog>
 +
|style="text-align:center"|yes
 +
|A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
 +
|-
 +
|<allDesktops>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
 +
|-
 +
|<panels>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar.  This can be combined with <desktop>.
 +
|-
 +
|<desktop>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE).  This can be combined with <panels>.
 +
|-
 +
|<linear>
 +
|style="text-align:center"|no
 +
|A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.
 +
|}
 +
 +
Example:
 +
<code><pre>
 +
<keybind key="A-S-Tab">
 +
  <action name="PreviousWindow"/>
 +
</keybind>
 +
<keybind key="C-A-S-Tab">
 +
  <action name="PreviousWindow">
 +
    <panels>yes</panels>
 +
    <desktop>yes</desktop>
 +
  </action>
 
</keybind>
 
</keybind>
 
</pre></code>
 
</pre></code>

Revision as of 19:02, 4 June 2007

Contents

Global actions

These actions are not used to manipulate windows. As such, they work whether a window is currently focused or not.

Execute

Runs a program

Option Default Value Description
<execute> "" A string which is the command to be executed, along with any arguments to be passed to it. The "~" tilde character will be expanded to your home directory, but no other shell expansions or scripting syntax may be used in the command.
<startupnotify><enabled> no A boolean (yes/no) which says if the startup notification protocol should be used to notify other programs that an application is launching.

Example: 

<keybind key="W-space">
  <action name="Execute">
    <startupnotify>
      <enabled>yes</enabled>
      <name>Terminal</name>
    </startupnotify>
    <execute>gnome-terminal</execute>
  </action>
</keybind>

<keybind key="W-t">
  <action name="Execute"><execute>xterm</execute></action>
</keybind>

NextWindow

Cycles focus to the next window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
<allDesktops> no A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
<panels> no A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar. This can be combined with <desktop>.
<desktop> no A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE). This can be combined with <panels>.
<linear> no A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.

Example: 

<keybind key="A-Tab">
  <action name="NextWindow"/>
</keybind>
<keybind key="C-A-Tab">
  <action name="NextWindow">
    <panels>yes</panels>
    <desktop>yes</desktop>
  </action>
</keybind>

PreviousWindow

Cycles focus to the previous window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with icons for all the windows which can be focused.
<allDesktops> no A boolean (yes/no) which when enabled lets you cycle focus between windows on all desktops, instead of only on the current desktop.
<panels> no A boolean (yes/no) which when enabled lets you cycle focus to/between panel windows such as your taskbar. This can be combined with <desktop>.
<desktop> no A boolean (yes/no) which when enabled lets you cycle focus to the desktop window, if one exists (such as in GNOME or KDE). This can be combined with <panels>.
<linear> no A boolean (yes/no) which when enabled causes focus to cycle in a fixed ordering, rather than in the order which windows have been last focused.

Example: 

<keybind key="A-S-Tab">
  <action name="PreviousWindow"/>
</keybind>
<keybind key="C-A-S-Tab">
  <action name="PreviousWindow">
    <panels>yes</panels>
    <desktop>yes</desktop>
  </action>
</keybind>

DirectionalFocusNorth

Cycles focus to the window north of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Up">
  <action name="DirectionalFocusNorth"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusSouth

Cycles focus to the window south of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Down">
  <action name="DirectionalFocusSouth"/>
</keybind>

DirectionalFocusEast

Cycles focus to the window east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Right">
  <action name="DirectionalFocusEast"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusWest

Cycles focus to the window west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Left">
  <action name="DirectionalFocusWest"/>
</keybind>

DirectionalFocusNorthWest

Cycles focus to the window north-west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Up">
  <action name="DirectionalFocusNorthWest"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusNorthEast

Cycles focus to the window north-east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Up">
  <action name="DirectionalFocusNorthEast"/>
</keybind>

DirectionalFocusSouthWest

Cycles focus to the window south-west of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Up">
  <action name="DirectionalFocusSouthWest"><dialog>yes</dialog></action>
</keybind>

DirectionalFocusSouthEast

Cycles focus to the window South-east of the currently focused window.

Option Default Value Description
<dialog> yes A boolean (yes/no) which specifies if a dialog is shown on screen with the name and icon of the window which will be focused.

Example: 

<keybind key="W-Up">
  <action name="DirectionalFocusSouthEast"/>
</keybind>
Retrieved from "http://openbox.org/oldwiki/index.php?title=Help:Actions&oldid=838"
Personal tools