Files
deb-python-pyvmomi/docs/vim/vm/device/VirtualPointingDevice/DeviceBackingInfo.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

19 lines
1.3 KiB
ReStructuredText

.. _str: https://docs.python.org/2/library/stdtypes.html
.. _VirtualPointingDeviceOption: ../../../../vim/vm/device/VirtualPointingDeviceOption.rst
.. _VirtualPointingDeviceHostChoice: ../../../../vim/vm/device/VirtualPointingDeviceOption/DeviceBackingOption/HostPointingDeviceChoice.rst
.. _vim.vm.device.VirtualDevice.DeviceBackingInfo: ../../../../vim/vm/device/VirtualDevice/DeviceBackingInfo.rst
vim.vm.device.VirtualPointingDevice.DeviceBackingInfo
=====================================================
The VirtualPointingDevice.DeviceBackingInfo provides information about the physical mouse backing the VirtualPointingDevice data object type.
:extends: vim.vm.device.VirtualDevice.DeviceBackingInfo_
Attributes:
hostPointingDevice (`str`_):
This optional property defines the mouse type (two-button, three-button, and so on). The mouse type determines how the user interacts with the host mouse. The valid values are specified in the `VirtualPointingDeviceHostChoice`_ list.Note: The value specified by this property must be one of the supported types listed in the hostPointingDevices.value array in the `VirtualPointingDeviceOption`_ data object type. If this property is not set, then the property defaults to the hostPointingDevices.defaultIndex property in the same data object type.