Re: master f041d61008 2/3: Improve documentation of the preedit-text event

Re: master f041d61008 2/3: Improve documentation of the preedit-text event

[Robert Pluim]

>>>>> On Fri,  7 Jan 2022 04:26:35 -0500 (EST), Po Lu via Mailing list for Emacs changes <emacs-diffs@gnu.org> said:

    Po> branch: master
    Po> commit f041d610083ca0815ab18c589f115bacc523b9bb
    Po> Author: Po Lu <luangruo@yahoo.com>
    Po> Commit: Po Lu <luangruo@yahoo.com>

    Po>     Improve documentation of the preedit-text event
    
    Po>     * doc/lispref/commands.texi (Misc Events): Document how
    Po>     `preedit-text' events are used.
    Po> ---
    Po>  doc/lispref/commands.texi | 4 +++-
    Po>  1 file changed, 3 insertions(+), 1 deletion(-)

    Po> diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
    Po> index eb364d2f49..062b8ea911 100644
    Po> --- a/doc/lispref/commands.texi
    Po> +++ b/doc/lispref/commands.texi
    Po> @@ -2140,7 +2140,9 @@ cursor.  It can be @code{nil}, which means to remove any text
    Po>  previously displayed.  @c FIXME: what is the value of ARG on PGTK?
 
    Po>  This is a special event (@pxref{Special Events}), which normally
    Po> -should not be bound by the user to any command.
    Po> +should not be bound by the user to any command.  Emacs will typically
    Po> +the text contained in the event behind the cursor on-screen when it is
    Po> +received.

I think youʼre missing a verb. And what does "behind the cursor
on-screen" mean? An overlay? (plus I thought this was disabled by
default now?)

Robert
-- 

Re: master f041d61008 2/3: Improve documentation of the preedit-text event

[Po Lu]

Robert Pluim <rpluim@gmail.com> writes:

>>>>>> On Fri,  7 Jan 2022 04:26:35 -0500 (EST), Po Lu via Mailing list for Emacs changes <emacs-diffs@gnu.org> said:
>
>     Po> branch: master
>     Po> commit f041d610083ca0815ab18c589f115bacc523b9bb
>     Po> Author: Po Lu <luangruo@yahoo.com>
>     Po> Commit: Po Lu <luangruo@yahoo.com>
>
>     Po>     Improve documentation of the preedit-text event
>     
>     Po>     * doc/lispref/commands.texi (Misc Events): Document how
>     Po>     `preedit-text' events are used.
>     Po> ---
>     Po>  doc/lispref/commands.texi | 4 +++-
>     Po>  1 file changed, 3 insertions(+), 1 deletion(-)
>
>     Po> diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
>     Po> index eb364d2f49..062b8ea911 100644
>     Po> --- a/doc/lispref/commands.texi
>     Po> +++ b/doc/lispref/commands.texi
>     Po> @@ -2140,7 +2140,9 @@ cursor.  It can be @code{nil}, which means to remove any text
>     Po>  previously displayed.  @c FIXME: what is the value of ARG on PGTK?
>  
>     Po>  This is a special event (@pxref{Special Events}), which normally
>     Po> -should not be bound by the user to any command.
>     Po> +should not be bound by the user to any command.  Emacs will typically
>     Po> +the text contained in the event behind the cursor on-screen when it is
>     Po> +received.
>
> I think youʼre missing a verb.

Thanks, I'll fix that.

> And what does "behind the cursor on-screen" mean? An overlay?

Yes.

> (plus I thought this was disabled by default now?)

Yes, it's disabled by default in the sense that preedit-text events
are no longer sent on X unless inputStyle is set to "callback".

The PGTK port has been sending these events since day one, and I didn't
implement that resource there, as most of the options it provides only
make sense on X-Windows.