Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

Note: this file is auto converted from posframe.el by el2org, please do not edit it by hand!!!

目录

  1. Posframe README
    1. What is posframe?
    2. Installation
    3. Usage
      1. Create a posframe
      2. Hide a posframe
      3. Hide all posframes
      4. Delete a posframe
      5. Delete all posframes
      6. Customizing mouse pointer control
      7. Set fallback arguments of posframe-show
      8. Some packages which use posframe

Posframe README

What is posframe?

Posframe can pop up a frame at point, this posframe is a child-frame connected to its root window's buffer.

The main advantages are:

  1. It is fast enough for daily usage :-)
  2. It works well with CJK languages.

NOTE:

  1. For MacOS users, posframe needs Emacs version >= 26.0.91

  2. GNOME users with GTK3 builds need Emacs 27 or later. See variable `posframe-gtk-resize-child-frames' which auto-detects this configuration.

    More details:

    1. Fix some problems with moving and resizing child frames
    2. Emacs's set-frame-size can not work well with gnome-shell?

img

Installation

(require 'posframe)

Usage

Create a posframe

  1. Simple way

    (when (posframe-workable-p)
      (posframe-show " *my-posframe-buffer*"
                     :string "This is a test"
                     :position (point)))
    
  2. Advanced way

    (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)))
    
  3. Arguments

    C-h f posframe-show
    

Hide a posframe

(posframe-hide " *my-posframe-buffer*")

Hide all posframes

M-x posframe-hide-all

Delete a posframe

  1. Delete posframe and its buffer

    (posframe-delete " *my-posframe-buffer*")
    
  2. Only delete the frame

    (posframe-delete-frame " *my-posframe-buffer*")
    

Delete all posframes

M-x posframe-delete-all

Note: this command will delete all posframe buffers. You probably shouldn't use it if you are sharing a buffer between posframe and other packages.

Customizing mouse 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)

Set fallback arguments of posframe-show

Users can set fallback values of posframe-show's arguments with the help of `posframe-arghandler'. The example below sets fallback border-width to 10 and fallback background color to green.

(setq posframe-arghandler #'my-posframe-arghandler)
(defun my-posframe-arghandler (buffer-or-name arg-name value)
  (let ((info '(:internal-border-width 10 :background-color "green")))
    (or (plist-get info arg-name) value)))

Some packages which use posframe

  1. which-key-posframe
  2. ddskk-posframe
  3. pyim
  4. ivy-posframe
  5. company-posframe
  6. dap-mode

About

Pop a posframe (just a child-frame) at point, posframe is a **GNU ELPA** package!

Resources

Packages

No packages published