The kekule-clj Reference Manual

4.1.1 kekule-clj/kekule-clj.asd

Source

kekule-clj.asd.

Parent Component

kekule-clj (system).

ASDF Systems

kekule-clj.

4.1.2 kekule-clj/src/packages.lisp

Source

kekule-clj.asd.

Parent Component

src (module).

Packages

kekule.

4.1.3 kekule-clj/src/version.lisp

Dependency

packages.lisp (file).

Source

kekule-clj.asd.

Parent Component

src (module).

Internals

• +module-name+ (special variable).
• +module-version+ (special variable).

4.1.4 kekule-clj/src/widget.lisp

Dependency

version.lisp (file).

Source

kekule-clj.asd.

Parent Component

src (module).

Public Interface

• +kekule-json-format+ (special variable).
• +kekule-xml-format+ (special variable).
• +mdl-mol-2000-format+ (special variable).
• +mdl-mol-3000-format+ (special variable).
• +mdl-reaction-2000-format+ (special variable).
• +mdl-reaction-3000-format+ (special variable).
• +mdl-structure-data-format+ (special variable).
• +smiles-format+ (special variable).
• composer (class).
• data (reader method).
• (setf data) (writer method).
• diagram (class).
• enable-direct-interaction (reader method).
• (setf enable-direct-interaction) (writer method).
• enable-edit (reader method).
• (setf enable-edit) (writer method).
• enable-toolbar (reader method).
• (setf enable-toolbar) (writer method).
• fit (function).
• format-id (reader method).
• (setf format-id) (writer method).
• load-data (function).
• load-file (function).
• load-url (function).
• resizable (reader method).
• (setf resizable) (writer method).
• tool-buttons (reader method).
• (setf tool-buttons) (writer method).

Internals

chem-widget (class).

4.1.5 kekule-clj/src/register-widgets.lisp

Dependency

widget.lisp (file).

Source

kekule-clj.asd.

Parent Component

src (module).

Public Interface

• make-composer (function).
• make-diagram (function).

6.1.1 Special variables

Special Variable: +kekule-json-format+ ¶

Kekule native JSON format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +kekule-xml-format+ ¶

Kekule specific XML format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +mdl-mol-2000-format+ ¶

MDL Molfile V2000 format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +mdl-mol-3000-format+ ¶

MDL Molfile V3000 format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +mdl-reaction-2000-format+ ¶

MDL Reaction V2000 format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +mdl-reaction-3000-format+ ¶

MDL Reaction V3000 format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +mdl-structure-data-format+ ¶

MDL Structure Data format tag

Package

kekule.

Source

widget.lisp.

Special Variable: +smiles-format+ ¶

Simplified molecular-input line-entry system format tag

Package

kekule.

Source

widget.lisp.

6.1.2 Ordinary functions

Function: fit (instance) ¶

Fit view to current structures.

Package

kekule.

Source

widget.lisp.

Function: load-data (instance data format-id) ¶

Load molecular data into an existing widget.

Package

kekule.

Source

widget.lisp.

Function: load-file (instance path) ¶

Load molecular data from a file into an existing widget.

Package

kekule.

Source

widget.lisp.

Function: load-url (instance url) ¶

Load molecular data from a url into an existing widget.

Package

kekule.

Source

widget.lisp.

Function: make-composer (&rest initargs &key comm-id on-close layout tabbable tooltip data format-id &allow-other-keys) ¶

Package

kekule.

Source

register-widgets.lisp.

Function: make-diagram (&rest initargs &key comm-id on-close layout tabbable tooltip data format-id enable-toolbar enable-direct-interaction enable-edit tool-buttons resizable &allow-other-keys) ¶

Package

kekule.

Source

register-widgets.lisp.

6.1.3 Generic functions

Generic Reader: data (object) ¶

Generic Writer: (setf data) (object) ¶

Package

kekule.

Methods

Reader Method: data ((chem-widget chem-widget)) ¶

Writer Method: (setf data) ((chem-widget chem-widget)) ¶

Data to be displayed by the widget.

Source

widget.lisp.

Target Slot

data.

Generic Reader: enable-direct-interaction (object) ¶

Generic Writer: (setf enable-direct-interaction) (object) ¶

Package

kekule.

Methods

Reader Method: enable-direct-interaction ((diagram diagram)) ¶

Writer Method: (setf enable-direct-interaction) ((diagram diagram)) ¶

Whether to allow interaction with the molecule or not.

Source

widget.lisp.

Target Slot

enable-direct-interaction.

Generic Reader: enable-edit (object) ¶

Generic Writer: (setf enable-edit) (object) ¶

Package

kekule.

Methods

Reader Method: enable-edit ((diagram diagram)) ¶

Writer Method: (setf enable-edit) ((diagram diagram)) ¶

Whether to allow a popup editor to be shown or not.

Source

widget.lisp.

Target Slot

enable-edit.

Generic Reader: enable-toolbar (object) ¶

Generic Writer: (setf enable-toolbar) (object) ¶

Package

kekule.

Methods

Reader Method: enable-toolbar ((diagram diagram)) ¶

Writer Method: (setf enable-toolbar) ((diagram diagram)) ¶

Whether to show the toolbar or not.

Source

widget.lisp.

Target Slot

enable-toolbar.

Generic Reader: format-id (object) ¶

Generic Writer: (setf format-id) (object) ¶

Package

kekule.

Methods

Reader Method: format-id ((chem-widget chem-widget)) ¶

Writer Method: (setf format-id) ((chem-widget chem-widget)) ¶

Format tag of data. Current allowed values are smi, Kekule-JSON, Kekuule-XML, mol, mol3k, sd, rxn and rxn3k.

Source

widget.lisp.

Target Slot

format-id.

Generic Reader: resizable (object) ¶

Generic Writer: (setf resizable) (object) ¶

Package

kekule.

Methods

Reader Method: resizable ((diagram diagram)) ¶

Writer Method: (setf resizable) ((diagram diagram)) ¶

Whether the diagram is resizable or not.

Source

widget.lisp.

Target Slot

resizable.

Generic Reader: tool-buttons (object) ¶

Generic Writer: (setf tool-buttons) (object) ¶

Package

kekule.

Methods

Reader Method: tool-buttons ((diagram diagram)) ¶

Writer Method: (setf tool-buttons) ((diagram diagram)) ¶

A list of the names of buttons to show in the toolbar.

Source

widget.lisp.

Target Slot

tool-buttons.

6.1.4 Classes

Class: composer ¶

A widget that edits molecular data.

Package

kekule.

Source

widget.lisp.

Direct superclasses

chem-widget.

Direct Default Initargs

Initarg	Value
:%model-name	kekulecomposermodel
:%view-name	kekulecomposerview

Class: diagram ¶

A widget that displays molecular data.

Package

kekule.

Source

widget.lisp.

Direct superclasses

chem-widget.

Direct methods

• (setf enable-direct-interaction).
• enable-direct-interaction.
• (setf enable-edit).
• enable-edit.
• (setf enable-toolbar).
• enable-toolbar.
• (setf resizable).
• resizable.
• (setf tool-buttons).
• tool-buttons.

Direct Default Initargs

Initarg	Value
:%model-name	kekulediagrammodel
:%view-name	kekulediagramview

Direct slots

Slot: enable-toolbar ¶

Whether to show the toolbar or not.

Type

boolean

Initargs

:enable-toolbar

Readers

enable-toolbar.

Writers

(setf enable-toolbar).

Slot: enable-direct-interaction ¶

Whether to allow interaction with the molecule or not.

Type

boolean

Initform

t

Initargs

:enable-direct-interaction

Readers

enable-direct-interaction.

Writers

(setf enable-direct-interaction).

Slot: enable-edit ¶

Whether to allow a popup editor to be shown or not.

Type

boolean

Initform

t

Initargs

:enable-edit

Readers

enable-edit.

Writers

(setf enable-edit).

Slot: tool-buttons ¶

A list of the names of buttons to show in the toolbar.

Type

list

Initform

(list "loaddata" "savedata" "moldisplaytype" "molhidehydrogens" "zoomin" "zoomout" "rotateleft" "rotateright" "rotatex" "rotatey" "rotatez" "reset" "openeditor" "config")

Initargs

:tool-buttons

Readers

tool-buttons.

Writers

(setf tool-buttons).

Slot: resizable ¶

Whether the diagram is resizable or not.

Type

boolean

Initargs

:resizable

Readers

resizable.

Writers

(setf resizable).

6.2.1 Special variables

Special Variable: +module-name+ ¶

Package

kekule.

Source

version.lisp.

Special Variable: +module-version+ ¶

Package

kekule.

Source

version.lisp.

6.2.2 Classes

Class: chem-widget ¶

Base widget used by the diagram and composer widgets.

Package

kekule.

Source

widget.lisp.

Direct superclasses

dom-widget.

Direct subclasses

• composer.
• diagram.

Direct methods

• (setf data).
• data.
• (setf format-id).
• format-id.

Direct Default Initargs

Initarg	Value
:%model-module	+module-name+
:%model-module-version	+module-version+
:%view-module	+module-name+
:%view-module-version	+module-version+
:layout	(make-instance (quote layout) width 100% height 480px)

Direct slots

Slot: data ¶

Data to be displayed by the widget.

Initform

"untitled document"

Initargs

:data

Readers

data.

Writers

(setf data).

Slot: format-id ¶

Format tag of data. Current allowed values are smi, Kekule-JSON, Kekuule-XML, mol, mol3k, sd, rxn and rxn3k.

Type

string

Initform

kekule:+mdl-reaction-2000-format+

Initargs

:format-id

Readers

format-id.

Writers

(setf format-id).