U Pey@s.dZdZddlmZddlmZddlmZddlm Z ddl m Z ddl m Z mZmZmZmZmZmZmZdd lmZdd lmZmZmZdd lmZdd lmZdd lm Z ddl!m"Z"ddl#m$Z$m%Z%m&Z&ddl'm(Z(ddl)m*Z*e$edZ+Gddde Z,e-dkr*ddl.m/Z/e,ddZ0e/e0dS)uJ VKeyboard ========= .. image:: images/vkeyboard.jpg :align: right .. versionadded:: 1.0.8 VKeyboard is an onscreen keyboard for Kivy. Its operation is intended to be transparent to the user. Using the widget directly is NOT recommended. Read the section `Request keyboard`_ first. Modes ----- This virtual keyboard has a docked and free mode: * docked mode (:attr:`VKeyboard.docked` = True) Generally used when only one person is using the computer, like a tablet or personal computer etc. * free mode: (:attr:`VKeyboard.docked` = False) Mostly for multitouch surfaces. This mode allows multiple virtual keyboards to be used on the screen. If the docked mode changes, you need to manually call :meth:`VKeyboard.setup_mode` otherwise the change will have no impact. During that call, the VKeyboard, implemented on top of a :class:`~kivy.uix.scatter.Scatter`, will change the behavior of the scatter and position the keyboard near the target (if target and docked mode is set). Layouts ------- The virtual keyboard is able to load a custom layout. If you create a new layout and put the JSON in :file:`/keyboards/.json`, you can load it by setting :attr:`VKeyboard.layout` to your layoutid. The JSON must be structured like this:: { "title": "Title of your layout", "description": "Description of your layout", "cols": 15, "rows": 5, ... } Then, you need to describe the keys in each row, for either a "normal", "shift" or a "special" (added in version 1.9.0) mode. Keys for this row data must be named `normal_`, `shift_` and `special_`. Replace `row` with the row number. Inside each row, you will describe the key. A key is a 4 element list in the format:: [ , , , ] Here are example keys:: # f key ["f", "f", "f", 1] # capslock ["↹", " ", "tab", 1.5] Finally, complete the JSON:: { ... "normal_1": [ ["`", "`", "`", 1], ["1", "1", "1", 1], ["2", "2", "2", 1], ["3", "3", "3", 1], ["4", "4", "4", 1], ["5", "5", "5", 1], ["6", "6", "6", 1], ["7", "7", "7", 1], ["8", "8", "8", 1], ["9", "9", "9", 1], ["0", "0", "0", 1], ["+", "+", "+", 1], ["=", "=", "=", 1], ["⌫", null, "backspace", 2] ], "shift_1": [ ... ], "normal_2": [ ... ], "special_2": [ ... ], ... } Request Keyboard ---------------- The instantiation of the virtual keyboard is controlled by the configuration. Check `keyboard_mode` and `keyboard_layout` in the :doc:`api-kivy.config`. If you intend to create a widget that requires a keyboard, do not use the virtual keyboard directly, but prefer to use the best method available on the platform. Check the :meth:`~kivy.core.window.WindowBase.request_keyboard` method in the :doc:`api-kivy.core.window`. If you want a specific layout when you request the keyboard, you should write something like this (from 1.8.0, numeric.json can be in the same directory as your main.py):: keyboard = Window.request_keyboard( self._keyboard_close, self) if keyboard.widget: vkeyboard = self._keyboard.widget vkeyboard.layout = 'numeric.json' ) VKeyboard) kivy_data_dir)Vector)Config)Scatter)Label)ObjectPropertyNumericPropertyStringPropertyBooleanProperty DictPropertyOptionProperty ListProperty ColorProperty)Logger)Color BorderImageCanvas)Image) resource_find)Clock)open)joinsplitextbasename)listdir)loadsZ keyboardscseZdZdZedddZedddZedZee Z e iZ e dZeddddgZeddddgZed Zed d d d gZed Zed Zed d d d gZed Zed ZedZeddddgZeddddgZedddZe iZ e dZ!e dZ"e dZ#e iZ$edZ%eddZ&dZ'dZ(dZ)fddZ*ddZ+ddZ,ddZ-ddZ.d d!Z/d"d#Z0d$d%Z1d&d'Z2d(d)Z3d*d+Z4dNd,d-Z5d.d/Z6d0d1Z7d2d3Z8d4d5Z9d6d7Z:d8d9Z;d:d;Zd?Z>d@dAZ?dBdCZ@dDdEZAdFdGZBdHdIZCfdJdKZDfdLdMZEZFS)Ora VKeyboard is an onscreen keyboard with multitouch support. Its layout is entirely customizable and you can switch between available layouts using a button in the bottom right of the widget. :Events: `on_key_down`: keycode, internal, modifiers Fired when the keyboard received a key down event (key press). `on_key_up`: keycode, internal, modifiers Fired when the keyboard received a key up event (key release). NT)Z allownoneF皙?gQ?g4@z5atlas://data/images/defaulttheme/vkeyboard_backgroundz>atlas://data/images/defaulttheme/vkeyboard_disabled_backgroundz5atlas://data/images/defaulttheme/vkeyboard_key_normalz3atlas://data/images/defaulttheme/vkeyboard_key_downnormal)r"shiftspecial)optionszdata/fonts/DejaVuSans.ttf) on_key_down on_key_up on_textinputc snd|kr$d|krd|_d|kr$d|_d|krHd|kr:d|_d|krHd|_d |krVd |_d |krdd |_d |krrd|_t|j }|_ t|j }|_ t|j }|_|j}|d |j|d||d||d||d||d|tt|jf|| |j}|std|jdkr8tdd|_n|| |jt|_t|_W5QRXdS)NZ size_hint size_hint_x size_hint_ysizewidthiheight scale_ming? scale_maxg?dockedF have_shift have_capslock have_special layout_pathlayoutz)VKeyboard: unable to load default layoutskivyZkeyboard_layout)r)r*r,r-r/r0r1rZcreate_trigger_update_layout_modeZ_trigger_update_layout_mode _load_layouts_trigger_load_layouts _load_layoutZ_trigger_load_layoutfbind setup_modesuperr__init__available_layoutsrcriticalr6rgetZcanvasrbackground_key_layeractive_keys_layer)selfkwargs layout_modeZlayoutsr6r<r@ __class__6/tmp/pip-unpacked-wheel-xzebddm3/kivy/uix/vkeyboard.pyr?^sX           zVKeyboard.__init__cCs |dSN) refresh_keys)rEinstancevaluerJrJrK on_disabledszVKeyboard.on_disabledcGs@|j|jk}|rdnd}|jr"d}||jkr<||_|ddS)Nr#r"r$F)r3r2r4rGrefresh)rElmoderJrJrKr8s   zVKeyboard._update_layout_modecGs|jjr||j|j}|j}|jdddkrX||krXt|j}|||j|s`dS||kr|dkrt d|d|_| ddS)N.jsonZqwertyzXVkeyboard: <%s> keyboard layout mentioned in conf file was not found, fallback on qwertyT) r:Z is_triggeredr9cancelr6r@r_load_layout_fnrerrorrQ)rElargsrOr@fnrJrJrKr;s&  zVKeyboard._load_layoutcGs6|j}t|D]"}|t||tt|dqdS)Nr)r5rrWrrr)rErYrOrZrJrJrKr9s   zVKeyboard._load_layoutsc CsP|j}|dddkrdSt|ddd}|}t|}W5QRX|||<dS)NrTrUrzutf-8)encoding)r@rreadr)rErZnamer@fdZ json_contentr6rJrJrKrWszVKeyboard._load_layout_fncGs|jr|n|dS)aCall this method when you want to readjust the keyboard according to options: :attr:`docked` or not, with attached :attr:`target` or not: * If :attr:`docked` is True, it will call :meth:`setup_mode_dock` * If :attr:`docked` is False, it will call :meth:`setup_mode_free` Feel free to overload these methods to create new positioning behavior. N)r1setup_mode_docksetup_mode_freerErYrJrJrKr=s  zVKeyboard.setup_modecGsNd|_d|_d|_d|_|}|jt|j}||_d|_|j |j ddS)aVSetup the keyboard in docked mode. Dock mode will reset the rotation, disable translation, rotation and scale. Scale and position will be automatically adjusted to attach the keyboard to the bottom of the screen. .. note:: Don't call this method directly, use :meth:`setup_mode` instead. Frrr)Z on_resizeN) do_translation do_rotationdo_scalerotationget_parent_windowr,floatscaleposbind_update_dock_mode)rErYwinrjrJrJrKr`s zVKeyboard.setup_mode_dockcGs |jt|j}||_d|_dS)Nrc)r,rirjrk)rErnrYrjrJrJrKrmszVKeyboard._update_dock_modec Csd|_d|_d|_|j}|s dStdd}t|dd}t|dd|}|| |_t||jd|j }t||j |j }||}t|j |jd|j |j t| |jd|j }||8}| |_dS)aSetup the keyboard in free mode. Free mode is designed to let the user control the position and orientation of the keyboard. The only real usage is for a multiuser environment, but you might found other ways to use it. If a :attr:`target` is set, it will place the vkeyboard under the target. .. note:: Don't call this method directly, use :meth:`setup_mode` instead. TNrrg@)rdrerftargetrZ to_windowZanglergr,r-Zcenter_xyxZ to_parentrk) rEroabcZdposcposZdiffZdiff2rJrJrKras$  zVKeyboard.setup_mode_freecCsdSrLrJ)rErJrJrK change_layout&szVKeyboard.change_layoutcCs(||r|||dS)ze(internal) Recreate the entire widget and graphics according to the selected layout. N)Z clear_widgetsrefresh_keys_hintrMrefresh_active_keys_layer)rEforcerJrJrKrQ*s zVKeyboard.refreshc Cs|j|j}|j}t|j}t|ddj}|jHt|j | D].\}}|d||\}}t ||||j dqHW5QRXdS)NTZmipmapLINE_%dtexturerkr+border) rDclear active_keyslayout_geometryrkey_background_downrr}rkey_background_colorvaluesr key_border) rErr backgroundr}line_nbindexrkr+rJrJrKrx4s   z#VKeyboard.refresh_active_keys_layercCs |j|j}|d}|d}|j}|j\}}}}d||} d||} d|} d|} d|| } d|| }| |f|d<| | }td|dD]n}||8}d|j|f}d|}g||<| }||D]6}||||f|d | |fg||d | 7}qq||_dS) Ncolsrows?rU_HINTr%s_%d LINE_HINT_%d)r@r6r margin_hintrangerGappend)rEr6Z layout_cols layout_rowsrmtopmrightmbottommleftZel_hintZeh_hintZex_hintZey_hintuw_hintuh_hintZcurrent_y_hintrZ line_nameZ line_hintZcurrent_x_hintkeyrJrJrKrwCs4       zVKeyboard.refresh_keys_hintcCs|j|j}|d}|j}|j\}}|j\}}}} |d\} } td|dD]} g} |d| <| j}|d| D]}|d\}}|d\}}||}||}||}||}t|| }t||}t|| |}t|||}||f}||f}|||fqrqL||_|dS)Nrrrr{rr) r@r6rr+ key_marginrrint draw_keys)rEr6rrwhZkmtopZkmrightZkmbottomZkmleftrrrZllgZ llg_appendrx_hinty_hintZw_hintZh_hintZkxkykwZkhrkr+rJrJrKrMis2       zVKeyboard.refresh_keysc Csr|j|j}|d}|j}|j}t|jr.|jn|j}t|ddj }|j |j "t |j t||j|jdW5QRXt|jr|jn|j}t|ddj }|j Lt |jtd|dD],}|d|D]\} } t|| | |jdqqW5QRXtd|dD]f}d} |d|D]N\} } ||d t|| d} t| |j| | |jd } || | d7} qqdS) NrTrz)r}r+r~rr{r|r_)text font_sizerkr+ font_name)r@r6rrGrdisabledbackground_disabledrrr}rCrrbackground_colorrr+background_borderZkey_background_disabled_normalkey_background_normalrrrstrrrrZ add_widget)rEr6rrrGrr}Z key_normalrrkr+Zkey_nbrzrJrJrKrsN      zVKeyboard.draw_keyscGsdSrLrJrbrJrJrKr&szVKeyboard.on_key_downcGsdSrLrJrbrJrJrKr'szVKeyboard.on_key_upcGsdSrLrJrbrJrJrKr(szVKeyboard.on_textinputcCs |j\}}||}|j}|j|j}|d}|j\} } } } || | |} | |}|| |}|t||}||krz|}|dkrd}d}d}|d|D]B}||ddkr||dd|ddkr|}qq|d7}q|dkrdS|d|j|f|}|||fgS)Nrrrrr)r+rr@r6rrrG)rErqrprrrrr6rrrrrZe_heightZ line_heightr key_indexZcurrent_key_indexrrJrJrKget_key_at_poss2   , zVKeyboard.get_key_at_posc CsR|j\}}}}||j}||j}||krN|d|krN||krN|d|krNdSdS)zcDo a collision test, and return True if the (x, y) is inside the vkeyboard margin. rFT)rr,r-) rErqrprrrrrrrJrJrKcollide_margins   zVKeyboard.collide_margincCs>|sdS|j|j\}}|||}|s,dS|d}|\}}}} |d\} } i} |j|j<|| d<|j} |dk r|dkr|jdk r|jd|_d|_|dkr|j |_d} n0|dkrd|_ n |d krd|_ n|d kr| |}| }| jjd kr|r|d |n|d ||||d|j| <|dS)Nrrr)capslockr#r6r$rr#Tr$r6zkivy.core.window.window_sdl2r(r&)to_localrkruduid_start_repeat_key_evrV repeat_touchr3r2r4rv_get_modifiersrhrI __module__dispatchrrx)rEtouchrqrprkey_datadisplayed_charinternal special_charr+rrrr b_keycode b_modifiersrJrJrKprocess_key_onsL       zVKeyboard.process_key_onc Cs|j}|j|jkrdS|j|jd\}}|\}}}}|} |} |d| || |dkr^d}||jkr|j|d|dkrd|_n|dkrd|_|dkr|jr||jd<| dS)Nrr'rrr#Fr$) rrrrrpopr2r4r3rx) rErrrrrrrr+rrrJrJrKprocess_key_ups&    zVKeyboard.process_key_upcCs(g}|jr|d|jr$|d|S)Nr#r)r2rr3)rEretrJrJrKr9s   zVKeyboard._get_modifierscGst|jd|_dS)Nr)rZschedule_interval _repeat_key_repeat_key_evrErFrJrJrK_start_repeat_keyAszVKeyboard._start_repeat_keycGs||jdSrL)rrrrJrJrKrDszVKeyboard._repeat_keycs|j\}}|||sdS|jr$dS|||\}}|||sz|jdkrZt|jd|_ ||_| ||j |ddnt t ||dS)NTg?)Z exclusive)rkZ collide_pointrrrrrZ schedule_oncerrrZgrabr>r on_touch_down)rErrqrprHrJrKrGs"     zVKeyboard.on_touch_downcsh|j|krX|||jdk r.|jd|_||jkrX|jdk rR|jd|_d|_tt||SrL) Z grab_currentrrrVrrr>r on_touch_up)rErrHrJrKr\s       zVKeyboard.on_touch_up)F)G__name__r __qualname____doc__rrocallbackr r6default_layout_pathr5r r@r r1rrrr rrrrrrrZkey_disabled_background_normalrrrr rGrr3r2r4rrrrrZ __events__r?rPr8r;r9rWr=r`rmrarvrQrxrwrMrr&r'r(rrrrrrrrr __classcell__rJrJrHrKrs                :  / & +% 0 r__main__) runTouchAppZazerty)r6N)1r__all__r7rZ kivy.vectorrZ kivy.configrZkivy.uix.scatterrZkivy.uix.labelrZkivy.propertiesrr r r r r rrZ kivy.loggerrZ kivy.graphicsrrrZkivy.core.imagerZkivy.resourcesrZ kivy.clockrioros.pathrrrosrjsonrrrrZ kivy.baserZvkrJrJrJrKs6o     (        i