8000 text_input documentation improvements on by default, needed for pygame.TEXTINPUT · Pull Request #2333 · pygame/pygame · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

text_input documentation improvements on by default, needed for pygame.TEXTINPUT #2333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from Nov 17, 2020
Merged

text_input documentation improvements on by default, needed for pygame.TEXTINPUT #2333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/reST/ref/key.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,11 +365,11 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:

.. function:: start_text_input

| :sl:`start handling IME compositions`
| :sl:`start handling Unicode text input events`
| :sg:`start_text_input() -> None`

Start receiving ``pygame.TEXTEDITING`` and ``pygame.TEXTINPUT``
events to handle IME.
events.

A ``pygame.TEXTEDITING`` event is received when an IME composition
is started or changed. It contains the composition ``text``, ``length``,
Expand All @@ -378,21 +378,21 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:
When the composition is committed (or non-IME input is received),
a ``pygame.TEXTINPUT`` event is generated.

Normal ``pygame.TEXTINPUT`` events are not dependent on this.
Text input events handling is on by default.

.. versionadded:: 2.0.0

.. ## pygame.key.start_text_input ##

.. function:: stop_text_input

| :sl:`stop handling IME compositions`
| :sl:`stop handling Unicode text input events`
| :sg:`stop_text_input() -> None`

Stop receiving ``pygame.TEXTEDITING`` and ``pygame.TEXTINPUT``
events to handle IME.
events.

Normal ``pygame.TEXTINPUT`` events are not dependent on this.
Text input events handling is on by default

.. versionadded:: 2.0.0

Expand All @@ -406,8 +406,6 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:
This sets the rectangle used for typing with an IME.
It controls where the candidate list will open, if supported.

Normal ``pygame.TEXTINPUT`` events are not dependent on this.

.. versionadded:: 2.0.0

.. ## pygame.key.set_text_input_rect ##
Expand Down
0