The messagebox Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The messagebox Reference Manual

This is the messagebox Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 14:29:58 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

## About Messagebox
This is a small library to display a native GUI message box. This can be useful to show error messages and other informational pieces should the application fail and be unable to do so using its standard UI.

## How To
Simply call ``show``:

:: common lisp
(org.shirakumo.messagebox:show "Hello there!" :title "Wow!")
(org.shirakumo.messagebox:show "Doing good?" :type :question)
::

The returned value will be ``:OK``, ``:CANCEL``, ``:YES``, or ``:NO`` depending on the type of box.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 messagebox

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

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

Description

A library to show a native message box dialog.

Version

1.0.0

Defsystem Dependency

trivial-features

Dependencies
Source

messagebox.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 messagebox.asd

Location

messagebox.asd

Systems

messagebox (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 messagebox/package.lisp

Parent

messagebox (system)

Location

package.lisp

Packages

org.shirakumo.messagebox


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 messagebox/protocol.lisp

Dependency

package.lisp (file)

Parent

messagebox (system)

Location

protocol.lisp

Exported Definitions

show (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 messagebox/zenity.lisp

If Feature

linux

Dependency

protocol.lisp (file)

Parent

messagebox (system)

Location

zenity.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 messagebox/macos.lisp

If Feature

darwin

Dependency

zenity.lisp (file)

Parent

messagebox (system)

Location

macos.lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.6 messagebox/win32.lisp

If Feature

windows

Dependency

macos.lisp (file)

Parent

messagebox (system)

Location

win32.lisp


Previous: , Up: Lisp files   [Contents][Index]

3.1.7 messagebox/documentation.lisp

Dependency

win32.lisp (file)

Parent

messagebox (system)

Location

documentation.lisp


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 org.shirakumo.messagebox

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

show (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 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 (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: define-implementation ARGS &body BODY
Package

org.shirakumo.messagebox

Source

protocol.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: show-backend TEXT &key TITLE TYPE MODAL &allow-other-keys
Package

org.shirakumo.messagebox

Source

zenity.lisp (file)

Function: show-stream TEXT &key TITLE TYPE STREAM &allow-other-keys
Package

org.shirakumo.messagebox

Source

protocol.lisp (file)

Function: zenity &rest ARGS
Package

org.shirakumo.messagebox

Source

zenity.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Conditions

Condition: messagebox-failed ()
Package

org.shirakumo.messagebox

Source

protocol.lisp (file)

Direct superclasses

error (condition)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

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

L
Lisp File, messagebox.asd: The messagebox․asd file
Lisp File, messagebox/documentation.lisp: The messagebox/documentation․lisp file
Lisp File, messagebox/macos.lisp: The messagebox/macos․lisp file
Lisp File, messagebox/package.lisp: The messagebox/package․lisp file
Lisp File, messagebox/protocol.lisp: The messagebox/protocol․lisp file
Lisp File, messagebox/win32.lisp: The messagebox/win32․lisp file
Lisp File, messagebox/zenity.lisp: The messagebox/zenity․lisp file

M
messagebox.asd: The messagebox․asd file
messagebox/documentation.lisp: The messagebox/documentation․lisp file
messagebox/macos.lisp: The messagebox/macos․lisp file
messagebox/package.lisp: The messagebox/package․lisp file
messagebox/protocol.lisp: The messagebox/protocol․lisp file
messagebox/win32.lisp: The messagebox/win32․lisp file
messagebox/zenity.lisp: The messagebox/zenity․lisp file

Jump to:   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   D   F   M   S   Z  
Index Entry  Section

D
define-implementation: Internal macros

F
Function, show: Exported functions
Function, show-backend: Internal functions
Function, show-stream: Internal functions
Function, zenity: Internal functions

M
Macro, define-implementation: Internal macros

S
show: Exported functions
show-backend: Internal functions
show-stream: Internal functions

Z
zenity: Internal functions

Jump to:   D   F   M   S   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables


Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   M   O   P   S  
Index Entry  Section

C
Condition, messagebox-failed: Internal conditions

M
messagebox: The messagebox system
messagebox-failed: Internal conditions

O
org.shirakumo.messagebox: The org․shirakumo․messagebox package

P
Package, org.shirakumo.messagebox: The org․shirakumo․messagebox package

S
System, messagebox: The messagebox system

Jump to:   C   M   O   P   S