The halftone Reference Manual

This is the halftone Reference Manual, version 1.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon May 15 05:08:41 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 halftone

An image viewer using Qtools

Maintainer

Nicolas Hafner <>

Author

Nicolas Hafner <>

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

Version

1.1.0

Defsystem Dependency

qtools (system).

Dependencies
  • qtools (system).
  • qtcore (system).
  • qtgui (system).
  • qtopengl (system).
  • uiop (system).
  • verbose (system).
  • simple-tasks (system).
  • bordeaux-threads (system).
Source

halftone.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 halftone/halftone.asd

Source

halftone.asd.

Parent Component

halftone (system).

ASDF Systems

halftone.


3.1.2 halftone/package.lisp

Source

halftone.asd.

Parent Component

halftone (system).

Packages

halftone.


3.1.3 halftone/images.lisp

Dependency

package.lisp (file).

Source

halftone.asd.

Parent Component

halftone (system).

Public Interface
Internals

3.1.4 halftone/main.lisp

Dependency

images.lisp (file).

Source

halftone.asd.

Parent Component

halftone (system).

Public Interface
Internals

3.1.5 halftone/viewer.lisp

Dependency

main.lisp (file).

Source

halftone.asd.

Parent Component

halftone (system).

Internals

3.1.6 halftone/gallery.lisp

Dependency

viewer.lisp (file).

Source

halftone.asd.

Parent Component

halftone (system).

Internals

4 Packages

Packages are listed by definition order.


4.1 halftone

Source

package.lisp.

Nickname

org.shirakumo.halftone

Use List

cl+qt.

Public Interface
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: main ()
Package

halftone.

Source

main.lisp.

Function: start ()
Package

halftone.

Source

main.lisp.


5.1.2 Standalone methods

Method: print-object ((task image-loader-task) stream)
Source

images.lisp.

Method: run-task ((task thumbnail-loader-task))
Package

simple-tasks.

Source

images.lisp.

Method: run-task :around ((task image-loader-task))
Package

simple-tasks.

Source

images.lisp.

Method: run-task ((task image-loader-task))
Package

simple-tasks.

Source

images.lisp.

Reader Method: widget ((dock-container dock-container))

automatically generated reader method

Package

qtools.

Source

main.lisp.

Target Slot

widget.


5.2 Internals


5.2.1 Special variables

Special Variable: *image-loaders*
Package

halftone.

Source

images.lisp.

Special Variable: *image-runner*
Package

halftone.

Source

images.lisp.

Special Variable: *main*
Package

halftone.

Source

main.lisp.


5.2.2 Macros

Macro: define-image-loader (types (pathname) &body body)
Package

halftone.

Source

images.lisp.

Macro: keycase (key &body cases)
Package

halftone.

Source

gallery.lisp.

Macro: with-callback-task ((task &rest targs) args &body body)
Package

halftone.

Source

images.lisp.


5.2.3 Ordinary functions

Function: change-layout (gallery direction)
Package

halftone.

Source

gallery.lisp.

Function: directory-images (dir)
Package

halftone.

Source

gallery.lisp.

Function: draw-image-fitting (image target)
Package

halftone.

Source

images.lisp.

Function: image-file-p (pathname)
Package

halftone.

Source

images.lisp.

Function: image-loader (type)
Package

halftone.

Source

images.lisp.

Function: (setf image-loader) (type)
Package

halftone.

Source

images.lisp.

Function: load-image (pathname)
Package

halftone.

Source

images.lisp.

Function: load-thumbnail (pathname &optional size)
Package

halftone.

Source

images.lisp.

Function: reload-images (gallery)
Package

halftone.

Source

gallery.lisp.

Function: remove-image-loader (type)
Package

halftone.

Source

images.lisp.

Function: sort-files (files by &optional descending)
Package

halftone.

Source

gallery.lisp.


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.

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.

Generic Function: %gallery-override-key-release-event (gallery ev)
Package

halftone.

Methods
Method: %gallery-override-key-release-event ((gallery gallery) ev)
Source

gallery.lisp.

Generic Function: %gallery-override-resize-event (gallery ev)
Package

halftone.

Methods
Method: %gallery-override-resize-event ((gallery gallery) ev)
Source

gallery.lisp.

Generic Function: %gallery-subwidget-layout-initializer (gallery)
Package

halftone.

Methods
Method: %gallery-subwidget-layout-initializer ((gallery gallery))
Source

gallery.lisp.

Generic Function: %gallery-subwidget-scrollable-initializer (gallery)
Package

halftone.

Methods
Method: %gallery-subwidget-scrollable-initializer ((gallery gallery))
Source

gallery.lisp.

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.

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.

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.

Generic Function: %thumbnail-override-mouse-release-event (thumbnail ev)
Package

halftone.

Methods
Method: %thumbnail-override-mouse-release-event ((thumbnail thumbnail) ev)
Source

gallery.lisp.

Generic Function: %thumbnail-override-paint-event (thumbnail ev)
Package

halftone.

Methods
Method: %thumbnail-override-paint-event ((thumbnail thumbnail) ev)
Source

gallery.lisp.

Generic Function: %thumbnail-subwidget-image-initializer (thumbnail)
Package

halftone.

Methods
Method: %thumbnail-subwidget-image-initializer ((thumbnail thumbnail))
Source

gallery.lisp.

Generic Function: %viewer-override-paint-event (viewer ev)
Package

halftone.

Methods
Method: %viewer-override-paint-event ((viewer viewer) ev)
Source

viewer.lisp.

Generic Reader: callback (object)
Package

halftone.

Methods
Reader Method: callback ((image-loader-task image-loader-task))

automatically generated reader method

Source

images.lisp.

Target Slot

callback.

Generic Writer: (setf callback) (object)
Package

halftone.

Methods
Writer Method: (setf callback) ((image-loader-task image-loader-task))

automatically generated writer method

Source

images.lisp.

Target Slot

callback.

Generic Reader: current (object)
Package

halftone.

Methods
Reader Method: current ((gallery gallery))

automatically generated reader method

Source

gallery.lisp.

Target Slot

current.

Generic Function: (setf current) (object)
Package

halftone.

Methods
Writer Method: (setf current) :around ((gallery gallery))
Source

gallery.lisp.

Target Slot

current.

Method: (setf current) ((gallery gallery))

automatically generated writer method

Source

gallery.lisp.

Generic Reader: file (condition)
Package

halftone.

Methods
Reader Method: file ((thumbnail thumbnail))

automatically generated reader method

Source

gallery.lisp.

Target Slot

file.

Reader Method: file ((image-loader-task image-loader-task))

automatically generated reader method

Source

images.lisp.

Target Slot

file.

Reader Method: file ((condition image-load-error))
Source

images.lisp.

Target Slot

file.

Generic Writer: (setf file) (condition)
Package

halftone.

Methods
Writer Method: (setf file) ((thumbnail thumbnail))

automatically generated writer method

Source

gallery.lisp.

Target Slot

file.

Writer Method: (setf file) ((image-loader-task image-loader-task))

automatically generated writer method

Source

images.lisp.

Target Slot

file.

Writer Method: (setf file) ((condition image-load-error))
Source

images.lisp.

Target Slot

file.

Generic Reader: image (object)
Package

halftone.

Methods
Reader Method: image ((viewer viewer))

automatically generated reader method

Source

viewer.lisp.

Target Slot

image.

Generic Function: (setf image) (thing)
Package

halftone.

Source

main.lisp.

Methods
Method: (setf image) ((gallery gallery))
Source

gallery.lisp.

Method: (setf image) ((gallery gallery))
Source

gallery.lisp.

Writer Method: (setf image) ((viewer viewer))

automatically generated writer method

Source

viewer.lisp.

Target Slot

image.

Method: (setf image) ((viewer viewer))
Source

viewer.lisp.

Method: (setf image) ((viewer viewer))
Source

viewer.lisp.

Method: (setf image) :before ((viewer viewer))
Source

viewer.lisp.

Method: (setf image) ((main main-window))
Generic Reader: location (object)
Package

halftone.

Methods
Reader Method: location ((gallery gallery))

automatically generated reader method

Source

gallery.lisp.

Target Slot

location.

Generic Function: (setf location) (object)
Package

halftone.

Methods
Writer Method: (setf location) :after ((gallery gallery))
Source

gallery.lisp.

Target Slot

location.

Method: (setf location) ((gallery gallery))

automatically generated writer method

Source

gallery.lisp.

Generic Reader: selected (object)
Package

halftone.

Methods
Reader Method: selected ((thumbnail thumbnail))

automatically generated reader method

Source

gallery.lisp.

Target Slot

selected.

Generic Function: (setf selected) (object)
Package

halftone.

Methods
Writer Method: (setf selected) :after ((thumbnail thumbnail))
Source

gallery.lisp.

Target Slot

selected.

Method: (setf selected) ((thumbnail thumbnail))

automatically generated writer method

Source

gallery.lisp.

Generic Function: set-main (main-window)
Package

halftone.

Methods
Method: set-main ((main-window main-window))
Source

main.lisp.

Generic Function: setup (dock-container)
Package

halftone.

Methods
Method: setup ((gallery gallery))
Source

gallery.lisp.

Method: setup ((thumbnail thumbnail))
Source

gallery.lisp.

Method: setup ((viewer viewer))
Source

viewer.lisp.

Method: setup ((dock-container dock-container))
Source

main.lisp.

Generic Function: teardown (gallery)
Package

halftone.

Methods
Method: teardown ((gallery gallery))
Source

gallery.lisp.

Generic Reader: thumbnails (object)
Package

halftone.

Methods
Reader Method: thumbnails ((gallery gallery))

automatically generated reader method

Source

gallery.lisp.

Target Slot

thumbnails.

Generic Writer: (setf thumbnails) (object)
Package

halftone.

Methods
Writer Method: (setf thumbnails) ((gallery gallery))

automatically generated writer method

Source

gallery.lisp.

Target Slot

thumbnails.

Generic Reader: title (object)
Package

halftone.

Methods
Reader Method: title ((dock-container dock-container))

automatically generated reader method

Source

main.lisp.

Target Slot

title.


5.2.5 Conditions

Condition: image-load-error
Package

halftone.

Source

images.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: file
Initform

(quote nil)

Initargs

:file

Readers

file.

Writers

(setf file).


5.2.6 Classes

Class: dock-container
Package

halftone.

Source

main.lisp.

Direct superclasses

widget.

Direct methods
Direct Default Initargs
InitargValue
:widget(error widget required.)
:title
Direct slots
Slot: widget
Package

qtools.

Initargs

:widget

Readers

widget.

Writers

This slot is read-only.

Slot: title
Initargs

:title

Readers

title.

Writers

This slot is read-only.

Package

halftone.

Source

gallery.lisp.

Direct superclasses

widget.

Direct methods
Direct Default Initargs
InitargValue
:location(user-homedir-pathname)
Direct slots
Slot: location
Initargs

:location

Readers

location.

Writers

(setf location).

Slot: thumbnails
Readers

thumbnails.

Writers

(setf thumbnails).

Slot: current
Initform

-1

Readers

current.

Writers

(setf current).

Slot: scrollable
Slot: layout
Class: image-loader-task
Package

halftone.

Source

images.lisp.

Direct superclasses

task.

Direct subclasses

thumbnail-loader-task.

Direct methods
Direct Default Initargs
InitargValue
:file(error file required.)
Direct slots
Slot: file
Initargs

:file

Readers

file.

Writers

(setf file).

Slot: callback
Initargs

:callback

Readers

callback.

Writers

(setf callback).

Class: main-window
Package

halftone.

Source

main.lisp.

Direct superclasses

widget.

Direct methods
Direct slots
Slot: viewer
Slot: dockable
Class: thumbnail
Package

halftone.

Source

gallery.lisp.

Direct superclasses

widget.

Direct methods
Direct Default Initargs
InitargValue
:file(error file required.)
:selectednil
Direct slots
Slot: file
Initargs

:file

Readers

file.

Writers

(setf file).

Slot: selected
Initargs

:selected

Readers

selected.

Writers

(setf selected).

Slot: image
Class: thumbnail-loader-task
Package

halftone.

Source

images.lisp.

Direct superclasses

image-loader-task.

Direct methods

run-task.

Class: viewer
Package

halftone.

Source

viewer.lisp.

Direct superclasses

widget.

Direct methods
Direct Default Initargs
InitargValue
:imagenil
Direct slots
Slot: image
Initargs

:image

Readers

image.

Writers

(setf image).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   F   G   I   K   L   M   P   R   S   T   W  
Index Entry  Section

%
%build-main-window-menu-file: Private generic functions
%build-main-window-menu-file: Private generic functions
%build-main-window-menu-help: Private generic functions
%build-main-window-menu-help: Private generic functions
%gallery-override-key-release-event: Private generic functions
%gallery-override-key-release-event: Private generic functions
%gallery-override-resize-event: Private generic functions
%gallery-override-resize-event: Private generic functions
%gallery-subwidget-layout-initializer: Private generic functions
%gallery-subwidget-layout-initializer: Private generic functions
%gallery-subwidget-scrollable-initializer: Private generic functions
%gallery-subwidget-scrollable-initializer: Private generic functions
%main-window-subwidget-dockable-initializer: Private generic functions
%main-window-subwidget-dockable-initializer: Private generic functions
%main-window-subwidget-gallery-initializer: Private generic functions
%main-window-subwidget-gallery-initializer: Private generic functions
%main-window-subwidget-viewer-initializer: Private generic functions
%main-window-subwidget-viewer-initializer: Private generic functions
%thumbnail-override-mouse-release-event: Private generic functions
%thumbnail-override-mouse-release-event: Private generic functions
%thumbnail-override-paint-event: Private generic functions
%thumbnail-override-paint-event: Private generic functions
%thumbnail-subwidget-image-initializer: Private generic functions
%thumbnail-subwidget-image-initializer: Private generic functions
%viewer-override-paint-event: Private generic functions
%viewer-override-paint-event: Private generic functions

(
(setf callback): Private generic functions
(setf callback): Private generic functions
(setf current): Private generic functions
(setf current): Private generic functions
(setf current): Private generic functions
(setf file): Private generic functions
(setf file): Private generic functions
(setf file): Private generic functions
(setf file): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image): Private generic functions
(setf image-loader): Private ordinary functions
(setf location): Private generic functions
(setf location): Private generic functions
(setf location): Private generic functions
(setf selected): Private generic functions
(setf selected): Private generic functions
(setf selected): Private generic functions
(setf thumbnails): Private generic functions
(setf thumbnails): Private generic functions

C
callback: Private generic functions
callback: Private generic functions
change-layout: Private ordinary functions
current: Private generic functions
current: Private generic functions

D
define-image-loader: Private macros
directory-images: Private ordinary functions
draw-image-fitting: Private ordinary functions

F
file: Private generic functions
file: Private generic functions
file: Private generic functions
file: Private generic functions
Function, (setf image-loader): Private ordinary functions
Function, change-layout: Private ordinary functions
Function, directory-images: Private ordinary functions
Function, draw-image-fitting: Private ordinary functions
Function, image-file-p: Private ordinary functions
Function, image-loader: Private ordinary functions
Function, load-image: Private ordinary functions
Function, load-thumbnail: Private ordinary functions
Function, main: Public ordinary functions
Function, reload-images: Private ordinary functions
Function, remove-image-loader: Private ordinary functions
Function, sort-files: Private ordinary functions
Function, start: Public ordinary functions

G
Generic Function, %build-main-window-menu-file: Private generic functions
Generic Function, %build-main-window-menu-help: Private generic functions
Generic Function, %gallery-override-key-release-event: Private generic functions
Generic Function, %gallery-override-resize-event: Private generic functions
Generic Function, %gallery-subwidget-layout-initializer: Private generic functions
Generic Function, %gallery-subwidget-scrollable-initializer: Private generic functions
Generic Function, %main-window-subwidget-dockable-initializer: Private generic functions
Generic Function, %main-window-subwidget-gallery-initializer: Private generic functions
Generic Function, %main-window-subwidget-viewer-initializer: Private generic functions
Generic Function, %thumbnail-override-mouse-release-event: Private generic functions
Generic Function, %thumbnail-override-paint-event: Private generic functions
Generic Function, %thumbnail-subwidget-image-initializer: Private generic functions
Generic Function, %viewer-override-paint-event: Private generic functions
Generic Function, (setf callback): Private generic functions
Generic Function, (setf current): Private generic functions
Generic Function, (setf file): Private generic functions
Generic Function, (setf image): Private generic functions
Generic Function, (setf location): Private generic functions
Generic Function, (setf selected): Private generic functions
Generic Function, (setf thumbnails): Private generic functions
Generic Function, callback: Private generic functions
Generic Function, current: Private generic functions
Generic Function, file: Private generic functions
Generic Function, image: Private generic functions
Generic Function, location: Private generic functions
Generic Function, selected: Private generic functions
Generic Function, set-main: Private generic functions
Generic Function, setup: Private generic functions
Generic Function, teardown: Private generic functions
Generic Function, thumbnails: Private generic functions
Generic Function, title: Private generic functions

I
image: Private generic functions
image: Private generic functions
image-file-p: Private ordinary functions
image-loader: Private ordinary functions

K
keycase: Private macros

L
load-image: Private ordinary functions
load-thumbnail: Private ordinary functions
location: Private generic functions
location: Private generic functions

M
Macro, define-image-loader: Private macros
Macro, keycase: Private macros
Macro, with-callback-task: Private macros
main: Public ordinary functions
Method, %build-main-window-menu-file: Private generic functions
Method, %build-main-window-menu-help: Private generic functions
Method, %gallery-override-key-release-event: Private generic functions
Method, %gallery-override-resize-event: Private generic functions
Method, %gallery-subwidget-layout-initializer: Private generic functions
Method, %gallery-subwidget-scrollable-initializer: Private generic functions
Method, %main-window-subwidget-dockable-initializer: Private generic functions
Method, %main-window-subwidget-gallery-initializer: Private generic functions
Method, %main-window-subwidget-viewer-initializer: Private generic functions
Method, %thumbnail-override-mouse-release-event: Private generic functions
Method, %thumbnail-override-paint-event: Private generic functions
Method, %thumbnail-subwidget-image-initializer: Private generic functions
Method, %viewer-override-paint-event: Private generic functions
Method, (setf callback): Private generic functions
Method, (setf current): Private generic functions
Method, (setf current): Private generic functions
Method, (setf file): Private generic functions
Method, (setf file): Private generic functions
Method, (setf file): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf image): Private generic functions
Method, (setf location): Private generic functions
Method, (setf location): Private generic functions
Method, (setf selected): Private generic functions
Method, (setf selected): Private generic functions
Method, (setf thumbnails): Private generic functions
Method, callback: Private generic functions
Method, current: Private generic functions
Method, file: Private generic functions
Method, file: Private generic functions
Method, file: Private generic functions
Method, image: Private generic functions
Method, location: Private generic functions
Method, print-object: Public standalone methods
Method, run-task: Public standalone methods
Method, run-task: Public standalone methods
Method, run-task: Public standalone methods
Method, selected: Private generic functions
Method, set-main: Private generic functions
Method, setup: Private generic functions
Method, setup: Private generic functions
Method, setup: Private generic functions
Method, setup: Private generic functions
Method, teardown: Private generic functions
Method, thumbnails: Private generic functions
Method, title: Private generic functions
Method, widget: Public standalone methods

P
print-object: Public standalone methods

R
reload-images: Private ordinary functions
remove-image-loader: Private ordinary functions
run-task: Public standalone methods
run-task: Public standalone methods
run-task: Public standalone methods

S
selected: Private generic functions
selected: Private generic functions
set-main: Private generic functions
set-main: Private generic functions
setup: Private generic functions
setup: Private generic functions
setup: Private generic functions
setup: Private generic functions
setup: Private generic functions
sort-files: Private ordinary functions
start: Public ordinary functions

T
teardown: Private generic functions
teardown: Private generic functions
thumbnails: Private generic functions
thumbnails: Private generic functions
title: Private generic functions
title: Private generic functions

W
widget: Public standalone methods
with-callback-task: Private macros


A.3 Variables


A.4 Data types