Class e.p.p.w.o.OnScreenKeyboard(Widget):

Part of elisa.plugins.pigment.widgets.osk View In Hierarchy

Known subclasses: elisa.plugins.poblesec.widgets.osk.OSK

A configurable on-screen keyboard widget.

Its layout is defined in an XML file. It defines several caps that can be cycled through, changing the value emitted by each key.

Line # Kind Name Docs
266 Method __init__ Constructor.
297 Method clean Undocumented
317 Method to_xml Dump the keyboard to an XML document.
335 Method load_layout Load the layout of the keyboard from an XML file.
386 Method set_selector Set the selector widget of the keyboard.
404 Method do_focus Undocumented
418 Method move_selector Move the selector in the specified direction.
494 Method select_key Move the selector to a given key on the keyboard.
505 Method activate_key Activate a key on the keyboard.
521 Method do_key_press_event Default handler for the key-press event.
355 Method _render Render the layout of the keyboard.
407 Method _switch Undocumented
412 Method _button_clicked_cb Undocumented
539 Class Method _demo_widget Meant to be overidden by inheriting widgets for widget creation and
555 Class Method _set_demo_widget_defaults Undocumented

Inherited from Widget:

Line # Kind Name Docs
134 Method state__get The present state of the widget
138 Method state__set Set the state of the widget and emit the "state-changed" signal if
155 Method do_state_changed Default 'state-changed' handler
162 Method style__get The present style
166 Method style__set Set the present style, after binding it to the widget and subscribing
193 Method do_style_set Default 'style-set' signal handler
275 Method update_style_properties Update the widget's appearence basing on the properties set.
312 Method get_parent Get the parent, if exists.
320 Method get_children Get the list of direct children.
328 Method get_root Get the root of the widget's tree hierarchy
339 Method get_descendants Get the list of nodes in the subtree
376 Method focus__get Whether the widget has focus
380 Method focus__set Set the focus state on the widget emitting the 'focus' signal on the
417 Method focus_child__get Get the child with focus
492 Class Method demo Create a demo widget, put it on a canvas and show it in a viewport.
96 Method _init_styles Undocumented
189 Method _style_property_changed Undocumented
198 Method _parse_style_key Parse a style property key into a couple (widget, attribute name).
236 Method _parse_style_value Parse a style property value.
353 Method _set_focused Set or unset the focused widget and update the focused child property of
435 Method _do_real_key_press_event Undocumented
445 Class Method _demo_create_viewport Undocumented
452 Class Method _on_demo_delete Undocumented

Inherited from Group (via Widget):

Line # Kind Name Docs
85 Method canvas__set Undocumented
105 Method canvas__get Undocumented
110 Method layer__set Undocumented
123 Method layer__get Undocumented
131 Method add Undocumented
173 Method remove Undocumented
192 Method empty Undocumented
202 Method __len__ Undocumented
205 Method __iter__ Undocumented
208 Method update_absolute_x Undocumented
215 Method update_absolute_y Undocumented
222 Method update_absolute_z Undocumented
229 Method update_absolute_position Undocumented
236 Method update_absolute_width Undocumented
245 Method update_absolute_height Undocumented
254 Method update_absolute_size Undocumented
263 Method update_absolute_visible Undocumented
268 Method update_absolute_opacity Undocumented
274 Method regenerate Undocumented
161 Method _proxy_child_signal_scrolled Undocumented
165 Method _proxy_child_signal Undocumented
169 Method _proxy_child_signal_with_pressure Undocumented

Inherited from Node (via Widget, Group):

Line # Kind Name Docs
39 Method absolute_width__get Undocumented
42 Method absolute_width__set Undocumented
47 Method absolute_height__get Undocumented
50 Method absolute_height__set Undocumented
55 Method absolute_x__get Undocumented
58 Method absolute_x__set Undocumented
64 Method absolute_y__get Undocumented
67 Method absolute_y__set Undocumented
73 Method absolute_z__get Undocumented
76 Method absolute_z__set Undocumented
82 Method parent__set Undocumented
95 Method parent__get Undocumented
100 Method x__get Undocumented
106 Method x__set Undocumented
122 Method y__get Undocumented
128 Method y__set Undocumented
145 Method z__get Undocumented
151 Method z__set Undocumented
168 Method position__get Undocumented
174 Method position__set Undocumented
198 Method width__get Undocumented
204 Method width__set Undocumented
222 Method height__get Undocumented
228 Method height__set Undocumented
248 Method size__get Undocumented
254 Method size__set Undocumented
274 Method visible__get Undocumented
280 Method visible__set Undocumented
297 Method opacity__get Undocumented
303 Method opacity__set Undocumented
def __init__(self, xml_file):
Constructor.
Parametersxml_filethe path to an XML file containing the keyboard layout (type: str )
def clean(self):
Undocumented
def to_xml(self):
Dump the keyboard to an XML document.
Returnsan XML document representating the keyboard (type: xml.dom.minidom.Document )
def load_layout(self, xml_file):
Load the layout of the keyboard from an XML file.
Parametersxml_filethe path to an XML file containing the keyboard layout (type: str )
def _render(self):
Render the layout of the keyboard.
def set_selector(self):
Set the selector widget of the keyboard.

This one is a default ugly selector. This method should be overwritten by subclasses to provide a better looking selector.

def do_focus(self, focus):
Undocumented
def _switch(self):
Undocumented
def _button_clicked_cb(self, button, x, y, z, mbutton, time, data, key):
Undocumented
def move_selector(self, direction):
Move the selector in the specified direction.
Parametersdirectionwhere to move the cursor (type: one of (elisa.plugins.pigment.widgets.const.LEFT, elisa.plugins.pigment.widgets.const.RIGHT, elisa.plugins.pigment.widgets.const.TOP, elisa.plugins.pigment.widgets.const.BOTTOM) )
def select_key(self, key):
Move the selector to a given key on the keyboard.
Parameterskeythe new key to select (type: Key )
def activate_key(self, key):
Activate a key on the keyboard.
Parameterskeythe key to activate (type: Key )
def do_key_press_event(self, viewport, event, widget):
Default handler for the key-press event.

Can be overwritten in subclasses for specific behaviours.

@classmethod
def _demo_widget(cls, *args, **kwargs):
Meant to be overidden by inheriting widgets for widget creation and setup at demo time.
Returnselisa.plugins.pigment.widgets.Widget
@classmethod
def _set_demo_widget_defaults(cls, widget, canvas, viewport):
Undocumented
API Documentation for Elisa Media Center, generated by pydoctor at 2009-02-16 19:15:05.