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 Sun Dec 15 07:02:11 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
  • cffi (system)., for feature :nx
  • 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.3 messagebox/protocol.lisp

Dependency

package.lisp (file).

Source

messagebox.asd.

Parent Component

messagebox (system).

Public Interface
Internals

3.1.4 messagebox/zenity.lisp

If Feature

:linux

Dependency

protocol.lisp (file).

Source

messagebox.asd.

Parent Component

messagebox (system).

Public Interface

zenity (class).

Internals

3.1.5 messagebox/kdialog.lisp

If Feature

:linux

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).

Public Interface

kdialog (class).

Internals

show-backend (method).


3.1.6 messagebox/macos.lisp

If Feature

:darwin

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


3.1.7 messagebox/win32.lisp

If Feature

:windows

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


3.1.8 messagebox/nxgl.lisp

If Feature

:nx

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).


3.1.9 messagebox/defaults.lisp

Dependencies
Source

messagebox.asd.

Parent Component

messagebox (system).

Public Interface
Internals

3.1.10 messagebox/documentation.lisp

Dependency

defaults.lisp (file).

Source

messagebox.asd.

Parent Component

messagebox (system).


4 Packages

Packages are listed by definition order.


4.1 org.shirakumo.messagebox.nxgl

Source

package.lisp.

Use List

common-lisp.


4.2 org.shirakumo.messagebox.win32

Source

package.lisp.

Use List

common-lisp.


4.3 org.shirakumo.messagebox.zenity

Source

package.lisp.

Use List

common-lisp.

Public Interface

zenity (class).

Internals

4.4 org.shirakumo.messagebox

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

4.5 org.shirakumo.messagebox.kdialog

Source

package.lisp.

Use List

common-lisp.

Public Interface

kdialog (class).


4.6 org.shirakumo.messagebox.macos

Source

package.lisp.

Use List

common-lisp.


5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *default-backend*
Package

org.shirakumo.messagebox.

Source

protocol.lisp.


5.1.2 Ordinary functions

Function: determine-default-backend ()
Package

org.shirakumo.messagebox.

Source

defaults.lisp.

Function: show (text &rest args &key title type modal backend &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 dialog fails to show, an error of type MESSAGEBOX-FAILED is signalled.

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.

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

See MESSAGEBOX-FAILED

Package

org.shirakumo.messagebox.

Source

protocol.lisp.


5.1.3 Conditions

Condition: messagebox-failed

Error signalled when the messagebox fails to be shown.

See SHOW

Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Direct superclasses

error.

Direct subclasses

no-backend-found.

Condition: no-backend-found

Error signalled if no suitable backend can be found at all.

See MESSAGEBOX-FAILED

Package

org.shirakumo.messagebox.

Source

defaults.lisp.

Direct superclasses

messagebox-failed.


5.1.4 Classes

Class: kdialog
Package

org.shirakumo.messagebox.kdialog.

Source

kdialog.lisp.

Direct superclasses

backend.

Direct methods

show-backend.

Class: zenity
Package

org.shirakumo.messagebox.zenity.

Source

zenity.lisp.

Direct methods
Direct slots
Slot: program-name
Initform

"zenity"

Initargs

:program-name

Readers

program-name.

Writers

(setf program-name).


5.2 Internals


5.2.1 Macros

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

org.shirakumo.messagebox.

Source

protocol.lisp.


5.2.2 Ordinary functions

Function: default-backend ()
Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Function: find-in-path (file)
Package

org.shirakumo.messagebox.

Source

defaults.lisp.

Function: run (program &rest args)
Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Function: split (char string)
Package

org.shirakumo.messagebox.

Source

defaults.lisp.


5.2.3 Generic functions

Generic Reader: program-name (object)
Package

org.shirakumo.messagebox.zenity.

Methods
Reader Method: program-name ((zenity zenity))

automatically generated reader method

Source

zenity.lisp.

Target Slot

program-name.

Generic Writer: (setf program-name) (object)
Package

org.shirakumo.messagebox.zenity.

Methods
Writer Method: (setf program-name) ((zenity zenity))

automatically generated writer method

Source

zenity.lisp.

Target Slot

program-name.

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

org.shirakumo.messagebox.

Source

protocol.lisp.

Methods
Method: show-backend ((backend text) text &key title type stream)
Source

defaults.lisp.

Method: show-backend ((backend kdialog) text &key title type default &allow-other-keys)
Source

kdialog.lisp.

Method: show-backend ((zenity zenity) text &key title type modal &allow-other-keys)
Source

zenity.lisp.

Method: show-backend ((backend symbol) text &rest args)

5.2.4 Classes

Class: backend
Package

org.shirakumo.messagebox.

Source

protocol.lisp.

Direct subclasses
Class: text
Package

org.shirakumo.messagebox.

Source

defaults.lisp.

Direct superclasses

backend.

Direct methods

show-backend.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
D   F   G   M   P   R   S  
Index Entry  Section

(
(setf program-name): Private generic functions
(setf program-name): Private generic functions

D
default-backend: Private ordinary functions
define-implementation: Private macros
determine-default-backend: Public ordinary functions

F
find-in-path: Private ordinary functions
Function, default-backend: Private ordinary functions
Function, determine-default-backend: Public ordinary functions
Function, find-in-path: Private ordinary functions
Function, run: Private ordinary functions
Function, show: Public ordinary functions
Function, split: Private ordinary functions

G
Generic Function, (setf program-name): Private generic functions
Generic Function, program-name: Private generic functions
Generic Function, show-backend: Private generic functions

M
Macro, define-implementation: Private macros
Method, (setf program-name): Private generic functions
Method, program-name: Private generic functions
Method, show-backend: Private generic functions
Method, show-backend: Private generic functions
Method, show-backend: Private generic functions
Method, show-backend: Private generic functions

P
program-name: Private generic functions
program-name: Private generic functions

R
run: Private ordinary functions

S
show: Public ordinary functions
show-backend: Private generic functions
show-backend: Private generic functions
show-backend: Private generic functions
show-backend: Private generic functions
show-backend: Private generic functions
split: Private ordinary functions


A.3 Variables


A.4 Data types

Jump to:   B   C   D   F   K   M   N   O   P   S   T   W   Z  
Index Entry  Section

B
backend: Private classes

C
Class, backend: Private classes
Class, kdialog: Public classes
Class, text: Private classes
Class, zenity: Public classes
Condition, messagebox-failed: Public conditions
Condition, no-backend-found: Public conditions

D
defaults.lisp: The messagebox/defaults․lisp file
documentation.lisp: The messagebox/documentation․lisp file

F
File, defaults.lisp: The messagebox/defaults․lisp file
File, documentation.lisp: The messagebox/documentation․lisp file
File, kdialog.lisp: The messagebox/kdialog․lisp file
File, macos.lisp: The messagebox/macos․lisp file
File, messagebox.asd: The messagebox/messagebox․asd file
File, nxgl.lisp: The messagebox/nxgl․lisp file
File, package.lisp: The messagebox/package․lisp file
File, protocol.lisp: The messagebox/protocol․lisp file
File, win32.lisp: The messagebox/win32․lisp file
File, zenity.lisp: The messagebox/zenity․lisp file

K
kdialog: Public classes
kdialog.lisp: The messagebox/kdialog․lisp file

M
macos.lisp: The messagebox/macos․lisp file
messagebox: The messagebox system
messagebox-failed: Public conditions
messagebox.asd: The messagebox/messagebox․asd file

N
no-backend-found: Public conditions
nxgl.lisp: The messagebox/nxgl․lisp file

O
org.shirakumo.messagebox: The org․shirakumo․messagebox package
org.shirakumo.messagebox.kdialog: The org․shirakumo․messagebox․kdialog package
org.shirakumo.messagebox.macos: The org․shirakumo․messagebox․macos package
org.shirakumo.messagebox.nxgl: The org․shirakumo․messagebox․nxgl package
org.shirakumo.messagebox.win32: The org․shirakumo․messagebox․win32 package
org.shirakumo.messagebox.zenity: The org․shirakumo․messagebox․zenity package

P
Package, org.shirakumo.messagebox: The org․shirakumo․messagebox package
Package, org.shirakumo.messagebox.kdialog: The org․shirakumo․messagebox․kdialog package
Package, org.shirakumo.messagebox.macos: The org․shirakumo․messagebox․macos package
Package, org.shirakumo.messagebox.nxgl: The org․shirakumo․messagebox․nxgl package
Package, org.shirakumo.messagebox.win32: The org․shirakumo․messagebox․win32 package
Package, org.shirakumo.messagebox.zenity: The org․shirakumo․messagebox․zenity package
package.lisp: The messagebox/package․lisp file
protocol.lisp: The messagebox/protocol․lisp file

S
System, messagebox: The messagebox system

T
text: Private classes

W
win32.lisp: The messagebox/win32․lisp file

Z
zenity: Public classes
zenity.lisp: The messagebox/zenity․lisp file