The messagebox Reference Manual

This is the messagebox Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:13:59 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 messagebox

A library to show a native message box dialog.

Maintainer

Yukari Hafner <>

Author

Yukari Hafner <>

Home Page

https://shinmera.github.io/messagebox/

Source Control

(GIT https://github.com/shinmera/messagebox.git)

Bug Tracker

https://github.com/shinmera/messagebox/issues

License

zlib

Version

1.0.0

Defsystem Dependency

trivial-features (system).

Dependencies
  • cffi (system)., for feature :darwin
  • trivial-main-thread (system)., for feature :darwin
  • float-features (system)., for feature :darwin
  • com-on (system)., for feature :windows
  • uiop (system)., for feature :linux
  • documentation-utils (system).
Source

messagebox.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


3.1 Lisp


3.1.1 messagebox/messagebox.asd

Source

messagebox.asd.

Parent Component

messagebox (system).

ASDF Systems

messagebox.


3.1.2 messagebox/package.lisp

Source

messagebox.asd.

Parent Component

messagebox (system).

Packages

org.shirakumo.messagebox.


3.1.3 messagebox/protocol.lisp

Dependency

package.lisp (file).

Source

messagebox.asd.

Parent Component

messagebox (system).

Public Interface

show (function).

Internals

3.1.4 messagebox/zenity.lisp

If Feature

:linux

Dependency

protocol.lisp (file).

Source

messagebox.asd.

Parent Component

messagebox (system).

Internals

3.1.5 messagebox/macos.lisp

If Feature

:darwin

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


3.1.6 messagebox/win32.lisp

If Feature

:windows

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


3.1.7 messagebox/documentation.lisp

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.messagebox

Source

package.lisp.

Use List

common-lisp.

Public Interface

show (function).

Internals

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


5.1 Public Interface


5.1.1 Ordinary functions

Function: show (text &rest args &key title type modal &allow-other-keys)

Show a message box dialog.

TEXT — The primary text to display.
TITLE — The title to show on the message box window.
TYPE — What kind of message to display. Should be one of :info
:error
:warning
:question
MODAL — Whether the dialog should be modal to the application May not make a difference on some systems.

If the backend fails or no suitable backend is present, the dialog is shown on *ERROR-OUTPUT*.

Depending on the backend further options may be supported.

Do note that some systems might not show long text well. You should thus avoid trying to do things such as displaying stack traces using this function. It is instead recommended to write relevant debug information to a file and refer to this file in the displayed message.

This function should not error.

Returns :OK, :YES, :NO, or :CANCEL. :YES and :NO can only be returned if the TYPE is :QUESTION.

Package

org.shirakumo.messagebox.

Source

protocol.lisp.


5.2 Internals


5.2.1 Macros

Macro: define-implementation (args &body body)
Package

org.shirakumo.messagebox.

Source

protocol.lisp.


5.2.2 Ordinary functions

Function: show-backend (text &key title type modal &allow-other-keys)
Package

org.shirakumo.messagebox.

Source

zenity.lisp.

Function: show-stream (text &key title type stream &allow-other-keys)
Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Function: zenity (&rest args)
Package

org.shirakumo.messagebox.

Source

zenity.lisp.


5.2.3 Conditions

Condition: messagebox-failed
Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Direct superclasses

error.


Appendix A Indexes


A.1 Concepts


A.3 Variables