| 1 | <?xml version='1.0' encoding='UTF-8'?>
|
|---|
| 2 | <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
|
|---|
| 3 | <topic xml:lang="en-us" id="mouse-capture">
|
|---|
| 4 | <title>Configuring Automatic Mouse Capturing</title>
|
|---|
| 5 |
|
|---|
| 6 | <body>
|
|---|
| 7 | <p>
|
|---|
| 8 | By default, the mouse is captured if the user clicks on the
|
|---|
| 9 | guest window and the guest expects relative mouse coordinates at
|
|---|
| 10 | this time. This happens if the pointing device is configured as
|
|---|
| 11 | PS/2 mouse and the guest has not yet started the <ph conkeyref="vbox-conkeyref-phrases/product-name"/>
|
|---|
| 12 | Guest Additions. For instance, the guest is booting or the Guest
|
|---|
| 13 | Additions are not installed, or if the pointing device is
|
|---|
| 14 | configured as a USB tablet but the guest has no USB driver
|
|---|
| 15 | loaded yet. Once the Guest Additions become active or the USB
|
|---|
| 16 | guest driver is started, the mouse capture is automatically
|
|---|
| 17 | released.
|
|---|
| 18 | </p>
|
|---|
| 19 | <p>
|
|---|
| 20 | The default behavior is sometimes not desired. Therefore it can
|
|---|
| 21 | be configured as follows:
|
|---|
| 22 | </p>
|
|---|
| 23 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> GUI/MouseCapturePolicy <varname>mode</varname>
|
|---|
| 24 | </pre>
|
|---|
| 25 | <p><varname>mode</varname> is one of the following:
|
|---|
| 26 | </p>
|
|---|
| 27 | <dl>
|
|---|
| 28 | <dlentry>
|
|---|
| 29 | <dt>
|
|---|
| 30 | <codeph>Default</codeph>
|
|---|
| 31 | </dt>
|
|---|
| 32 | <dd>
|
|---|
| 33 | <p>
|
|---|
| 34 | The default behavior as described above.
|
|---|
| 35 | </p>
|
|---|
| 36 | </dd>
|
|---|
| 37 | </dlentry>
|
|---|
| 38 | <dlentry>
|
|---|
| 39 | <dt>
|
|---|
| 40 | <codeph>HostComboOnly</codeph>
|
|---|
| 41 | </dt>
|
|---|
| 42 | <dd>
|
|---|
| 43 | <p>
|
|---|
| 44 | The mouse is only captured if the Host Key is toggled.
|
|---|
| 45 | </p>
|
|---|
| 46 | </dd>
|
|---|
| 47 | </dlentry>
|
|---|
| 48 | <dlentry>
|
|---|
| 49 | <dt>
|
|---|
| 50 | <codeph>Disabled</codeph>
|
|---|
| 51 | </dt>
|
|---|
| 52 | <dd>
|
|---|
| 53 | <p>
|
|---|
| 54 | The mouse is never captured, also not by toggling the Host
|
|---|
| 55 | Key
|
|---|
| 56 | </p>
|
|---|
| 57 | </dd>
|
|---|
| 58 | </dlentry>
|
|---|
| 59 | </dl>
|
|---|
| 60 | <p>
|
|---|
| 61 | This is a per-VM setting.
|
|---|
| 62 | </p>
|
|---|
| 63 | </body>
|
|---|
| 64 |
|
|---|
| 65 | </topic>
|
|---|
