Back to index

unity  6.0.0
Public Member Functions | Static Public Attributes
unity.emulators.shortcut_hint.ShortcutController Class Reference
Inheritance diagram for unity.emulators.shortcut_hint.ShortcutController:
Inheritance graph
[legend]
Collaboration diagram for unity.emulators.shortcut_hint.ShortcutController:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def get_shortcut_view
def show
def ensure_visible
def hide
def ensure_hidden
def cancel
def get_show_timeout

Static Public Attributes

string DBUS_SERVICE = "com.canonical.Unity"
string DBUS_OBJECT = "/com/canonical/Unity/Debug"

Detailed Description

ShortcutController proxy class.

Definition at line 23 of file shortcut_hint.py.


Member Function Documentation

Definition at line 54 of file shortcut_hint.py.

00054 
00055     def cancel(self):
00056         logger.debug("Hide the shortcut hint with keyboard, without releasing the reveal key.")
00057         self.keybinding("shortcuthint/cancel")

Block until the shortcut hint is hidden.

Definition at line 47 of file shortcut_hint.py.

00047 
00048     def ensure_hidden(self):
00049         """Block until the shortcut hint is hidden."""
00050         if self.visible:
00051             logger.debug("Un-revealing shortcut hint with keyboard.")
00052             self.keybinding_release("shortcuthint/reveal")
00053             self.visible.wait_for(False)

Here is the call graph for this function:

Block until the shortcut hint is visible.

Definition at line 35 of file shortcut_hint.py.

00035 
00036     def ensure_visible(self):
00037         """Block until the shortcut hint is visible."""
00038         if not self.visible:
00039             logger.debug("Revealing shortcut hint with keyboard.")
00040             self.keybinding_hold("shortcuthint/reveal")
00041             self.visible.wait_for(True)

Here is the call graph for this function:

Definition at line 26 of file shortcut_hint.py.

00026 
00027     def get_shortcut_view(self):
00028         views = self.get_children_by_type(ShortcutView)
00029         return views[0] if views else None

Definition at line 58 of file shortcut_hint.py.

00058 
00059     def get_show_timeout(self):
00060         return self.timeout_duration / 1000.0
Release the keys keeping the shortcut hint open, but don't block.

Definition at line 42 of file shortcut_hint.py.

00042 
00043     def hide(self):
00044         """Release the keys keeping the shortcut hint open, but don't block."""
00045         logger.debug("Un-revealing shortcut hint with keyboard.")
00046         self.keybinding_release("shortcuthint/reveal")

Push the keys necessary to reveal the shortcut hint, but don't block.

Definition at line 30 of file shortcut_hint.py.

00030 
00031     def show(self):
00032         """Push the keys necessary to reveal the shortcut hint, but don't block."""
00033         logger.debug("Revealing shortcut hint with keyboard.")
00034         self.keybinding_hold("shortcuthint/reveal")


Member Data Documentation

string unity.emulators.UnityIntrospectionObject.DBUS_OBJECT = "/com/canonical/Unity/Debug" [static, inherited]

Definition at line 19 of file __init__.py.

string unity.emulators.UnityIntrospectionObject.DBUS_SERVICE = "com.canonical.Unity" [static, inherited]

Definition at line 18 of file __init__.py.


The documentation for this class was generated from the following file: