The halftone Reference Manual

Table of Contents

The halftone Reference Manual

This is the halftone Reference Manual, version 1.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 11:06:08 2021 GMT+0.

1 Introduction

About Halftone

This is a simple image viewer application written in Common Lisp, using the Qt framework.

2 Systems

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

2.1 halftone

Maintainer

Nicolas Hafner <shinmera@tymoon.eu>

Author

Nicolas Hafner <shinmera@tymoon.eu>

Home Page

https://Shinmera.github.io/halftone/

Source Control

(:git "https://github.com/shinmera/halftone.git")

Bug Tracker

https://github.com/Shinmera/halftone/issues

License

zlib

Description

An image viewer using Qtools

Version

1.1.0

Defsystem Dependency

qtools

Dependencies

• qtools
• qtcore
• qtgui
• qtopengl
• uiop
• verbose
• simple-tasks
• bordeaux-threads

Source

halftone.asd (file)

Components

• package.lisp (file)
• images.lisp (file)
• main.lisp (file)
• viewer.lisp (file)
• gallery.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 halftone.asd

Location

halftone.asd

Systems

halftone (system)

3.1.2 halftone/package.lisp

Parent

halftone (system)

Location

package.lisp

Packages

halftone

3.1.3 halftone/images.lisp

Dependency

package.lisp (file)

Parent

halftone (system)

Location

images.lisp

Internal Definitions

• *image-loaders* (special variable)
• *image-runner* (special variable)
• callback (method)
• (setf callback) (method)
• define-image-loader (macro)
• draw-image-fitting (function)
• file (method)
• (setf file) (method)
• file (method)
• (setf file) (method)
• image-file-p (function)
• image-load-error (condition)
• image-loader (function)
• (setf image-loader) (function)
• image-loader-task (class)
• load-image (function)
• load-thumbnail (function)
• remove-image-loader (function)
• thumbnail-loader-task (class)
• with-callback-task (macro)

3.1.4 halftone/main.lisp

Dependency

images.lisp (file)

Parent

halftone (system)

Location

main.lisp

Exported Definitions

• main (function)
• start (function)

Internal Definitions

• %build-main-window-menu-file (method)
• %build-main-window-menu-help (method)
• %main-window-subwidget-dockable-initializer (method)
• %main-window-subwidget-gallery-initializer (method)
• %main-window-subwidget-viewer-initializer (method)
• *main* (special variable)
• dock-container (class)
• (setf image) (generic function)
• (setf image) (method)
• main-window (class)
• set-main (method)
• setup (method)
• title (method)

3.1.5 halftone/viewer.lisp

Dependency

main.lisp (file)

Parent

halftone (system)

Location

viewer.lisp

Internal Definitions

• %viewer-override-paint-event (method)
• image (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• setup (method)
• viewer (class)

3.1.6 halftone/gallery.lisp

Dependency

viewer.lisp (file)

Parent

halftone (system)

Location

gallery.lisp

Internal Definitions

• %gallery-override-key-release-event (method)
• %gallery-override-resize-event (method)
• %gallery-subwidget-layout-initializer (method)
• %gallery-subwidget-scrollable-initializer (method)
• %thumbnail-override-mouse-release-event (method)
• %thumbnail-override-paint-event (method)
• %thumbnail-subwidget-image-initializer (method)
• change-layout (function)
• current (method)
• (setf current) (method)
• (setf current) (method)
• directory-images (function)
• file (method)
• (setf file) (method)
• gallery (class)
• (setf image) (method)
• (setf image) (method)
• keycase (macro)
• location (method)
• (setf location) (method)
• (setf location) (method)
• reload-images (function)
• selected (method)
• (setf selected) (method)
• (setf selected) (method)
• setup (method)
• setup (method)
• sort-files (function)
• teardown (method)
• thumbnail (class)
• thumbnails (method)
• (setf thumbnails) (method)

4 Packages

Packages are listed by definition order.

4.1 halftone

Source

package.lisp (file)

Nickname

org.shirakumo.halftone

Use List

cl+qt

Exported Definitions

• main (function)
• start (function)

Internal Definitions

• %build-main-window-menu-file (generic function)
• %build-main-window-menu-file (method)
• %build-main-window-menu-help (generic function)
• %build-main-window-menu-help (method)
• %gallery-override-key-release-event (generic function)
• %gallery-override-key-release-event (method)
• %gallery-override-resize-event (generic function)
• %gallery-override-resize-event (method)
• %gallery-subwidget-layout-initializer (generic function)
• %gallery-subwidget-layout-initializer (method)
• %gallery-subwidget-scrollable-initializer (generic function)
• %gallery-subwidget-scrollable-initializer (method)
• %main-window-subwidget-dockable-initializer (generic function)
• %main-window-subwidget-dockable-initializer (method)
• %main-window-subwidget-gallery-initializer (generic function)
• %main-window-subwidget-gallery-initializer (method)
• %main-window-subwidget-viewer-initializer (generic function)
• %main-window-subwidget-viewer-initializer (method)
• %thumbnail-override-mouse-release-event (generic function)
• %thumbnail-override-mouse-release-event (method)
• %thumbnail-override-paint-event (generic function)
• %thumbnail-override-paint-event (method)
• %thumbnail-subwidget-image-initializer (generic function)
• %thumbnail-subwidget-image-initializer (method)
• %viewer-override-paint-event (generic function)
• %viewer-override-paint-event (method)
• *image-loaders* (special variable)
• *image-runner* (special variable)
• *main* (special variable)
• callback (generic function)
• callback (method)
• (setf callback) (method)
• (setf callback) (generic function)
• change-layout (function)
• current (generic function)
• current (method)
• (setf current) (method)
• (setf current) (generic function)
• (setf current) (method)
• define-image-loader (macro)
• directory-images (function)
• dock-container (class)
• draw-image-fitting (function)
• file (generic function)
• file (method)
• (setf file) (method)
• file (method)
• (setf file) (method)
• file (method)
• (setf file) (method)
• (setf file) (generic function)
• gallery (class)
• image (generic function)
• image (method)
• (setf image) (generic function)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)
• image-file-p (function)
• image-load-error (condition)
• image-loader (function)
• (setf image-loader) (function)
• image-loader-task (class)
• keycase (macro)
• load-image (function)
• load-thumbnail (function)
• location (generic function)
• location (method)
• (setf location) (method)
• (setf location) (generic function)
• (setf location) (method)
• main-window (class)
• reload-images (function)
• remove-image-loader (function)
• selected (generic function)
• selected (method)
• (setf selected) (method)
• (setf selected) (generic function)
• (setf selected) (method)
• set-main (generic function)
• set-main (method)
• setup (generic function)
• setup (method)
• setup (method)
• setup (method)
• setup (method)
• sort-files (function)
• teardown (generic function)
• teardown (method)
• thumbnail (class)
• thumbnail-loader-task (class)
• thumbnails (generic function)
• thumbnails (method)
• (setf thumbnails) (method)
• (setf thumbnails) (generic function)
• title (generic function)
• title (method)
• viewer (class)
• with-callback-task (macro)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: main ()

Package

halftone

Source

main.lisp (file)

Function: start ()

Package

halftone

Source

main.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *image-loaders*

Package

halftone

Source

images.lisp (file)

Special Variable: *image-runner*

Package

halftone

Source

images.lisp (file)

Special Variable: *main*

Package

halftone

Source

main.lisp (file)

5.2.2 Macros

Macro: define-image-loader TYPES (PATHNAME) &body BODY

Package

halftone

Source

images.lisp (file)

Macro: keycase KEY &body CASES

Package

halftone

Source

gallery.lisp (file)

Macro: with-callback-task (TASK &rest TARGS) ARGS &body BODY

Package

halftone

Source

images.lisp (file)

5.2.3 Functions

Function: change-layout GALLERY DIRECTION

Package

halftone

Source

gallery.lisp (file)

Function: directory-images DIR

Package

halftone

Source

gallery.lisp (file)

Function: draw-image-fitting IMAGE TARGET

Package

halftone

Source

images.lisp (file)

Function: image-file-p PATHNAME

Package

halftone

Source

images.lisp (file)

Function: image-loader TYPE

Function: (setf image-loader) FUNCTION TYPE

Package

halftone

Source

images.lisp (file)

Function: load-image PATHNAME

Package

halftone

Source

images.lisp (file)

Function: load-thumbnail PATHNAME &optional SIZE

Package

halftone

Source

images.lisp (file)

Function: reload-images GALLERY

Package

halftone

Source

gallery.lisp (file)

Function: remove-image-loader TYPE

Package

halftone

Source

images.lisp (file)

Function: sort-files FILES BY &optional DESCENDING

Package

halftone

Source

gallery.lisp (file)

5.2.4 Generic functions

Generic Function: %build-main-window-menu-file MAIN-WINDOW

Package

halftone

Methods

Method: %build-main-window-menu-file (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: %build-main-window-menu-help MAIN-WINDOW

Package

halftone

Methods

Method: %build-main-window-menu-help (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: %gallery-override-key-release-event GALLERY EV

Package

halftone

Methods

Method: %gallery-override-key-release-event (GALLERY gallery) EV

Source

gallery.lisp (file)

Generic Function: %gallery-override-resize-event GALLERY EV

Package

halftone

Methods

Method: %gallery-override-resize-event (GALLERY gallery) EV

Source

gallery.lisp (file)

Generic Function: %gallery-subwidget-layout-initializer GALLERY

Package

halftone

Methods

Method: %gallery-subwidget-layout-initializer (GALLERY gallery)

Source

gallery.lisp (file)

Generic Function: %gallery-subwidget-scrollable-initializer GALLERY

Package

halftone

Methods

Method: %gallery-subwidget-scrollable-initializer (GALLERY gallery)

Source

gallery.lisp (file)

Generic Function: %main-window-subwidget-dockable-initializer MAIN-WINDOW

Package

halftone

Methods

Method: %main-window-subwidget-dockable-initializer (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: %main-window-subwidget-gallery-initializer MAIN-WINDOW

Package

halftone

Methods

Method: %main-window-subwidget-gallery-initializer (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: %main-window-subwidget-viewer-initializer MAIN-WINDOW

Package

halftone

Methods

Method: %main-window-subwidget-viewer-initializer (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: %thumbnail-override-mouse-release-event THUMBNAIL EV

Package

halftone

Methods

Method: %thumbnail-override-mouse-release-event (THUMBNAIL thumbnail) EV

Source

gallery.lisp (file)

Generic Function: %thumbnail-override-paint-event THUMBNAIL EV

Package

halftone

Methods

Method: %thumbnail-override-paint-event (THUMBNAIL thumbnail) EV

Source

gallery.lisp (file)

Generic Function: %thumbnail-subwidget-image-initializer THUMBNAIL

Package

halftone

Methods

Method: %thumbnail-subwidget-image-initializer (THUMBNAIL thumbnail)

Source

gallery.lisp (file)

Generic Function: %viewer-override-paint-event VIEWER EV

Package

halftone

Methods

Method: %viewer-override-paint-event (VIEWER viewer) EV

Source

viewer.lisp (file)

Generic Function: callback OBJECT

Generic Function: (setf callback) NEW-VALUE OBJECT

Package

halftone

Methods

Method: callback (IMAGE-LOADER-TASK image-loader-task)

automatically generated reader method

Source

images.lisp (file)

Method: (setf callback) NEW-VALUE (IMAGE-LOADER-TASK image-loader-task)

automatically generated writer method

Source

images.lisp (file)

Generic Function: current OBJECT

Generic Function: (setf current) NEW-VALUE OBJECT

Package

halftone

Methods

Method: current (GALLERY gallery)

automatically generated reader method

Source

gallery.lisp (file)

Method: (setf current) NEW-VALUE (GALLERY gallery)

automatically generated writer method

Source

gallery.lisp (file)

Method: (setf current) NUM (GALLERY gallery) around

Source

gallery.lisp (file)

Generic Function: file CONDITION

Generic Function: (setf file) NEW-VALUE CONDITION

Package

halftone

Methods

Method: file (THUMBNAIL thumbnail)

automatically generated reader method

Source

gallery.lisp (file)

Method: (setf file) NEW-VALUE (THUMBNAIL thumbnail)

automatically generated writer method

Source

gallery.lisp (file)

Method: file (IMAGE-LOADER-TASK image-loader-task)

automatically generated reader method

Source

images.lisp (file)

Method: (setf file) NEW-VALUE (IMAGE-LOADER-TASK image-loader-task)

automatically generated writer method

Source

images.lisp (file)

Method: file (CONDITION image-load-error)

Method: (setf file) NEW-VALUE (CONDITION image-load-error)

Source

images.lisp (file)

Generic Function: image OBJECT

Package

halftone

Writer

(setf image) (generic function)

Methods

Method: image (VIEWER viewer)

automatically generated reader method

Source

viewer.lisp (file)

Generic Function: (setf image) IMAGE THING

Package

halftone

Source

main.lisp (file)

Reader

image (generic function)

Methods

Method: (setf image) (NULL null) (GALLERY gallery)

Source

gallery.lisp (file)

Method: (setf image) (FILE pathname) (GALLERY gallery)

Source

gallery.lisp (file)

Method: (setf image) NEW-VALUE (VIEWER viewer)

automatically generated writer method

Source

viewer.lisp (file)

Method: (setf image) (NULL null) (VIEWER viewer)

Source

viewer.lisp (file)

Method: (setf image) (FILE pathname) (VIEWER viewer)

Source

viewer.lisp (file)

Method: (setf image) THING (VIEWER viewer) before

Source

viewer.lisp (file)

Method: (setf image) THING (MAIN main-window)

Generic Function: location OBJECT

Generic Function: (setf location) NEW-VALUE OBJECT

Package

halftone

Methods

Method: location (GALLERY gallery)

automatically generated reader method

Source

gallery.lisp (file)

Method: (setf location) NEW-VALUE (GALLERY gallery)

automatically generated writer method

Source

gallery.lisp (file)

Method: (setf location) PATHNAME (GALLERY gallery) after

Source

gallery.lisp (file)

Generic Function: selected OBJECT

Generic Function: (setf selected) NEW-VALUE OBJECT

Package

halftone

Methods

Method: selected (THUMBNAIL thumbnail)

automatically generated reader method

Source

gallery.lisp (file)

Method: (setf selected) NEW-VALUE (THUMBNAIL thumbnail)

automatically generated writer method

Source

gallery.lisp (file)

Method: (setf selected) VAL (THUMBNAIL thumbnail) after

Source

gallery.lisp (file)

Generic Function: set-main MAIN-WINDOW

Package

halftone

Methods

Method: set-main (MAIN-WINDOW main-window)

Source

main.lisp (file)

Generic Function: setup DOCK-CONTAINER

Package

halftone

Methods

Method: setup (GALLERY gallery)

Source

gallery.lisp (file)

Method: setup (THUMBNAIL thumbnail)

Source

gallery.lisp (file)

Method: setup (VIEWER viewer)

Source

viewer.lisp (file)

Method: setup (DOCK-CONTAINER dock-container)

Source

main.lisp (file)

Generic Function: teardown GALLERY

Package

halftone

Methods

Method: teardown (GALLERY gallery)

Source

gallery.lisp (file)

Generic Function: thumbnails OBJECT

Generic Function: (setf thumbnails) NEW-VALUE OBJECT

Package

halftone

Methods

Method: thumbnails (GALLERY gallery)

automatically generated reader method

Source

gallery.lisp (file)

Method: (setf thumbnails) NEW-VALUE (GALLERY gallery)

automatically generated writer method

Source

gallery.lisp (file)

Generic Function: title OBJECT

Package

halftone

Methods

Method: title (DOCK-CONTAINER dock-container)

automatically generated reader method

Source

main.lisp (file)

5.2.5 Conditions

Condition: image-load-error ()

Package

halftone

Source

images.lisp (file)

Direct superclasses

error (condition)

Direct methods

• file (method)
• file (method)

Direct slots

Slot: file

Initargs

:file

Initform

(quote nil)

Readers

file (generic function)

Writers

(setf file) (generic function)

5.2.6 Classes

Class: dock-container ()

Package

halftone

Source

main.lisp (file)

Direct superclasses

widget (class)

Direct methods

• setup (method)
• title (method)
• widget (method)

Direct slots

Slot: widget

Initargs

:widget

Readers

widget (generic function)

Slot: title

Initargs

:title

Readers

title (generic function)

Direct Default Initargs

Initarg	Value
:widget	(error "widget required.")
:title	""

Class: gallery ()

Package

halftone

Source

gallery.lisp (file)

Direct superclasses

widget (class)

Direct methods

• teardown (method)
• setup (method)
• %gallery-override-resize-event (method)
• %gallery-override-key-release-event (method)
• %gallery-subwidget-layout-initializer (method)
• %gallery-subwidget-scrollable-initializer (method)
• (setf image) (method)
• (setf image) (method)
• (setf current) (method)
• (setf location) (method)
• current (method)
• current (method)
• thumbnails (method)
• thumbnails (method)
• location (method)
• location (method)

Direct slots

Slot: location

Initargs

:location

Readers

location (generic function)

Writers

(setf location) (generic function)

Slot: thumbnails

Readers

thumbnails (generic function)

Writers

(setf thumbnails) (generic function)

Slot: current

Initform

-1

Readers

current (generic function)

Writers

(setf current) (generic function)

Slot: scrollable

Slot: layout

Direct Default Initargs

Initarg	Value
:location	(user-homedir-pathname)

Class: image-loader-task ()

Package

halftone

Source

images.lisp (file)

Direct superclasses

task (class)

Direct subclasses

thumbnail-loader-task (class)

Direct methods

• run-task (method)
• run-task (method)
• print-object (method)
• callback (method)
• callback (method)
• file (method)
• file (method)

Direct slots

Slot: file

Initargs

:file

Readers

file (generic function)

Writers

(setf file) (generic function)

Slot: callback

Initargs

:callback

Readers

callback (generic function)

Writers

(setf callback) (generic function)

Direct Default Initargs

Initarg	Value
:file	(error "file required.")

Class: main-window ()

Package

halftone

Source

main.lisp (file)

Direct superclasses

widget (class)

Direct methods

• %build-main-window-menu-help (method)
• %build-main-window-menu-file (method)
• (setf image) (method)
• %main-window-subwidget-dockable-initializer (method)
• %main-window-subwidget-gallery-initializer (method)
• %main-window-subwidget-viewer-initializer (method)
• set-main (method)

Direct slots

Slot: viewer

Slot: gallery

Slot: dockable

Class: thumbnail ()

Package

halftone

Source

gallery.lisp (file)

Direct superclasses

widget (class)

Direct methods

• %thumbnail-override-mouse-release-event (method)
• %thumbnail-override-paint-event (method)
• %thumbnail-subwidget-image-initializer (method)
• setup (method)
• (setf selected) (method)
• selected (method)
• selected (method)
• file (method)
• file (method)

Direct slots

Slot: file

Initargs

:file

Readers

file (generic function)

Writers

(setf file) (generic function)

Slot: selected

Initargs

:selected

Readers

selected (generic function)

Writers

(setf selected) (generic function)

Slot: image

Direct Default Initargs

Initarg	Value
:file	(error "file required.")
:selected	nil

Class: thumbnail-loader-task ()

Package

halftone

Source

images.lisp (file)

Direct superclasses

image-loader-task (class)

Direct methods

run-task (method)

Class: viewer ()

Package

halftone

Source

viewer.lisp (file)

Direct superclasses

widget (class)

Direct methods

• %viewer-override-paint-event (method)
• setup (method)
• (setf image) (method)
• image (method)
• (setf image) (method)
• (setf image) (method)
• (setf image) (method)

Direct slots

Slot: image

Initargs

:image

Readers

image (generic function)

Writers

(setf image) (generic function)

Direct Default Initargs

Initarg	Value
:image	nil

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types