GNU ELPA - posframe

posframe

Description
Pop a posframe (just a frame) at point
Latest
posframe-0.4.3.el, 2019-Mar-13, 42.2kB
Maintainer
Feng Shu <tumashu@163.com>
Home page
https://github.com/tumashu/posframe
Browse ELPA's repository
CGit or Gitweb

To install this package, run in Emacs:

M-x package-install RET posframe RET

Full description

* Posframe README                                :README:
** What is posframe
Posframe can pop a posframe at point, this *posframe* is a
child-frame with its root window's buffer.

The main advantages are:
1. It is fast enough for daily usage :-)
2. It works well with CJK language.

NOTE: For MacOS users, posframe need Emacs (version >= 26.0.91)

[[./snapshots/posframe-1.png]]

** Installation

#+BEGIN_EXAMPLE
(require 'posframe)
#+END_EXAMPLE

** Usage

*** Create a posframe

**** Simple way
#+BEGIN_EXAMPLE
(when (posframe-workable-p)
  (posframe-show " *my-posframe-buffer*"
                 :string "This is a test"
                 :position (point)))
#+END_EXAMPLE

**** Advanced way
#+BEGIN_EXAMPLE
(defvar my-posframe-buffer " *my-posframe-buffer*")

(with-current-buffer (get-buffer-create my-posframe-buffer)
  (erase-buffer)
  (insert "Hello world"))

(when (posframe-workable-p)
  (posframe-show my-posframe-buffer
                 :position (point)))
#+END_EXAMPLE

**** Arguments

#+BEGIN_EXAMPLE
C-h f posframe-show
#+END_EXAMPLE

*** Hide a posframe
#+BEGIN_EXAMPLE
(posframe-hide " *my-posframe-buffer*")
#+END_EXAMPLE

*** Hide all posframes
#+BEGIN_EXAMPLE
M-x posframe-hide-all
#+END_EXAMPLE

*** Delete a posframe
1. Delete posframe and its buffer
   #+BEGIN_EXAMPLE
   (posframe-delete " *my-posframe-buffer*")
   #+END_EXAMPLE
2. Only delete posframe's frame
   #+BEGIN_EXAMPLE
   (posframe-delete-frame " *my-posframe-buffer*")
   #+END_EXAMPLE
*** Delete all posframes
#+BEGIN_EXAMPLE
M-x posframe-delete-all
#+END_EXAMPLE

Note: this command will delete all posframe buffers,
suggest not run this command if you are sharing a buffer
between posframe and other packages.

Old versions

posframe-0.4.2.el2018-Dec-1433.7kB
posframe-0.3.0.el2018-Mar-0928.4kB
posframe-0.2.0.el2018-Mar-0828.2kB
posframe-0.1.0.el2018-Feb-2726.9kB