The clog-ace Reference Manual

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

The clog-ace Reference Manual

This is the clog-ace Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 05:23:12 2022 GMT+0.

Table of Contents


1 Introduction

CLOG Plugin for the ACE Editor

https://ace.c9.io/

(ql:quickload :clog-ace/tools)
(clog-tools:clog-builder)

2 Systems

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


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

2.1 clog-ace

CLOG Ace Editor Plugin

Author

<some@one.com>

License

BSD

Version

0.0.0

Dependency

clog (system).

Source

clog-ace.asd.

Child Component

clog-ace.lisp (file).


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   [Contents][Index]

3.1.1 clog-ace/clog-ace.asd

Source

clog-ace.asd.

Parent Component

clog-ace (system).

ASDF Systems

clog-ace.


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

3.1.2 clog-ace/clog-ace.lisp

Source

clog-ace.asd.

Parent Component

clog-ace (system).

Packages

clog-ace.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


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

4.1 clog-ace

Source

clog-ace.lisp.

Use List
  • clog.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


5.1.1 Ordinary functions

Function: set-on-auto-complete (obj handler &key default-score meta)

There can only be one auto complete handler per application currently.

Package

clog-ace.

Source

clog-ace.lisp.

Function: start-test ()
Package

clog-ace.

Source

clog-ace.lisp.


5.1.2 Generic functions

Generic Function: attach-clog-ace (clog-ace-element)

Initialize plugin

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: attach-clog-ace ((obj clog-ace-element))
Generic Function: clipboard-copy (clog-ace-element)

Copy selected text to global clipboard and return text.

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: clipboard-copy ((obj clog-ace-element))
Generic Function: clipboard-cut (clog-ace-element)

Copy selected text to global clipboard and return text.

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: clipboard-cut ((obj clog-ace-element))
Generic Function: clipboard-paste (clog-ace-element)

Paste selected text to global clipboard and return text.

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: clipboard-paste ((obj clog-ace-element))
Generic Function: create-clog-ace-element (clog-obj &key hidden class html-id auto-place)

Create a new clog-ace-element as child of CLOG-OBJ.

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: create-clog-ace-element ((obj clog-obj) &key hidden class html-id auto-place)

Create ace editor

Generic Function: execute-command (clog-ace-element command)

execute-command COMMAND

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: execute-command ((obj clog-ace-element) command)
Generic Function: get-mode-from-extension (clog-ace-element file-name)
Package

clog-ace.

Methods
Method: get-mode-from-extension ((obj clog-ace-element) file-name)
Source

clog-ace.lisp.

Method: get-mode-from-extension (clog-ace-element file-name)
Source

clog-ace.lisp.

Generic Function: init-clog-ace (clog-ace-element)

Initialize ace library

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: init-clog-ace ((obj clog-ace-element))
Generic Function: mode (clog-ace-element)

The ace edit mode. eg. ace/mode/lisp

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: mode ((obj clog-ace-element))
Generic Function: (setf mode) (clog-ace-element)

The ace edit mode. eg. ace/mode/lisp

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: (setf mode) ((obj clog-ace-element))
Generic Function: move-cursor (clog-ace-element x y)

move-cursor to x y

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: move-cursor ((obj clog-ace-element) x y)
Generic Function: resize (clog-ace-element)

Trigger a resize of the underlying editor in contained in the CLOG-ACE-ELEMENT

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: resize ((obj clog-ace-element))
Generic Function: selected-text (clog-ace-element)

Get currently selected (read only)

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: selected-text ((obj clog-ace-element))
Generic Function: set-auto-completion (clog-ace-element auto-completion)

Turn auto complete on or off

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: set-auto-completion ((obj clog-ace-element) auto-completion)
Generic Function: tab-size (clog-ace-element)

Tab size

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: tab-size ((obj clog-ace-element))
Generic Function: (setf tab-size) (clog-ace-element)

Tab size

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: (setf tab-size) ((obj clog-ace-element))
Generic Function: theme (clog-ace-element)

The ace color theme. eg. ace/theme/xcode

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: theme ((obj clog-ace-element))
Generic Function: (setf theme) (clog-ace-element)

The ace color theme. eg. ace/theme/xcode

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: (setf theme) ((obj clog-ace-element))

5.1.3 Standalone methods

Method: focus ((obj clog-ace-element))
Package

clog.

Source

clog-ace.lisp.

Method: (setf read-only-p) ((obj clog-ace-element))
Package

clog.

Source

clog-ace.lisp.

Method: read-only-p ((obj clog-ace-element))
Package

clog.

Source

clog-ace.lisp.

Method: set-on-blur ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: set-on-change ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: set-on-copy ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: set-on-cut ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: set-on-focus ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: set-on-paste ((obj clog-ace-element) handler)
Package

clog.

Source

clog-ace.lisp.

Method: (setf text-value) ((obj clog-ace-element))
Package

clog.

Source

clog-ace.lisp.

Method: text-value ((obj clog-ace-element))
Package

clog.

Source

clog-ace.lisp.


5.2 Internals


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

5.2.1 Ordinary functions

Function: on-test-clog-ace (body)
Package

clog-ace.

Source

clog-ace.lisp.

Function: set-ace-event (obj event handler)
Package

clog-ace.

Source

clog-ace.lisp.


5.2.2 Generic functions

Generic Function: js-ace (clog-ace-element)

Access to ace javascript object (private)

Package

clog-ace.

Source

clog-ace.lisp.

Methods
Method: js-ace ((obj clog-ace-element))

Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   (  
A   C   E   F   G   I   J   M   O   R   S   T  
Index Entry  Section

(
(setf mode): Public generic functions
(setf mode): Public generic functions
(setf read-only-p): Public standalone methods
(setf tab-size): Public generic functions
(setf tab-size): Public generic functions
(setf text-value): Public standalone methods
(setf theme): Public generic functions
(setf theme): Public generic functions

A
attach-clog-ace: Public generic functions
attach-clog-ace: Public generic functions

C
clipboard-copy: Public generic functions
clipboard-copy: Public generic functions
clipboard-cut: Public generic functions
clipboard-cut: Public generic functions
clipboard-paste: Public generic functions
clipboard-paste: Public generic functions
create-clog-ace-element: Public generic functions
create-clog-ace-element: Public generic functions

E
execute-command: Public generic functions
execute-command: Public generic functions

F
focus: Public standalone methods
Function, on-test-clog-ace: Private ordinary functions
Function, set-ace-event: Private ordinary functions
Function, set-on-auto-complete: Public ordinary functions
Function, start-test: Public ordinary functions

G
Generic Function, (setf mode): Public generic functions
Generic Function, (setf tab-size): Public generic functions
Generic Function, (setf theme): Public generic functions
Generic Function, attach-clog-ace: Public generic functions
Generic Function, clipboard-copy: Public generic functions
Generic Function, clipboard-cut: Public generic functions
Generic Function, clipboard-paste: Public generic functions
Generic Function, create-clog-ace-element: Public generic functions
Generic Function, execute-command: Public generic functions
Generic Function, get-mode-from-extension: Public generic functions
Generic Function, init-clog-ace: Public generic functions
Generic Function, js-ace: Private generic functions
Generic Function, mode: Public generic functions
Generic Function, move-cursor: Public generic functions
Generic Function, resize: Public generic functions
Generic Function, selected-text: Public generic functions
Generic Function, set-auto-completion: Public generic functions
Generic Function, tab-size: Public generic functions
Generic Function, theme: Public generic functions
get-mode-from-extension: Public generic functions
get-mode-from-extension: Public generic functions
get-mode-from-extension: Public generic functions

I
init-clog-ace: Public generic functions
init-clog-ace: Public generic functions

J
js-ace: Private generic functions
js-ace: Private generic functions

M
Method, (setf mode): Public generic functions
Method, (setf read-only-p): Public standalone methods
Method, (setf tab-size): Public generic functions
Method, (setf text-value): Public standalone methods
Method, (setf theme): Public generic functions
Method, attach-clog-ace: Public generic functions
Method, clipboard-copy: Public generic functions
Method, clipboard-cut: Public generic functions
Method, clipboard-paste: Public generic functions
Method, create-clog-ace-element: Public generic functions
Method, execute-command: Public generic functions
Method, focus: Public standalone methods
Method, get-mode-from-extension: Public generic functions
Method, get-mode-from-extension: Public generic functions
Method, init-clog-ace: Public generic functions
Method, js-ace: Private generic functions
Method, mode: Public generic functions
Method, move-cursor: Public generic functions
Method, read-only-p: Public standalone methods
Method, resize: Public generic functions
Method, selected-text: Public generic functions
Method, set-auto-completion: Public generic functions
Method, set-on-blur: Public standalone methods
Method, set-on-change: Public standalone methods
Method, set-on-copy: Public standalone methods
Method, set-on-cut: Public standalone methods
Method, set-on-focus: Public standalone methods
Method, set-on-paste: Public standalone methods
Method, tab-size: Public generic functions
Method, text-value: Public standalone methods
Method, theme: Public generic functions
mode: Public generic functions
mode: Public generic functions
move-cursor: Public generic functions
move-cursor: Public generic functions

O
on-test-clog-ace: Private ordinary functions

R
read-only-p: Public standalone methods
resize: Public generic functions
resize: Public generic functions

S
selected-text: Public generic functions
selected-text: Public generic functions
set-ace-event: Private ordinary functions
set-auto-completion: Public generic functions
set-auto-completion: Public generic functions
set-on-auto-complete: Public ordinary functions
set-on-blur: Public standalone methods
set-on-change: Public standalone methods
set-on-copy: Public standalone methods
set-on-cut: Public standalone methods
set-on-focus: Public standalone methods
set-on-paste: Public standalone methods
start-test: Public ordinary functions

T
tab-size: Public generic functions
tab-size: Public generic functions
text-value: Public standalone methods
theme: Public generic functions
theme: Public generic functions

Jump to:   (  
A   C   E   F   G   I   J   M   O   R   S   T  

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

A.3 Variables