doc/commands/BusyCursor.xml

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