Document the xwidget type

* doc/lispref/elisp.texi: Add Xwidget Type to the menu.
* doc/lispref/objects.texi (Editing Types): Add Xwidget Type to the
menu.
(Xwidget Type): New node.
This commit is contained in:
Po Lu 2021-11-07 20:02:06 +08:00 committed by Eli Zaretskii
parent 75f4af0b30
commit a05f6bb671
2 changed files with 16 additions and 0 deletions

View file

@ -365,6 +365,7 @@ Editing Types
* Keymap Type:: What function a keystroke invokes.
* Overlay Type:: How an overlay is represented.
* Font Type:: Fonts for displaying text.
* Xwidget Type:: Embeddable widgets.
Numbers

View file

@ -1535,6 +1535,7 @@ editing.
* Keymap Type:: What function a keystroke invokes.
* Overlay Type:: How an overlay is represented.
* Font Type:: Fonts for displaying text.
* Xwidget Type:: Embeddable widgets.
@end menu
@node Buffer Type
@ -1860,6 +1861,20 @@ syntax looks like @samp{#<font-object>}, @samp{#<font-spec>}, and
@samp{#<font-entity>} respectively. @xref{Low-Level Font}, for a
description of these Lisp objects.
@node Xwidget Type
@subsection Xwidget Type
@cindex xwidget type
@cindex xwidget-view type
An @dfn{xwidget} is a special display element, such as a web
browser, that can be embedded inside a buffer. Each window that
displays an xwidget will also have an @dfn{xwidget view}, which on
X-Windows corresponds to a single X window used to display the widget.
Neither of these objects are readable; their print syntaxes look like
@samp{#<xwidget>} and @samp{#<xwidget-view>}, respectively.
@xref{Xwidgets}, for a more detailed description of xwidgets.
@node Circular Objects
@section Read Syntax for Circular Objects
@cindex circular structure, read syntax