| 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>By default, the mouse is captured if the user clicks on the guest window and the guest expects relative mouse
|
|---|
| 8 | coordinates at this time. This happens if the pointing device is configured as PS/2 mouse and the guest has not
|
|---|
| 9 | yet started the <ph conkeyref="vbox-conkeyref-phrases/product-name"/> Guest Additions. For instance, the guest is
|
|---|
| 10 | booting or the Guest Additions are not installed, or if the pointing device is configured as a USB tablet but the
|
|---|
| 11 | guest has no USB driver loaded yet. Once the Guest Additions become active or the USB guest driver is started, the
|
|---|
| 12 | mouse capture is automatically released. </p>
|
|---|
| 13 | <p>The default behavior is sometimes not appropriate. Therefore it can be configured as follows: </p>
|
|---|
| 14 | <pre xml:space="preserve">VBoxManage setextradata <varname>VM-name</varname> GUI/MouseCapturePolicy <varname>mode</varname>
|
|---|
| 15 | </pre>
|
|---|
| 16 | <p><varname>mode</varname> is one of the following:
|
|---|
| 17 | </p>
|
|---|
| 18 | <dl>
|
|---|
| 19 | <dlentry>
|
|---|
| 20 | <dt>
|
|---|
| 21 | <codeph>Default</codeph>
|
|---|
| 22 | </dt>
|
|---|
| 23 | <dd>
|
|---|
| 24 | <p>The default behavior as described above. </p>
|
|---|
| 25 | </dd>
|
|---|
| 26 | </dlentry>
|
|---|
| 27 | <dlentry>
|
|---|
| 28 | <dt>
|
|---|
| 29 | <codeph>HostComboOnly</codeph>
|
|---|
| 30 | </dt>
|
|---|
| 31 | <dd>
|
|---|
| 32 | <p>The mouse is only captured if the Host Key is toggled. </p>
|
|---|
| 33 | </dd>
|
|---|
| 34 | </dlentry>
|
|---|
| 35 | <dlentry>
|
|---|
| 36 | <dt>
|
|---|
| 37 | <codeph>Disabled</codeph>
|
|---|
| 38 | </dt>
|
|---|
| 39 | <dd>
|
|---|
| 40 | <p>The mouse is never captured, also not by toggling the Host Key </p>
|
|---|
| 41 | </dd>
|
|---|
| 42 | </dlentry>
|
|---|
| 43 | </dl>
|
|---|
| 44 | <p>This is a per-VM setting. </p>
|
|---|
| 45 | </body>
|
|---|
| 46 |
|
|---|
| 47 | </topic>
|
|---|
