1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
<?xml version="1.0" encoding="UTF-8" ?>
<!-- $Id$ -->
<!DOCTYPE part PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"../docbook-xml/docbookx.dtd"
[
<!ENTITY % myents SYSTEM "../fvwm.ent" >
%myents;
]>
<section id='BusyCursor'>
<title>BusyCursor</title>
<cmdsynopsis>
<command>BusyCursor</command
><arg choice='plain' rep='repeat'
><arg choice='opt'
><replaceable>Option</replaceable
> <replaceable>bool</replaceable
></arg
>,</arg>
</cmdsynopsis>
<para>This command controls the cursor during the execution of certain
commands.
<replaceable>Option</replaceable>
can be
<emphasis>DynamicMenu</emphasis>,
<emphasis>ModuleSynchronous</emphasis>,
<emphasis>Read</emphasis>,
<emphasis>Wait</emphasis> or
<emphasis>*</emphasis>.
An option must be followed by a boolean argument
<replaceable>bool</replaceable>.
You can use commas to separate individual options. If you set an
option to "True", then when the corresponding command is run, fvwm
displays the cursor of the
<fvwmref cmd="CursorStyle" opt="WAIT"/>
context of the
<fvwmref cmd="CursorStyle"/>
command. "False" forces to not display the cursor. The default is:</para>
<programlisting>
BusyCursor DynamicMenu False, ModuleSynchronous False, \
Read False, Wait False
</programlisting>
<para>
The <fvwmopt cmd="BusyCursor" opt="*"/> option
refers to all available options.</para>
<para>
The <fvwmopt cmd="BusyCursor" opt="Read"/>
option controls the <fvwmref cmd="PipeRead"/> command.</para>
<para>
The <fvwmopt cmd="BusyCursor" opt="DynamicMenu"/>
option affects the <fvwmref cmd="AddToMenu" opt="DynamicPopupAction"/>
and <fvwmref cmd="AddToMenu" opt="MissingSubmenuFunction"/>
options of the <fvwmref cmd="AddToMenu"/>
command. If this option is set to "False", then the busy cursor
is not displayed during a dynamic menu command even if this
command is a <fvwmref cmd="Read"/> or <fvwmref cmd="PipeRead"/>
command and the <emphasis>Read</emphasis>
option is set to "True".</para>
<para>The <fvwmopt cmd="BusyCursor" opt="ModuleSynchronous"/>
option affects the <fvwmref cmd="ModuleSynchronous"/> command.
If this option is set to "False", then the busy cursor is not
displayed while fvwm waits for a module started by
<fvwmref cmd="ModuleSynchronous"/> to complete its startup.</para>
<para>
The <fvwmopt cmd="BusyCursor" opt="Wait"/>
option affects only the root cursor. During a wait pause the root
cursor is replaced by the busy cursor and fvwm is still fully
functional (you can escape from the pause, see the
<fvwmref cmd="EscapeFunc"/>
command). If you want to use this option and if you do not use
the default root cursor, you must set your root cursor with the
<fvwmref cmd="CursorStyle"/> command.</para>
</section>
|