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 |
---|---|---|---|
251 | Method | __init__ | Constructor. |
282 | Method | clean | Undocumented |
287 | Method | to_xml | Dump the keyboard to an XML document. |
305 | Method | load_layout | Load the layout of the keyboard from an XML file. |
356 | Method | set_selector | Set the selector widget of the keyboard. |
375 | Method | do_focus | Undocumented |
389 | Method | move_selector | Move the selector in the specified direction. |
465 | Method | select_key | Move the selector to a given key on the keyboard. |
476 | Method | activate_key | Activate a key on the keyboard. |
492 | Method | do_key_press_event | Default handler for the key-press event. |
Inherited from Widget:
Line # | Kind | Name | Docs |
---|---|---|---|
92 | Method | _init_styles | Undocumented |
132 | Method | state__get | The present state of the widget |
136 | Method | state__set | Set the state of the widget and emit the "state-changed" signal if |
152 | Method | do_state_changed | Default 'state-changed' handler |
159 | Method | style__get | The present style |
163 | Method | style__set | Set the present style, after binding it to the widget and subscribing |
179 | Method | _style_property_changed | Undocumented |
183 | Method | do_style_set | Default 'style-set' signal handler |
188 | Method | _update_style_properties | Update the widget's appearence basing on the properties set. |
205 | Method | get_parent | Get the parent, if exists. |
213 | Method | get_children | Get the list of direct children. |
221 | Method | get_root | Get the root of the widget's tree hierarchy |
232 | Method | get_descendants | Get the list of nodes in the subtree |
246 | Method | focus__get | Whether the widget has focus |
250 | Method | focus__set | Set or unset the focus on the widget and emit the 'focus' signal. |
278 | Method | focus_child__get | Get the child with focus |
298 | Method | _do_real_key_press_event | Undocumented |
302 | Class Method | _demo_create_viewport | Undocumented |
309 | Class Method | _on_demo_delete | Undocumented |
349 | Class Method | demo | Create a demo widget, put it on a canvas and show it in a viewport. |
Inherited from Group (via Widget):
Line # | Kind | Name | Docs |
---|---|---|---|
66 | Method | canvas__set | Undocumented |
86 | Method | canvas__get | Undocumented |
91 | Method | layer__set | Undocumented |
104 | Method | layer__get | Undocumented |
112 | Method | add | Undocumented |
134 | Method | _proxy_child_signal_scrolled | Undocumented |
138 | Method | _proxy_child_signal | Undocumented |
142 | Method | _proxy_child_signal_with_pressure | Undocumented |
146 | Method | remove | Undocumented |
160 | Method | empty | Undocumented |
170 | Method | __len__ | Undocumented |
173 | Method | __iter__ | Undocumented |
176 | Method | update_absolute_x | Undocumented |
181 | Method | update_absolute_y | Undocumented |
186 | Method | update_absolute_z | Undocumented |
191 | Method | update_absolute_position | Undocumented |
196 | Method | update_absolute_width | Undocumented |
203 | Method | update_absolute_height | Undocumented |
210 | Method | update_absolute_size | Undocumented |
217 | Method | update_absolute_visible | Undocumented |
222 | Method | update_absolute_opacity | Undocumented |
228 | Method | regenerate | Undocumented |
232 | Method | absolute_width__get | Undocumented |
235 | Method | absolute_width__set | Undocumented |
240 | Method | absolute_height__get | Undocumented |
243 | Method | absolute_height__set | Undocumented |
248 | Method | absolute_x__get | Undocumented |
251 | Method | absolute_x__set | Undocumented |
257 | Method | absolute_y__get | Undocumented |
260 | Method | absolute_y__set | Undocumented |
266 | Method | absolute_z__get | Undocumented |
269 | Method | absolute_z__set | Undocumented |
Inherited from Node (via Widget, Group):
Line # | Kind | Name | Docs |
---|---|---|---|
36 | Method | parent__set | Undocumented |
55 | Method | parent__get | Undocumented |
60 | Method | x__get | Undocumented |
66 | Method | x__set | Undocumented |
82 | Method | y__get | Undocumented |
88 | Method | y__set | Undocumented |
105 | Method | z__get | Undocumented |
111 | Method | z__set | Undocumented |
128 | Method | position__get | Undocumented |
134 | Method | position__set | Undocumented |
158 | Method | width__get | Undocumented |
164 | Method | width__set | Undocumented |
182 | Method | height__get | Undocumented |
188 | Method | height__set | Undocumented |
208 | Method | size__get | Undocumented |
214 | Method | size__set | Undocumented |
234 | Method | visible__get | Undocumented |
240 | Method | visible__set | Undocumented |
258 | Method | opacity__get | Undocumented |
264 | Method | opacity__set | Undocumented |
Parameters | xml_file | the path to an XML file containing the keyboard layout
(type: str
) |
Returns | an XML document representating the keyboard
(type: xml.dom.minidom.Document
) |
Parameters | xml_file | the path to an XML file containing the keyboard layout
(type: str
) |
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.Parameters | direction | where 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 )
) |
Parameters | key | the new key to select
(type: Key
) |
Parameters | key | the key to activate
(type: Key
) |