org.virtualbox_5_1
Class IKeyboard

java.lang.Object
  extended by org.virtualbox_5_1.IUnknown
      extended by org.virtualbox_5_1.IKeyboard

public class IKeyboard
extends IUnknown

The IKeyboard interface represents the virtual machine's keyboard. Used inIConsole.getKeyboard(). Use this interface to send keystrokes or the Ctrl-Alt-Del sequence to the virtual machine. Interface ID: {DA91D4C9-4C02-FDB1-C5AC-D89E22E81302}


Field Summary
 
Fields inherited from class org.virtualbox_5_1.IUnknown
obj, objMgr, port
 
Constructor Summary
IKeyboard(java.lang.String wrapped, org.virtualbox_5_1.ObjectRefManager objMgr, org.virtualbox_5_1.jaxws.VboxPortType port)
           
 
Method Summary
 IEventSource getEventSource()
          Event source for keyboard events.
 java.util.List<KeyboardLED> getKeyboardLEDs()
          Current status of the guest keyboard LEDs.
 void putCAD()
          Sends the Ctrl-Alt-Del sequence to the keyboard.
 void putScancode(java.lang.Integer scancode)
          Sends a scancode to the keyboard.
 java.lang.Long putScancodes(java.util.List<java.lang.Integer> scancodes)
          Sends an array of scancodes to the keyboard.
static IKeyboard queryInterface(IUnknown obj)
           
 void releaseKeys()
          Causes the virtual keyboard to release any keys which are currently pressed.
 
Methods inherited from class org.virtualbox_5_1.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IKeyboard

public IKeyboard(java.lang.String wrapped,
                 org.virtualbox_5_1.ObjectRefManager objMgr,
                 org.virtualbox_5_1.jaxws.VboxPortType port)
Method Detail

getKeyboardLEDs

public java.util.List<KeyboardLED> getKeyboardLEDs()
Current status of the guest keyboard LEDs.

Returns:
List<org.virtualbox_5_1.KeyboardLED>

getEventSource

public IEventSource getEventSource()
Event source for keyboard events.

Returns:
org.virtualbox_5_1.IEventSource

queryInterface

public static IKeyboard queryInterface(IUnknown obj)

putScancode

public void putScancode(java.lang.Integer scancode)
Sends a scancode to the keyboard. Expected result codes:
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERRORCould not send scan code to virtual keyboard.


putScancodes

public java.lang.Long putScancodes(java.util.List<java.lang.Integer> scancodes)
Sends an array of scancodes to the keyboard. Expected result codes:
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERRORCould not send all scan codes to virtual keyboard.


putCAD

public void putCAD()
Sends the Ctrl-Alt-Del sequence to the keyboard. This function is nothing special, it is just a convenience function callingputScancodes(List)with the proper scancodes. Expected result codes:
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERRORCould not send all scan codes to virtual keyboard.


releaseKeys

public void releaseKeys()
Causes the virtual keyboard to release any keys which are currently pressed. Useful when host and guest keyboard may be out of sync. Expected result codes:
@link ::VBOX_E_IPRT_ERROR VBOX_E_IPRT_ERRORCould not release some or all keys.