branch: externals/posframe
commit 219ed0275eab075ac425df13c7b020cbd5ce87b8
Merge: 11c2fa2 b04f321
Author: tumashu <tuma...@163.com>
Commit: GitHub <nore...@github.com>
Merge pull request #28 from billywade/master
added documentation on posframe-mouse-banish
---
README.md | 50 +++++++++++++++++++++++++++++++-------------------
posframe.el | 10 ++++++++++
2 files changed, 41 insertions(+), 19 deletions(-)
diff --git a/README.md b/README.md
index 8381513..4292e6b 100644
--- a/README.md
+++ b/README.md
@@ -1,25 +1,26 @@
Note: this file is auto converted from posframe.el by
[el2org](https://github.com/tumashu/el2org), please do not edit it by hand!!!
-# 目录
+# Table of Contents
-1. [Posframe README](#org3c803d7)
- 1. [What is posframe](#orge01c383)
- 2. [Installation](#org0e86f77)
- 3. [Usage](#orged3f863)
- 1. [Create a posframe](#org675e151)
- 2. [Hide a posframe](#orgb91d9ff)
- 3. [Hide all posframes](#org9ad2afb)
- 4. [Delete a posframe](#org62bd3a2)
- 5. [Delete all posframes](#org10ff130)
+1. [Posframe README](#orgff02ab2)
+ 1. [What is posframe](#org9798090)
+ 2. [Installation](#org3adce4c)
+ 3. [Usage](#org4ef3be4)
+ 1. [Create a posframe](#org7623f9d)
+ 2. [Hide a posframe](#orga8e2a61)
+ 3. [Hide all posframes](#org7414b66)
+ 4. [Delete a posframe](#org448902b)
+ 5. [Delete all posframes](#org3c8f39b)
+ 6. [Customizing pointer control](#orgf81a00a)
-<a id="org3c803d7"></a>
+<a id="orgff02ab2"></a>
# Posframe README
-<a id="orge01c383"></a>
+<a id="org9798090"></a>
## What is posframe
@@ -36,19 +37,19 @@ NOTE: For MacOS users, posframe need Emacs (version >=
26.0.91)
-<a id="org0e86f77"></a>
+<a id="org3adce4c"></a>
## Installation
(require 'posframe)
-<a id="orged3f863"></a>
+<a id="org4ef3be4"></a>
## Usage
-<a id="org675e151"></a>
+<a id="org7623f9d"></a>
### Create a posframe
@@ -76,21 +77,21 @@ NOTE: For MacOS users, posframe need Emacs (version >=
26.0.91)
C-h f posframe-show
-<a id="orgb91d9ff"></a>
+<a id="orga8e2a61"></a>
### Hide a posframe
(posframe-hide " *my-posframe-buffer*")
-<a id="org9ad2afb"></a>
+<a id="org7414b66"></a>
### Hide all posframes
M-x posframe-hide-all
-<a id="org62bd3a2"></a>
+<a id="org448902b"></a>
### Delete a posframe
@@ -102,7 +103,7 @@ NOTE: For MacOS users, posframe need Emacs (version >=
26.0.91)
(posframe-delete-frame " *my-posframe-buffer*")
-<a id="org10ff130"></a>
+<a id="org3c8f39b"></a>
### Delete all posframes
@@ -112,3 +113,14 @@ Note: this command will delete all posframe buffers,
suggest not run this command if you are sharing a buffer
between posframe and other packages.
+
+<a id="orgf81a00a"></a>
+
+### Customizing pointer control
+
+By default, posframe moves the pointer to point (0,0) in
+the frame, as a way to address an issue with mouse focus.
+To disable this feature, add this to your init.el:
+
+ (setq posframe-mouse-banish nil)
+
diff --git a/posframe.el b/posframe.el
index 3eb28ec..7ef18a2 100644
--- a/posframe.el
+++ b/posframe.el
@@ -105,6 +105,16 @@
;; suggest not run this command if you are sharing a buffer
;; between posframe and other packages.
+;; *** Customizing pointer control
+
+;; By default, posframe moves the pointer to point (0,0) in
+;; the frame, as a way to address an issue with mouse focus.
+;; To disable this feature, add this to your init.el:
+;; #+BEGIN_EXAMPLE
+;; (setq posframe-mouse-banish nil)
+;; #+END_EXAMPLE
+
+
;;; Code:
;; * posframe's code :CODE:
(require 'cl-lib)
