]> git.eshelyaron.com Git - emacs.git/commitdiff
Document the xwidget type
authorPo Lu <luangruo@yahoo.com>
Sun, 7 Nov 2021 12:02:06 +0000 (20:02 +0800)
committerEli Zaretskii <eliz@gnu.org>
Sun, 7 Nov 2021 12:51:16 +0000 (14:51 +0200)
* 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.

doc/lispref/elisp.texi
doc/lispref/objects.texi

index d0bfd8c9019d4bbb01706ff3cba256cccd7fa711..1c0b0fa1b5af935c39aec79aa808838d13c9835c 100644 (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
 
index 0551bb5673f8ea09b170e496d39d706edaf37c1d..bbd3973f61b0039596c168711cb84c3b923014c2 100644 (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