The clog Reference Manual

This is the clog Reference Manual, version 2.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:39:56 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clog

CLOG - The Common Lisp Omnificent GUI

Author

David Botton <>

License

BSD

Version

2.2

Dependencies
  • clack (system).
  • websocket-driver (system).
  • alexandria (system).
  • hunchentoot (system).
  • cl-ppcre (system).
  • bordeaux-threads (system).
  • parse-float (system).
  • quri (system).
  • lack-middleware-static (system).
  • lack-request (system).
  • lack-util-writer-stream (system).
  • trivial-gray-streams (system).
  • closer-mop (system).
  • mgl-pax (system).
  • cl-template (system).
  • atomics (system).
  • sqlite (system).
  • cl-dbi (system).
  • cl-pass (system).
  • cl-isaac (system).
Source

clog.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 clog/static-files

Source

clog.asd.

Parent Component

clog (system).

Child Component

js/boot.js (file).


3.2 clog/source

Dependency

static-files (module).

Source

clog.asd.

Parent Component

clog (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 clog/clog.asd

Source

clog.asd.

Parent Component

clog (system).

ASDF Systems

clog.


4.1.2 clog/source/asdf-ext.lisp

Source

clog.asd.

Parent Component

source (module).


4.1.3 clog/source/clog-connection.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-connection.

Public Interface
Internals

4.1.4 clog/source/clog-connection-websockets.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.5 clog/source/clog.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog.

Public Interface

4.1.6 clog/source/clog-system.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.7 clog/source/clog-utilities.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

unit-type (type).


4.1.8 clog/source/clog-base.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.9 clog/source/clog-element.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.10 clog/source/clog-jquery.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.11 clog/source/clog-body.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

make-clog-body (function).


4.1.12 clog/source/clog-document.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.13 clog/source/clog-window.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.14 clog/source/clog-location.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

make-clog-location (function).


4.1.15 clog/source/clog-navigator.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

make-clog-navigator (function).


4.1.16 clog/source/clog-style.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

selector-type (type).


4.1.17 clog/source/clog-element-common.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.18 clog/source/clog-form.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.19 clog/source/clog-multimedia.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.20 clog/source/clog-canvas.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.21 clog/source/clog-webgl.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-webgl.

Public Interface
Internals

4.1.22 clog/source/clog-panel.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.23 clog/source/clog-tree.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.24 clog/source/clog-presentations.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.25 clog/source/clog-data.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.26 clog/source/clog-dbi.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface
Internals

4.1.27 clog/source/clog-auth.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-auth.

Public Interface
Internals

4.1.28 clog/source/clog-web.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-web.

Public Interface
Internals

4.1.29 clog/source/clog-web-dbi.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-web-dbi.

Public Interface

4.1.30 clog/source/clog-web-themes.lisp

Source

clog.asd.

Parent Component

source (module).

Public Interface

4.1.31 clog/source/clog-gui.lisp

Source

clog.asd.

Parent Component

source (module).

Packages

clog-gui.

Public Interface
Internals

4.1.32 clog/source/clog-helpers.lisp

Source

clog.asd.

Parent Component

source (module).

Packages
Public Interface

4.2 Static


4.2.1 clog/static-files/js/boot.js

Source

clog.asd.

Parent Component

static-files (module).


5 Packages

Packages are listed by definition order.


5.1 clog-web

CLOG-WEB a web page style abstraction for CLOG

Source

clog-web.lisp.

Use List
  • clog.
  • common-lisp.
  • mgl-pax.
Used By List
Public Interface
Internals

5.2 clog

CLOG - The Common List Omnificent GUI

Source

clog.lisp.

Use List
  • common-lisp.
  • mgl-pax.
  • parse-float.
Used By List
Public Interface
Internals

5.3 clog-user

Source

clog-helpers.lisp.

Use List
Public Interface

*body* (special variable).


5.4 clog-webgl

CLOG-WEBGL bindings to WebGL

Source

clog-webgl.lisp.

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

5.5 clog-tools

Source

clog-helpers.lisp.

Use List

5.6 clog-gui

CLOG-GUI a desktop GUI abstraction for CLOG

Source

clog-gui.lisp.

Use List
  • clog.
  • common-lisp.
  • mgl-pax.
Used By List
Public Interface
Internals

5.7 clog-web-dbi

CLOG-WEB-DBI - dbi based website helpers

Source

clog-web-dbi.lisp.

Use List
Public Interface

5.8 clog-auth

CLOG-AUTH an authenticationa and authorization abstraction for CLOG

Source

clog-auth.lisp.

Use List
  • clog.
  • common-lisp.
  • mgl-pax.
Used By List

clog-web-dbi.

Public Interface
Internals

5.9 clog-connection

The Common List Omnificent GUI - Connection

Source

clog-connection.lisp.

Use List
  • common-lisp.
  • mgl-pax.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *body*

clog-repl access to body

Package

clog-user.

Source

clog-helpers.lisp.

Special Variable: *break-on-error*

Allow invoking debugger (default t)

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *browser-gc-on-ping*

Run a browser-gc on every ping (default nil)

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *clog-debug*

Set a debug hook that is called for every event with (event data) that must be (funcall event data).

Package

clog.

Source

clog-system.lisp.

Special Variable: *clog-debug-instance*

Default location to open debugger windows

Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *clog-popup-path*

Default URL for popup windows

Package

clog.

Source

clog-window.lisp.

Special Variable: *clog-port*

Port this instance of clog was started on

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *clog-running*

CLOG initialized and running.

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *default-border-class*

Window frame border

Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *default-icon*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *default-title-class*

Window title bar class

Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *disable-clog-debugging*

When true turns off debug hooks (default nil)

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *menu-bar-class*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *menu-bar-drop-down-class*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *menu-full-screen-item*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *menu-icon-image-class*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *menu-item-class*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *menu-window-select-class*
Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *mysql-timestamp*

Function used by mysql to retrieve the time from the epoch

Package

clog.

Source

clog-data.lisp.

Special Variable: *postgresql-timestamp*

Function used by postgresql to retrieve the time from the epoch

Package

clog.

Source

clog-data.lisp.

Special Variable: *probe*

Result value of a probe

Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *reconnect-delay*

Time to delay in seconds for possible reconnect (default 7)

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *sqlite-timestamp*

Function used by sqlite to retrieve the time from the epoch

Package

clog.

Source

clog-data.lisp.

Special Variable: *static-root*

Contains the static-root setting after initialization.

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: *store-new-objects*

Dynamic variable that when true every create-* or attach-* will also create a connection-data-item keyed by the html-id. Any object stored will not be garbage collected on the browser side or lisp side.

Package

clog.

Source

clog-element.lisp.

Special Variable: *top-bar-height*

Overlap on new windows created with top set as nil

Package

clog-gui.

Source

clog-gui.lisp.

Special Variable: *verbose-output*

Verbose server output (default nil)

Package

clog-connection.

Source

clog-connection.lisp.

Special Variable: @clog-auth
Package

clog.

Source

clog-auth.lisp.

Special Variable: @clog-body
Package

clog.

Source

clog.lisp.

Special Variable: @clog-canvas
Package

clog.

Source

clog.lisp.

Special Variable: @clog-data
Package

clog.

Source

clog.lisp.

Special Variable: @clog-dbi
Package

clog.

Source

clog.lisp.

Special Variable: @clog-document
Package

clog.

Source

clog.lisp.

Special Variable: @clog-element
Package

clog.

Source

clog.lisp.

Special Variable: @clog-element-common
Package

clog.

Source

clog.lisp.

Special Variable: @clog-form
Package

clog.

Source

clog.lisp.

Special Variable: @clog-gui
Package

clog.

Source

clog-gui.lisp.

Special Variable: @clog-helpers
Package

clog.

Source

clog.lisp.

Special Variable: @clog-jquery
Package

clog.

Source

clog.lisp.

Special Variable: @clog-location
Package

clog.

Source

clog.lisp.

Special Variable: @clog-manual
Package

clog.

Source

clog.lisp.

Special Variable: @clog-multimedia
Package

clog.

Source

clog.lisp.

Special Variable: @clog-navigator
Package

clog.

Source

clog.lisp.

Special Variable: @clog-obj
Package

clog.

Source

clog.lisp.

Special Variable: @clog-panels
Package

clog.

Source

clog.lisp.

Special Variable: @clog-presentations
Package

clog.

Source

clog.lisp.

Special Variable: @clog-style-block
Package

clog.

Source

clog.lisp.

Special Variable: @clog-system
Package

clog.

Source

clog.lisp.

Special Variable: @clog-tree
Package

clog.

Source

clog.lisp.

Special Variable: @clog-utilities
Package

clog.

Source

clog.lisp.

Special Variable: @clog-web
Package

clog.

Source

clog-web.lisp.

Special Variable: @clog-web-dbi
Package

clog.

Source

clog-web-dbi.lisp.

Special Variable: @clog-web-themes
Package

clog.

Source

clog-web-themes.lisp.

Special Variable: @clog-webgl
Package

clog.

Source

clog-webgl.lisp.

Special Variable: @clog-window
Package

clog.

Source

clog.lisp.


6.1.2 Macros

Macro: clog-probe (symbol &key clog-body title time-out top left width height auto-probe save-value modal)

Pause thread of execution for time-out numnber of seconds or nil to not block execution, display symbol’s value, value is changed if OK pressed at the moment pressed. When time-out is nil, :q quits the probe and cancel repeats the probe with out changing value. When time-out is nil modal is always nil. If auto-probe is set, modal and time-out is set to nil and the probe is run again in auto-probe seconds. If not tile is set, the symbol is used for title. If save-value is true clog-gui:*probe* is set to value of symbol before any change is made by dialog.

Package

clog-gui.

Source

clog-gui.lisp.

Link changes to (PROPERTY CLOG-OBJ) to any lisp PLACE on SET-EVENT with TRANSFORM

Package

clog.

Source

clog-presentations.lisp.

Link changes to (text CLOG-OBJ) to (ACESSOR OBJECT) on SET-EVENT with TRANSFORM

Package

clog.

Source

clog-presentations.lisp.

Link changes to (value CLOG-OBJ) to (ACESSOR OBJECT) on SET-EVENT with TRANSFORM

Package

clog.

Source

clog-presentations.lisp.

Biderectional link slot (ACCESSOR OBJECT) <> clog-element (CLOG-OBJ)

Package

clog.

Source

clog-presentations.lisp.

Biderectional link slot (ACCESSOR OBJECT) <> clog-form-element (CLOG-OBJ)

Package

clog.

Source

clog-presentations.lisp.

Link changes to lisp (ACCESSOR OBJECT) to (text CLOG-OBJ). Only one element can be bound at a time to a lisp object.

Package

clog.

Source

clog-presentations.lisp.

Link changes to lisp (ACCESSOR OBJECT) to (value CLOG-OBJ). Only one element can be bound at a time to a lisp object.

Package

clog.

Source

clog-presentations.lisp.

Link changes to lisp (ACCESSOR OBJECT) to PLACE. Only one PLACE can be bound at a time to a lisp object.

Package

clog.

Source

clog-presentations.lisp.

Macro: with-clog-create (obj spec &body body)

To use the macro you remove the create- from the create functions. The clog-obj passed as the first parameter of the macro is passed as the parent obj to the declared object, after that nested levels of decleraton are used as the parent clog-obj. To bind a variable to any created clog object using :bind var. See tutorial 33 and 22 for examples. All create- symbols must be in or used by package.

Package

clog.

Source

clog-utilities.lisp.

Macro: with-clog-debugger ((clog-obj &key title standard-output standard-input) &body body)

body uses a clog-gui based debugger instead of the console

Package

clog-gui.

Source

clog-gui.lisp.

Macro: with-connection-cache ((clog-obj) &body body)

Caches writes to the connection-id of CLOG-OBJ until flushed with FLUSH-CONNECTION-CACHE or a query is made.

Package

clog.

Source

clog-base.lisp.

Macro: with-sync-event ((clog-obj) &body body)

Place at start of event to serialize access to the event. All events in an application share per connection the same queue of serialized events.

Package

clog.

Source

clog-base.lisp.


6.1.3 Ordinary functions

Function: add-authorization (role-list action-list)

Add to each role in ROLE-LIST every action in ACTION-LIST

Package

clog-auth.

Source

clog-auth.lisp.

Function: add-plugin-path (regex static-path)

When a path to the webserver matches REGEX resolve the static file using STATIC-PATH

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: adjust-for-base-url (base-url url-path)

If url-path is not on base-url return base-url otherwise url-path

Package

clog-web.

Source

clog-web.lisp.

Function: alert-box (connection-id message)

Create an alert box on CONNECTION-ID with MESSAGE

Package

clog-connection.

Source

clog-connection.lisp.

Function: alert-dialog (obj content &key modal title time-out left top width height client-movement html-id)

Create an alert dialog box with CONTENT centered. If time-out alert-dialog blocks till time-out reached or OK clicked.

Package

clog-gui.

Source

clog-gui.lisp.

Function: alert-toast (obj title content &key color-class time-out place-top html-id)

Create an alert toast with option :TIME-OUT. If place-top is t then alert is placed in DOM at top of html body instead of bottom of html body. Note, when time-out alert-toast blocks and the toast is displayed for time-out or until user closes the toast.

Package

clog-gui.

Source

clog-gui.lisp.

Function: base-url-p (base-url url-path)

True if url-path is based on base-url

Package

clog-web.

Source

clog-web.lisp.

Function: base-url-split (base-url url-path)

Split path by / adjusting for base-url

Package

clog-web.

Source

clog-web.lisp.

Function: cclose (connection-id)

Close connection to CONNECTION-ID. The boot file may try to reestablish connectivity.

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: change-password (body sql-connection &key title next-step)

Setup a change password form and handle change of password

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: clog-break (&key clog-body run modal)

Stop execution, funcall RUN with CLOG-BODY if set, if run returns :continue, the execution continues. If CLOG-BODY not set use *clog-debug-instance*. Then confirm continue execution on current thread or (break).

Package

clog-gui.

Source

clog-gui.lisp.

Function: clog-gui-initialize (clog-body &key body-left-offset body-right-offset use-clog-debugger standard-output parent-desktop-obj w3-css-url jquery-ui-css jquery-ui)

Initializes clog-gui and installs a clog-gui object on the connection body. If W3-CSS-URL has not been loaded before it is installed unless set to nil. clog-gui uses jQueryUI and its default css file to provide client side movement when needed, if client side movement is not used it is possible
to pass nil to the initilization function for both the jquery-ui-js and jquery-ui-css options and there is no need to deliver the jQueryUI it with your application. BODY-LEFT-OFFSET and BODY-RIGHT-OFFSET limit width on maximize. parent-desktop-obj is used if this window is a popup or otherwise a
slave of another clog-gui page.
If use-clog-debugger then a graphical debugger is set for all events. If standard-output is set *standard-output* for every event is redirected
to it.
NOTE: use-clog-debugger should not be set for security issues
on non-secure environments.

Package

clog-gui.

Source

clog-gui.lisp.

Function: clog-install-dir ()

Return the directory CLOG was installed in.

Package

clog.

Source

clog-helpers.lisp.

Function: clog-repl (&key clog-gui-initialize clog-web-initialize use-clog-debugger boot-file port)

Set a path /repl that opens a blank page and sets the global clog-user:*body* to last window openned to /repl. Debug mode is
set (logging to browser console) in the default debug.html boot-file. clog-web and clog-gui are initialized and if use-clog-debugger it set to true it is initialized and this repl window used as default clog debug display and debugger display for clog events.

Package

clog.

Source

clog-helpers.lisp.

Function: clog-web-alert (obj title content &key color-class time-out place-top html-id)

Create an alert toast with option :TIME-OUT. If place-top is t then alert is placed in DOM at top of OBJ instead of bottom of OBJ.

Package

clog-web.

Source

clog-web.lisp.

Function: clog-web-content (sql-connection &key page table base-url follow-url-page comment-table on-content on-comment on-new on-edit on-delete can-admin can-comment can-show-comments can-edit content-order-by comment-order-by sql-timestamp-func)

This is used to create PAGE based content. If more than one entry in TABLE is keyed for same PAGE, if theme is configured for it, displays a table of contents, followed by each content record, followed by comments for the whole page.

Creates content for CLOG-WEB:CREATE-WEB-PAGE based on TABLE where key=PAGE (or if FOLLOW-URL-PAGE is true PAGE is default page and if no second on path otherwise page is the second on path, first must be base-url). e.g.

(defun on-main (body)
(init-site body)
(create-web-page body
:index ‘(:menu ,*menu*
:content ,(clog-web-content *sql-connection* :comment-table "content"))))

ON-CONTENT, ON-COMMENT are called with (obj value) before
display of value the return value is used. ON-NEW, ON-EDIT are called with (obj value) to allow filter of value before storage, if nil is return aborted. ON-DELETE called with (obj page comment-id) if returns nil aborted. If comment-table is nil no comments are shown. User must authorize on action set by CAN-COMMENT, CAN-ADMIN, CAN-SHOW-COMMENTS and if CAN-EDIT unless they are set to nil.

Package

clog-web.

Source

clog-web-dbi.lisp.

Function: clog-web-form (obj content fields on-input &key modal ok-text cancel-text border-class text-class color-class html-id)

Create a form with CONTENT followed by FIELDS.
FIELDS is a list of lists each list has:

(1) Field description - Used for label
(2) Field name - Used for (name attribute)
(3) Field type - Optional (defaults to :text)
(4) Field type options - Optional

Special field types

Field Type Field Type Options
============= ==================
:checkbox t if checked
:radiobox a-list ((label name)) a third value can be added "checked" :select a-list ((label name)) a third value can be added "selected" :text value
(any text input types also work :email, :tel, etc.
see FORM-ELEMENT-TYPE)

Calls on-input after OK or Cancel with an a-list of field name to value if confirmed or nil if canceled. CANCEL-TEXT is only displayed if modal is t

If clog-web-site is being used the class class setting will be replaced with the value if set in the theme settings.

Package

clog-web.

Source

clog-web.lisp.

Function: clog-web-initialize (clog-body &key w3-css-url)

Initializes clog-web and installs a clog-web object on connection. If W3-CSS-URL has not been loaded before is installed unless is nil.

Package

clog-web.

Source

clog-web.lisp.

Function: clog-web-meta (description)

Returns a boot-function for use with CLOG:INITIALIZE to add meta and no-script body information for search engines with DESCRIPTION.

Package

clog-web.

Source

clog-web.lisp.

Function: clog-web-routes-from-menu (menu)

Use a menu to setup a route for each menu item that has a third element.

Package

clog-web.

Source

clog-web.lisp.

Function: compiled-boot-html (path content)

Returns a compiled version version of boot.html. The compiled boot.html uses the jQuery CDN instead of the static js files.

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: confirm-dialog (obj content on-input &key modal title ok-text cancel-text time-out left top width height client-movement html-id)

Create a confirmation dialog box with CONTENT centered. Calls on-input with t if confirmed or nil if canceled.

Package

clog-gui.

Source

clog-gui.lisp.

Function: create-base-tables (sql-connection &key sql-timestamp-func)

Create default tables

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: create-panel-box-layout (clog-obj &key top-height left-width bottom-height right-width units html-id)

Create a five panel app layout that fills entire contents of CLOG-OBJ. HTML-ID if set is the base and top,left,right,center, bottom are added e.g. if :HTML-ID "myid" then the HTML-ID for center will be: myid-center

Package

clog.

Source

clog-panel.lisp.

Function: data-load-plist (obj plist &key row-id-name upcase-key)

Load a PLIST in to OBJ where key of plist is the name of slot on OBJ and the value is the data to load. If slot contains a CLOG-ELEMENT TEXT-VALUE is set, if not the slot is set to the value. If key is not the name of a slot it is ignored. The key is coverted to a string and upper cased before attempting to match it to a slot if :UPCASE-KEY t (default). If :ROW-ID-NAME is set returns that fields value.

Package

clog.

Source

clog-data.lisp.

Function: data-write-list (obj slot-name-list &key upcase-key)

Returns a list, one value for each slot name in SLOT-NAME-LIST. If a slot contains a CLOG-ELEMENT then TEXT-VALUE is used to retrieve the value. Slot names may be symbols, keywords or text (and will be upcased before looking up symbol if :UPCASE-KEY t). All slot-names must be bound.

Package

clog.

Source

clog-data.lisp.

Function: data-write-plist (obj slot-name-list &key upcase-key keys-as-keywords)

Returns a plist, one member for each slot name in SLOT-NAME-LIST, the key is the slot name. If a slot contains a CLOG-ELEMENT then TEXT-VALUE is used to retrieve the value otherwise it is the slot-value. Slot names may be symbols, keywords, or text (and will be upcased before looking up symbol if :UPCASE-KEY t). If a slot-name is a cons, the first will be used as the key in the plist and the second will be the actual slot-name. All slot-names must be bound. If slot-name does not exist it is left out of returned plist. If :KEYS-AS-KEYWORDS t (default) then the keys will be symbols in the keyword package.

Package

clog.

Source

clog-data.lisp.

Function: debug-mode (obj)

Turn on browser console debugging for OBJ’s connection.

Package

clog.

Source

clog-system.lisp.

Function: debug-mode (connection-id)

Turn on javascript debug mode in the boot.js file

Package

clog-connection.

Source

clog-connection.lisp.

Function: default-theme (body page properties)

The default theme for clog-web-site.
Settings available:
:color-class - w3 color class for menu bars and buttons (def: w3-black) :border-class - w3 border (def: "")
:text-class - w3 text color class (def: "")
:signup-link - link to signup (def: /signup)
:login-link - link to login (def: /login)
:username-link - link when clicking on username (def: /logout)
Page properties:
:menu - (("Menu Name" (("Menu Item" "link")))) (def: nil)
:content - (def: "")

Package

clog-web.

Source

clog-web-themes.lisp.

Function: delete-connection-data (connection-id)

Delete CONNECTION-ID’s data. (private)

Package

clog-connection.

Source

clog-connection.lisp.

Function: enable-clog-popup (&key path boot-file)

Enable handling of clog enabled popups

Package

clog.

Source

clog-window.lisp.

Function: escape-for-html (value)

Returns a string where < and > are replaced with html entities. This is particularly useful as #<> is used for unprintable objects in Lisp. Value is converted with format to a string first.

Package

clog.

Source

clog-utilities.lisp.

Function: escape-string (str &key no-nil html)

Escape STR for sending to browser script. If no-nil is t (default is nil) if str is NIL returns empty string otherwise returns nil. If html is t the quotes are changed to html entities and n and r are eliminated. Escape string is used for wire readiness i.e. ability to be evaluated client side and not for security purposes or html escapes.

Package

clog-connection.

Source

clog-connection.lisp.

Function: execute (connection-id message)

Execute SCRIPT on CONNECTION-ID, disregard return value.

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: flush-connection-cache (clog-obj)

Flush connection cache if on CLOG-OBJ is located on.

Package

clog.

Source

clog-base.lisp.

Function: form-data-item (form-data item)

Return value for ITEM from FROM-DATA a-list

Package

clog.

Source

clog-form.lisp.

Function: form-dialog (obj content fields on-input &key modal title ok-text cancel-text time-out left top width height size rows client-movement html-id)

Create a form dialog box with CONTENT followed by FIELDS.
FIELDS is a list of lists each list has:

(1) Field description - Used for label
(2) Field name - Used for (name attribute)
(3) Field type - Optional (defaults to :text)
(4) Field type options - Optional

Special field types

Field Type Field Type Options
============= ==================
:filename default dir – NOTE: This is _server_ side!
:checkbox t if checked
:radiobox a-list ((label name)) a third value can be added "checked" :select a-list ((label name)) a third value can be added "selected" :textarea value
:text value
(any text input types also work :email, :tel, etc.
see FORM-ELEMENT-TYPE)

The size of any texarea field is controled by the size and rows parameters

Calls on-input after OK or Cancel with an a-list of field name to value if confirmed or nil if canceled. If time-out is set the result of on-input returned after either ok or cancel or time elapses.

Package

clog-gui.

Source

clog-gui.lisp.

Function: form-result (result key)

Return the value for KEY from RESULT

Package

clog-web.

Source

clog-web.lisp.

Function: generate-id ()

Generate unique ids for use in scripts.

Package

clog-connection.

Source

clog-connection.lisp.

Function: get-authentication-token (body &key auth-path)

Retrieve the stored authentication token

Package

clog-auth.

Source

clog-auth.lisp.

Function: get-connection-data (connection-id)

Return the connecton data associated with the CONNECTION-ID a hash test: #’equal.

Package

clog-connection.

Source

clog-connection.lisp.

Function: get-profile (obj sql-connection)

Retrieve profile based on current authentication token. If there is no token or fails to match as user returns nil

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: get-property (properties key default)

Return the property for KEY from the p-list PROPERTIES or DEFAULT

Package

clog-web.

Source

clog-web-themes.lisp.

Function: get-setting (website key default)

Return the setting for KEY or DEFAULT from website settings

Package

clog-web.

Source

clog-web-themes.lisp.

Function: hsl (hue saturation lightness)

Return HSL string, hue 0-360, saturation and lightness 0%-100%

Package

clog.

Source

clog-utilities.lisp.

Function: hsla (hue saturation lightness alpha)

Return HSLA string, hue 0-360, saturation and lightness 0%-100%, alpha 0.0 - 1.0

Package

clog.

Source

clog-utilities.lisp.

Function: initialize (on-new-window-handler &rest rest &key host port server lack-middleware-list extended-routing long-poll-first boot-file boot-function static-boot-html static-boot-js static-root ssl ssl-key-file ssl-cert-file)

Inititalize CLOG on a socket using HOST and PORT to serve BOOT-FILE as the default route to establish web-socket connections and static files located at STATIC-ROOT. The webserver used with CLACK can be chosen with :SERVER and middlewares prepended with :LACK-MIDDLEWARE-LIST, NOT supporting LACK.BUILDER DSL. If EXTENDED-ROUTING is t routes will match even if extend with additional / and additional paths. If LONG-POLLING-FIRST is t then long polling continues until the on-new-window-handler ends, if LONG-POLLING-FIRST is a number continues long polling until that number of queries to browser. LONG-POLLING-FIRST is used in webserver applications to enable crawling of your website. If CLOG was already initialized and not shut down, this function does the same as set-on-new-window (does not change the static-root). If ON-NEW-WINDOW-HANDLER is nil no handler is set and none is removed. STATIC-ROOT by default is the "directory CLOG is installed in ./static-files" If the variable clog:*overide-static-root* is set STATIC-ROOT will be ignored. If BOOT-FILE is nil no default boot-file will be set for root path, i.e. /. If static-boot-js is t then boot.js is served from the file /js/boot.js instead of the compiled version. If static-boot-html is t if boot.html is not present will use compiled version otherwise if set to nil (default) if a boot file not found returns returns a blank page, if it is set to :error will signal an error and if set to a string will display the string. boot-function if set is called with the url and the contents of boot-file and its return value replaces the contents sent to the brower, this allows adding content for search engine optimization, see tutorial 12 for an example. If port is nil or 0 a random available port number is chosen.

Package

clog.

Source

clog-system.lisp.

Function: initialize (on-connect-handler &key host port server lack-middleware-list extended-routing long-poll-first boot-file boot-function static-boot-html static-boot-js static-root ssl ssl-key-file ssl-cert-file)

Initialize CLOG on a socket using HOST and PORT to serve BOOT-FILE as the
default route for ’/’ to establish web-socket connections and static files
located at STATIC-ROOT. The webserver used with CLACK can be chosen with
:SERVER and middlewares prepended with :LACK-MIDDLEWARE-LIST,
NOT supporting LACK.BUILDER DSL.
If LONG-POLLING-FIRST is t, the output is sent as HTML instead of
websocket commands until the end of the on-new-window-handler, if LONG-POLLING-FIRST is a number will keep long polling till that number of
queries to browser. LONG-POLLING-FIRST is used in webserver applications to
enable crawling of your website. If BOOT-FILE is nil no initial clog-path’s will
be setup, use clog-path to add. The on-connect-handler needs to indentify the
path by querying the browser. See PATH-NAME (in CLOG-LOCATION). If
EXTENDED-ROUTING is t routes will match even if extend with additional / and additional paths. If static-boot-js is nil then boot.js is served from the file /js/boot.js instead of the compiled version. If static-boot-html is t if
boot.html is not present will use compiled version otherwise if set to nil (default) if a boot file not found returns returns a blank page, if it is set to :error will signal an error and if set to a string will display the string. boot-function if set is called with the url and the contents of boot-file and its return value replaces
the contents sent to the brower.

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: input-dialog (obj content on-input &key modal time-out title size rows placeholder-value default-value is-password spell-check left top width height client-movement html-id)

Create an input dialog box with CONTENT centered and an input box. Calls on-input with input box contents or nil if canceled. If time-out block time-out seconds for responce or cancels dialog box then returns result of on-input.

Package

clog-gui.

Source

clog-gui.lisp.

Function: is-authorized-p (role-list action)

Given ROLE-LIST is action authorized. If action is nil returns t.

Package

clog-auth.

Source

clog-auth.lisp.

Function: is-running-p ()
Package

clog.

Source

clog-system.lisp.

Function: js-on-p (value)

Return true if VALUE equalp the string on

Package

clog.

Source

clog-utilities.lisp.

Function: js-to-float (value &key default)

Returns two values first as a float and second the original value

Package

clog.

Source

clog-utilities.lisp.

Function: js-to-integer (value &key default)

Returns two values first as an integer and second the original value

Package

clog.

Source

clog-utilities.lisp.

Function: js-true-p (value)

Return true if VALUE equalp the string true

Package

clog.

Source

clog-utilities.lisp.

Function: lf-to-br (str)

Change line feeds to <br>.

Package

clog.

Source

clog-utilities.lisp.

Function: load-content (sql-connection table key-value &key key-col where order-by)

Returns list of records found in TABLE where KEY-COL = KEY-VALUE and optional WHERE and ORDER-BY sql.

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: load-demo (num)

Load demo NUM - use (clog:run-demo)

Package

clog.

Source

clog-helpers.lisp.

Function: load-tutorial (num)

Load tutorial NUM - use (clog:run-tutorial)

Package

clog.

Source

clog-helpers.lisp.

Function: login (body sql-connection username password)

Login and set current authentication token, it does not remove token if one is present and login fails.

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: logout (body)

Logout and remove current authenitcation token

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: make-hash-table* (&rest args)

Use native concurrent hash tables

Package

clog-connection.

Source

clog-connection.lisp.

Function: make-token ()

Create a unique token used to associate a browser with a user

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: new-line (connection-id)

Write a new line raw to document object of CONNECTION-ID with a <br />.

Package

clog-connection.

Source

clog-connection.lisp.

Function: one-of-dialog (obj intro choices &key title prompt)

Prompt a dialog box with TITLE and INTRO using list of CHOICES and PROMPT

Package

clog-gui.

Source

clog-gui.lisp.

Function: open-browser (&key url)

Launch on os a web browser on local machine to URL. See OPEN-WINDOW for openning windows on remote machines.

Package

clog.

Source

clog-system.lisp.

Function: open-file-with-os (path)

Open PATH using OS

Package

clog.

Source

clog-system.lisp.

Function: open-manual ()

Launches a browser with CLOG manual.

Package

clog.

Source

clog-helpers.lisp.

Function: p-on-js (value)

Return "on" if VALUE t or return "off"

Package

clog.

Source

clog-utilities.lisp.

Function: p-true-js (value)

Return "true" if VALUE t

Package

clog.

Source

clog-utilities.lisp.

Function: prompt-dialog (obj callback &key title completion validation presentation initial-value modal time-out left top width height maximize client-movement keep-on-top html-id)

Create a prompt dialog box with a selection of items generated by the provided COMPLETION function.

COMPLETION is a function that takes the current string and returns a list of options.

VALIDATION is a predicate that you can specify to prevent the user from entering a malformed text input.

PRESENTATION is used if COMPLETION yields something other than strings.

Pressing <Tab> will replace the input field with the top completion, as you might expect in an IDE. Clicking an item will also put it in the input field.

Pressing <Escape> will cancel the prompt.

Package

clog-gui.

Source

clog-gui.lisp.

Function: put (connection-id text)

Write TEXT to document object of CONNECTION-ID with out new line.

Package

clog-connection.

Source

clog-connection.lisp.

Function: put-line (connection-id text)

Write TEXT to document object of CONNECTION-ID with new line and HTML <br />.

Package

clog-connection.

Source

clog-connection.lisp.

Function: query (connection-id script &key default-answer)

Execute SCRIPT on CONNECTION-ID, return value. If times out answer DEFAULT-ANSWER.

Package

clog-connection.

Source

clog-connection-websockets.lisp.

Function: random-hex-string ()

Generate cryptographic grade random ids for use in connections.

Package

clog-connection.

Source

clog-connection.lisp.

Function: random-port (&key host)

Return a random open port on host

Package

clog-connection.

Source

clog-connection.lisp.

Function: remove-authentication-token (body)
Package

clog-auth.

Source

clog-auth.lisp.

Function: reset-password (sql-connection username &key new-password)

Reset USERNAME’s password to :NEW-PASSWORD

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: rgb (red green blue)

Return RGB string, red green and blue may be 0-255

Package

clog.

Source

clog-utilities.lisp.

Function: rgb-to-hex (rgb)

Return hex #rrggbb from rgb(red,green,blue)

Package

clog.

Source

clog-utilities.lisp.

Function: rgba (red green blue alpha)

Return RGBA string, red green and blue may be 0-255, alpha 0.0 - 1.0

Package

clog.

Source

clog-utilities.lisp.

Function: run-demo (num)

Run demo NUM

Package

clog.

Source

clog-helpers.lisp.

Function: run-tutorial (num)

Run tutorial NUM

Package

clog.

Source

clog-helpers.lisp.

Function: save-body-to-file (file-name &key body if-exists if-does-not-exist external-format)

Save the current html of BODY in the current state to FILE-NAME

Package

clog.

Source

clog-helpers.lisp.

Function: server-file-dialog (obj title initial-dir on-file-name &key modal time-out left top width height maximize initial-filename client-movement html-id)

Create a local file dialog box called TITLE using INITIAL-DIR on server machine, upon close ON-FILE-NAME called with filename or nil if failure. If time-out return result of on-file-name, cancels dialog if time runs out.

Package

clog-gui.

Source

clog-gui.lisp.

Function: set-clog-path (path boot-file)

Associate URL path to BOOT-FILE

Package

clog-connection.

Source

clog-connection.lisp.

Function: set-html-on-close (connection-id html)

Set the client side variable clog[’html_on_close’] to replace the browser contents in case of connection loss.

Package

clog-connection.

Source

clog-connection.lisp.

Function: set-maximum-page-width-in-pixels (clog-body width)

The default width is 980 pixels.

Package

clog-web.

Source

clog-web.lisp.

Function: set-on-authentication-change (body handler)
Package

clog-auth.

Source

clog-auth.lisp.

Function: set-on-connect (on-connect-handler)

Change the ON-CONNECTION-HANDLER set during Initialize.

Package

clog-connection.

Source

clog-connection.lisp.

Function: set-on-new-window (on-new-window-handler &key path boot-file)

Set or change the ON-NEW-WINDOW-HANDLER for PATH using
BOOT_FILE. Paths should always begin with a forward slash ’/’. If PATH is set to :default any path without another route and there is no static file matching the requested path ON-NEW-WINDOW-HANDLER and BOOT-FILE will be used. If BOOT-FILE is nil path is removed.

Package

clog.

Source

clog-system.lisp.

Function: shutdown ()

Shutdown CLOG.

Package

clog.

Source

clog-system.lisp.

Function: shutdown (connection-id)

Shutdown connection to CONNECTION-ID. The boot file may not try to reistablish connectivity.

Package

clog-connection.

Source

clog-connection.lisp.

Function: shutdown-clog ()

Shutdown CLOG.

Package

clog-connection.

Source

clog-connection.lisp.

Function: sign-up (body sql-connection &key title next-step)

Setup a sign-up form and process a new sign-up

Package

clog-web-dbi.

Source

clog-web-dbi.lisp.

Function: sql-field-list (field-list &key quote-all for-insert)

Given list of fields returns a string for use in a SQL select and insert field lists. Use a cons (realname asname) to rename fields for selects, if :FOR-INSERT t then the realname is used. Symbols are stringified first. If :QUOTE-ALL t then all fields are in quotes.

Package

clog.

Source

clog-data.lisp.

Function: sql-insert (table field-list value-list)

Build basic sql insert statement

Package

clog.

Source

clog-data.lisp.

Function: sql-insert* (table plist)

Build basic sql insert statement using a plist

Package

clog.

Source

clog-data.lisp.

Function: sql-quote (value)

Returns value single quoted if string (single quote quoted by doubling) unless is the single character ’?’. If value is a list the car is returned unquoted

Package

clog.

Source

clog-data.lisp.

Function: sql-select (table field-list &key where order-by limit)

Build basic sql select statement

Package

clog.

Source

clog-data.lisp.

Function: sql-update (table plist where)

Build basic sql update statement

Package

clog.

Source

clog-data.lisp.

Function: sql-update-list (plist)

Given plist of field names and values each passed to SQL-QUOTE and returns a string for use in a SQL update. if the ’key’ is a cons the first ’key’ used.

Package

clog.

Source

clog-data.lisp.

Function: sql-value-list (value-list)

Given list of values each passed to SQL-QUOTE returns a string for use in a SQL insert value list.

Package

clog.

Source

clog-data.lisp.

Function: store-authentication-token (body token)
Package

clog-auth.

Source

clog-auth.lisp.

Function: unit (unit-type value)

produce a string from numeric value with UNIT-TYPE appended.

Package

clog.

Source

clog-utilities.lisp.

Function: unit* (unit-type value)

Returns value and if no unit was specified on value unit added unless value is empty string or nil.

Package

clog.

Source

clog-utilities.lisp.

Function: validp (connection-id)

Check if CONNECTION-ID is valid.

Package

clog-connection.

Source

clog-connection.lisp.

Function: window-valid-p (obj)

Returns t if is a valid clog-gui-window. An invalid state
can occur when a popup slave desktop is closed by the OS or the window has been previously closed. If the obj exists in the internal hash of windows it is removed.

Package

clog-gui.

Source

clog-gui.lisp.


6.1.4 Generic functions

Generic Function: access-key (clog-element)

Get/Setf access-key. Used for hot key access to element. special key + Access_Key

The special key per browser and platform is:

Browser Windows Linux Mac —————– ——- —– — Internet Explorer Alt N/A N/A Chrome Alt Alt Control|Alt Firefox Alt|Shift Alt|Shift Control|Alt Safari Alt N/A Control|Alt Opera 15+ Alt Alt Alt

Package

clog.

Source

clog-element.lisp.

Methods
Method: access-key ((obj clog-element))
Generic Function: (setf access-key) (clog-element)

Set access-key VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf access-key) ((obj clog-element))
Generic Function: active-attribute (clog-webgl-program index)

Query about unknown attributes

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: active-attribute ((obj clog-webgl-program) index)
Generic Function: active-texture (clog-webgl glenum-texture)

Sets the active textcture in gl context based on :TEXTUREI where I is the texture number.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: active-texture ((obj clog-webgl) glenum-texture)
Generic Function: active-uniform (clog-webgl-program index)

Query about unknown uniforms

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: active-uniform ((obj clog-webgl-program) index)
Generic Function: actual-bounding-box-ascent (clog-text-metrics)

Actual bounding box ascent

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: actual-bounding-box-ascent ((obj clog-text-metrics))
Generic Function: actual-bounding-box-descent (clog-text-metrics)

Actual bounding box descent

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: actual-bounding-box-descent ((obj clog-text-metrics))
Generic Function: actual-bounding-box-left (clog-text-metrics)

Actual bounding box left

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: actual-bounding-box-left ((obj clog-text-metrics))
Generic Function: actual-bounding-box-right (clog-text-metrics)

Actual bounding box right

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: actual-bounding-box-right ((obj clog-text-metrics))
Generic Function: add-card-look (clog-element)

Change clog-element to use 2px card look

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: add-card-look ((obj clog-element))
Generic Function: add-class (clog-element css-class-name)

add-class.

Package

clog.

Source

clog-element.lisp.

Methods
Method: add-class ((obj clog-element) css-class-name)
Generic Function: add-color-stop (clog-canvas-gradient offset color)

Add a color stop

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: add-color-stop ((obj clog-canvas-gradient) offset color)
Generic Function: add-hard-card-look (clog-element)

Change clog-element to use 4px card look

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: add-hard-card-look ((obj clog-element))
Generic Function: add-option (clog-data-list value)

Add option VALUE to data-list.

Package

clog.

Source

clog-form.lisp.

Methods
Method: add-option ((obj clog-data-list) value)
Generic Function: add-options (clog-data-list data-list)

Add option VALUE to data-list.

Package

clog.

Source

clog-form.lisp.

Methods
Method: add-options ((obj clog-data-list) data-list)
Generic Function: add-select-optgroup (clog-select content)

Add option VALUE to select.

Package

clog.

Source

clog-form.lisp.

Methods
Method: add-select-optgroup ((obj clog-select) content)
Generic Function: add-select-option (clog-select value content &key selected disabled)

Add option VALUE to select. Returns the option element

Package

clog.

Source

clog-form.lisp.

Methods
Method: add-select-option ((obj clog-select) value content &key selected disabled)
Generic Function: add-select-options (clog-select content)

Add group of options to select.

Package

clog.

Source

clog-form.lisp.

Methods
Method: add-select-options ((obj clog-select) content)
Generic Function: add-style (clog-style-block selector-type selector style-alist)

Add to style-block an alist of css styles to affect selector. For example:
(add-style :element "a" ’(("text-decoration" :none)))

Package

clog.

Source

clog-style.lisp.

Methods
Method: add-style ((obj clog-style-block) selector-type selector style-alist)
Generic Function: advisory-title (clog-element)

Get/Setf advisory title of Element, usually
used for body and image maps but creates in forms and many elements a tool tip.

Package

clog.

Source

clog-element.lisp.

Methods
Method: advisory-title ((obj clog-element))
Generic Function: (setf advisory-title) (clog-element)

Set advisory-title VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf advisory-title) ((obj clog-element))
Generic Function: alert (clog-window message)

Launch an alert box. Note that as long as not dismissed events and messages may not be trasmitted on most browsers.

Package

clog.

Source

clog-window.lisp.

Methods
Method: alert ((obj clog-window) message)
Generic Function: align-content (clog-element)

Get/Setf align content wrapped inline of a flexbox on opposite sides of each other or grid on column axis.

Package

clog.

Source

clog-element.lisp.

Methods
Method: align-content ((obj clog-element))
Generic Function: (setf align-content) (clog-element)

Set align-content VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf align-content) ((obj clog-element))
Generic Function: align-items (clog-element)

Get/Setf align items in a flexbox/grid on column axis.

Package

clog.

Source

clog-element.lisp.

Methods
Method: align-items ((obj clog-element))
Generic Function: (setf align-items) (clog-element)

Set align-items VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf align-items) ((obj clog-element))
Generic Function: align-self (clog-element)

Get/Setf override align-items for this item in a flexbox/grid.

Package

clog.

Source

clog-element.lisp.

Methods
Method: align-self ((obj clog-element))
Generic Function: (setf align-self) (clog-element)

Set align-self VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf align-self) ((obj clog-element))
Generic Function: alphabetic-baseline (clog-text-metrics)

Alphabetic baseline

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: alphabetic-baseline ((obj clog-text-metrics))
Generic Function: alt-text (clog-form-element)

Get/Setf the alt-text of the img.

Package

clog.

Source

clog-form.lisp.

Methods
Method: alt-text ((obj clog-form-element))
Method: alt-text ((obj clog-img))
Source

clog-element-common.lisp.

Generic Function: (setf alt-text) (clog-form-element)

Set alt-text VALUE for CLOG-FORM-ELEMENT

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf alt-text) ((obj clog-form-element))
Method: (setf alt-text) ((obj clog-img))
Source

clog-element-common.lisp.

Generic Function: arc (clog-context2d x y radius start-angle end-angle &key anticlockwise)

Adds a circular arc to the current path.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: arc ((obj clog-path2d) x y radius start-angle end-angle &key anticlockwise)
Method: arc ((obj clog-context2d) x y radius start-angle end-angle &key anticlockwise)
Generic Function: arc-to (clog-context2d x1 y1 x2 y2)

Adds an arc to the current path.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: arc-to ((obj clog-path2d) x1 y1 x2 y2)
Method: arc-to ((obj clog-context2d) x1 y1 x2 y2)
Generic Function: attach-as-child (clog-obj html-id &key clog-type new-id)

Create a new CLOG-ELEMENT or sub-type of CLOG-TYPE and
attach an existing element with HTML-ID. The HTML-ID must be unique and must be in DOM, ie placed or auto-placed. If new-id is true the HTML-ID after attachment is changed to one unique to this session.

Package

clog.

Source

clog-element.lisp.

Methods
Method: attach-as-child ((obj clog-obj) html-id &key clog-type new-id)
Generic Function: attach-shader (clog-webgl-program clog-webgl-shader)

Attaches either a fragment or vertex CLOG-WEBGL-SHADER

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: attach-shader ((obj clog-webgl-program) (shader clog-webgl-shader))
Generic Function: attribute (clog-element attribute-name &key default-answer)

Get/Setf html tag attribute. (eg. src on img tag)

Package

clog.

Source

clog-element.lisp.

Methods
Method: attribute ((obj clog-element) attribute-name &key default-answer)
Generic Function: (setf attribute) (clog-element attribute-name)

Set html tag attribute.

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf attribute) ((obj clog-element) attribute-name)
Generic Function: attribute-location (clog-webgl-program name)

Returns the location of an attribute variable in clog-webgl-program

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: attribute-location ((obj clog-webgl-program) name)
Generic Function: autocomplete (clog-form-element)

Get/Setf form element autocomplete.

Package

clog.

Source

clog-form.lisp.

Methods
Method: autocomplete ((obj clog-form-element))
Generic Function: (setf autocomplete) (clog-form-element)

Set autocomplete AUTOCOMPLETE for CLOG-FORM-ELEMENT

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf autocomplete) ((obj clog-form-element))
Generic Function: autocompletep (clog-form)

Get/Setf form autocompletep.

Package

clog.

Source

clog-form.lisp.

Methods
Method: autocompletep ((obj clog-form))
Generic Function: (setf autocompletep) (clog-form)

Set autocompletep for CLOG-FORM

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf autocompletep) ((obj clog-form))
Generic Function: autofocusp (clog-form-element)

Get/Setf form element autofocusp. Only one element should have this set true ever. Autofocus on element when form loaded.

Package

clog.

Source

clog-form.lisp.

Methods
Method: autofocusp ((obj clog-form-element))
Generic Function: (setf autofocusp) (clog-form-element)

Set autofocusp AUTOFOCUSP for CLOG-FORM-ELEMENT

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf autofocusp) ((obj clog-form-element))
Generic Function: background-attachment (clog-element)

Get/Setf background-attachment.

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-attachment ((obj clog-element))
Generic Function: (setf background-attachment) (clog-element)

Set background-attachment VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-attachment) ((obj clog-element))
Generic Function: background-clip (clog-element)

Get/Setf background-clip. If an element’s background extends underneath its border box, padding box, or content box.

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-clip ((obj clog-element))
Generic Function: (setf background-clip) (clog-element)

Set background-clip VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-clip) ((obj clog-element))
Generic Function: background-color (clog-element)

Get/Setf background-color.

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-color ((obj clog-element))
Generic Function: (setf background-color) (clog-element)

Set background-color VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-color) ((obj clog-element))
Generic Function: background-image (clog-element)

Get/Setf background-image url. proper syntax is ’url(...)’ | nil to clear

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-image ((obj clog-element))
Generic Function: (setf background-image) (clog-element)

Set background-image VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-image) ((obj clog-element))
Generic Function: background-origin (clog-element)

Get/Setf background-origin. Background position property is relative to origin of: padding-box|border-box|content-box

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-origin ((obj clog-element))
Generic Function: (setf background-origin) (clog-element)

Set background-origin VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-origin) ((obj clog-element))
Generic Function: background-position (clog-element)

Get/Setf background-position. combination of 2 - left/right/center/top/bottom | %x %y | x y

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-position ((obj clog-element))
Generic Function: (setf background-position) (clog-element)

Set background-position VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-position) ((obj clog-element))
Generic Function: background-repeat (clog-element)

Get/Setf background-repeat. repeat-x | repeat-y | ( repeat | space | round | no-repeat ) {1,2}

Package

clog.

Source

clog-element.lisp.

Methods
Method: background-repeat ((obj clog-element))
Generic Function: (setf background-repeat) (clog-element)

Set background-repeat VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-repeat) ((obj clog-element))
Generic Function: background-size (clog-element)

Get/Setf background-size.
auto | w h | % = cover of parent | contain

Package

clog.

Source

clog-element.lisp.

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

Set background-size VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf background-size) ((obj clog-element))
Generic Function: begin-path (clog-context2d)

Starts a new path empting any previous points.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: begin-path ((obj clog-context2d))
Generic Function: bezier-curve-to (clog-context2d cp1x cp1y cp2x cp2y x y)

Adds a cubic Bezier curve to the current path.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: bezier-curve-to ((obj clog-path2d) cp1x cp1y cp2x cp2y x y)
Method: bezier-curve-to ((obj clog-context2d) cp1x cp1y cp2x cp2y x y)
Generic Function: bind-attribute-location (clog-webgl-program index name)

Binds a generic vertex INDEX to an attribute variable called NAME.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: bind-attribute-location ((obj clog-webgl-program) index name)
Generic Function: bind-buffer (clog-webgl-buffer glenum-target)

Set BIND-TYPE of buffer to either :ARRAY_BUFFER or :ELEMENT_ARRAY_BUFFER. WebGL2 adds:
:COPY_READ_BUFFER : Buffer for copying from one buffer object to another. :COPY_WRITE_BUFFER : Buffer for copying from one buffer object to another. :TRANSFORM_FEEDBACK_BUFFER : Buffer for transform feedback operations. :UNIFORM_BUFFER : Buffer used for storing uniform blocks. :PIXEL_PACK_BUFFER : Buffer used for pixel transfer operations. :PIXEL_UNPACK_BUFFER : Buffer used for pixel transfer operations.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: bind-buffer ((obj clog-webgl-buffer) glenum-target)
Generic Function: bind-frame-buffer (clog-webgl-frame-buffer glenum-target)

Set BIND-TYPE of frame-buffer to :FRAMEBUFFER
in WebGL2 the following are added:
:DRAW_FRAMEBUFFER : Used as a destination for drawing operations such as draw*, clear* and blit-frame-buffer.
:READ_FRAMEBUFFER : Used as a source for reading operations such as readPixels and blit-frame-buffer

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: bind-frame-buffer ((obj clog-webgl-frame-buffer) glenum-target)
Generic Function: bind-render-buffer (clog-webgl-render-buffer glenum-target)

Set BIND-TYPE of render-buffer to :RENDERBUFFER

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: bind-render-buffer ((obj clog-webgl-render-buffer) glenum-target)
Generic Function: bind-texture (clog-webgl-texture glenum-target)

Set BIND-TYPE of texture to:
:TEXTURE_2D : A two-dimensional texture. :TEXTURE_CUBE_MAP : A cube-mapped texture.
in WebGL 2 also:
:TEXTURE_3D : A three-dimensional texture. :TEXTURE_2D_ARRAY : A two-dimensional array texture.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: bind-texture ((obj clog-webgl-texture) glenum-target)
Generic Function: bind-vertex-array (obj)
Package

clog-webgl.

Methods
Method: bind-vertex-array ((obj clog-webgl-vertex-array))
Source

clog-webgl.lisp.

Generic Function: blend-color (clog-webgl red green blue alpha)

Used to set the source and destination blending factors.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: blend-color ((obj clog-webgl) red green blue alpha)
Generic Function: blend-equation (clog-webgl glenum-mode)

Used to set both the RGB blend equation and alpha blend equation to a single equation. :FUNC_ADD : source + destination (default value)
:FUNC_SUBTRACT : source - destination
:FUNC_REVERSE_SUBTRACT : destination - source

When using a WebGL 2 context, the following values are available additionally:

:MIN : Minimum of source and destination
:MAX : Maximum of source and destination

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: blend-equation ((obj clog-webgl) glenum-mode)
Generic Function: blend-equation-seperate (clog-webgl glenum-mode-rgb glenum-mode-alpha)

Used to set both the RGB blend equation and alpha blend equation to a single equation. :FUNC_ADD : source + destination (default value)
:FUNC_SUBTRACT : source - destination
:FUNC_REVERSE_SUBTRACT : destination - source

When using a WebGL 2 context, the following values are available additionally:

:MIN : Minimum of source and destination
:MAX : Maximum of source and destination

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: blend-equation-seperate ((obj clog-webgl) glenum-mode-rgb glenum-mode-alpha)
Generic Function: blend-function (clog-webgl glenum-source-factor glenum-destination-factor)

Defines which function is used for blending pixel arithmetic.
See - https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/blendFunc

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: blend-function ((obj clog-webgl) glenum-sfactor glenum-dfactor)
Generic Function: blend-function-seperate (clog-webgl glenum-source-factor-rgb glenum-destination-factor-rgb glenum-source-factor-alpha glenum-destination-factor-alpha)

Defines which function is used for blending pixel arithmetic.
See - https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/blendFunc

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: blend-function-seperate ((obj clog-webgl) glenum-sfactor-rgb glenum-dfactor-rgb glenum-sfactor-alpha glenum-dfactor-alpha)
Generic Function: blur (clog-obj)

Remove focus from CLOG-OBJ

Package

clog.

Source

clog-base.lisp.

Methods
Method: blur ((obj clog-obj))
Generic Reader: body-element (object)
Package

clog.

Methods
Reader Method: body-element ((clog-document clog-document))

automatically generated reader method

Source

clog-document.lisp.

Target Slot

body-element.

Generic Function: border (clog-element)

Get border. <line-width> <border-style> <line-color>

Package

clog.

Source

clog-element.lisp.

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

Set border VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf border) ((obj clog-element))
Generic Function: border-radius (clog-element)

Get/Setf border-radius.

Package

clog.

Source

clog-element.lisp.

Methods
Method: border-radius ((obj clog-element))
Generic Function: (setf border-radius) (clog-element)

Set border-radius VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf border-radius) ((obj clog-element))
Generic Function: bottom (clog-element)

Get/Setf bottom (defaults to use :px units).

Package

clog.

Source

clog-element.lisp.

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

Set bottom VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf bottom) ((obj clog-element))
Generic Reader: bottom-panel (clog-panel-box-layout)

Returns the bottom panel of a clog-panel-box-layout object.

Package

clog.

Source

clog-panel.lisp.

Methods
Reader Method: bottom-panel ((clog-panel-box-layout clog-panel-box-layout))

Bottom Panel

Target Slot

bottom-panel.

Generic Writer: (setf bottom-panel) (object)
Package

clog.

Methods
Writer Method: (setf bottom-panel) ((clog-panel-box-layout clog-panel-box-layout))

Bottom Panel

Source

clog-panel.lisp.

Target Slot

bottom-panel.

Generic Function: box-height (clog-element)

Get/Setf box-height. Height based on box sizing.

Package

clog.

Source

clog-element.lisp.

Methods
Method: box-height ((obj clog-element))
Generic Function: (setf box-height) (clog-element)

Set box-height VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf box-height) ((obj clog-element))
Generic Function: box-shadow (clog-element)

Get/Setf box-shadow.

Package

clog.

Source

clog-element.lisp.

Methods
Method: box-shadow ((obj clog-element))
Generic Function: (setf box-shadow) (clog-element)

Set box-shadow. See https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Background_and_Borders/Box-shadow_generator

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf box-shadow) ((obj clog-element))
Generic Function: box-sizing (clog-element)

Get/Setf box-sizing. Affects if height and width
properteries represent just the content or the border, marging, padding, scroll and conent area as a whole. The default is content-box

Package

clog.

Source

clog-element.lisp.

Methods
Method: box-sizing ((obj clog-element))
Generic Function: (setf box-sizing) (clog-element)

Set box-sizing VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf box-sizing) ((obj clog-element))
Generic Function: box-width (clog-element)

Get/Setf box-width. Width based on box sizing.

Package

clog.

Source

clog-element.lisp.

Methods
Method: box-width ((obj clog-element))
Generic Function: (setf box-width) (clog-element)

Set box-width VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf box-width) ((obj clog-element))
Generic Function: browser-gc (clog-element)

Finalize any clog cache items on browser not in DOM.
If clog-connect:*browser-gc-on-ping* is set this is done during websocket pings. The main use is when clearing out large amounts of DOM objects not using CLOG destroy. Any object stored in the connection-data will not be garbage collected on the browser or Lisp side until DESTROY.

Package

clog.

Source

clog-element.lisp.

Methods
Method: browser-gc ((obj clog-element))
Generic Function: buffer-data (clog-webgl-buffer data-list data-type glenum-usage)

Initializes and creates the buffer object’s data store. DATA-LIST is a Lisp list of data elements.
DATA-TYPE is the WebGL data type as a string "Float32Array" GLENUM-USAGE us a usage hint like :STATIC_DRAW

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: buffer-data ((obj clog-webgl-buffer) data-list data-type hint)
Generic Function: buffer-parameter (clog-webgl glenum-target glenum-pname)

Returns information about the buffer.
target:
A GLenum specifying the target buffer object. Possible values:

:ARRAY_BUFFER
Buffer containing vertex attributes, such as vertex coordinates, texture coordinate data, or vertex color data.

:ELEMENT_ARRAY_BUFFER
Buffer used for element indices.

When using a WebGL 2 context, the following values are available additionally:

:COPY_READ_BUFFER
Buffer for copying from one buffer object to another.

:COPY_WRITE_BUFFER
Buffer for copying from one buffer object to another.

:TRANSFORM_FEEDBACK_BUFFER
Buffer for transform feedback operations.

:UNIFORM_BUFFER
Buffer used for storing uniform blocks.

:PIXEL_PACK_BUFFER
Buffer used for pixel transfer operations.

:PIXEL_UNPACK_BUFFER
Buffer used for pixel transfer operations.

pname:
A GLenum specifying information to query. Possible values:

:BUFFER_SIZE
Returns a GLint indicating the size of the buffer in bytes.

:BUFFER_USAGE
Returns a GLenum indicating the usage pattern of the buffer. One of the followings:

:STATIC_DRAW
:DYNAMIC_DRAW
:STREAM_DRAW

When using a WebGL 2 context, the following values are available additionally:

:STATIC_READ
:DYNAMIC_READ
:STREAM_READ
:STATIC_COPY
:DYNAMIC_COPY
:STREAM_COPY

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: buffer-parameter ((obj clog-webgl) glenum-target glenum-pname)
Generic Function: buffer-sub-data (clog-webgl-buffer offset data-list data-type)

Initializes and creates the buffer object’s data store. OFFSET element index offset where to start reading the buffer. DATA-LIST is a Lisp list of data elements.
DATA-TYPE is the WebGL data type as a string "Float32Array"

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: buffer-sub-data ((obj clog-webgl-buffer) offset data-list data-type)
Generic Function: can-play-type-p (clog-multimedia media-type)

Returns true if browser claims support of a media type.
Browsers report possibility but not guarantees of being able to support a media type.

Common values:
video/ogg
video/mp4
video/webm
audio/mpeg
audio/ogg
audio/mp4
audio/mp3

Common values, including codecs:
video/ogg; codecs="theora, vorbis"
video/mp4; codecs="avc1.4D401E, mp4a.40.2"
video/webm; codecs="vp8.0, vorbis"
audio/ogg; codecs="vorbis"
audio/mp4; codecs="mp4a.40.5"

Package

clog.

Source

clog-multimedia.lisp.

Methods
Method: can-play-type-p ((obj clog-multimedia) media-type)
Generic Function: canvas-filter (clog-context2d)

Setf/get filter dsl -
See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/filter

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: canvas-filter ((obj clog-context2d))
Generic Function: (setf canvas-filter) (obj)
Package

clog.

Methods
Method: (setf canvas-filter) ((obj clog-context2d))
Source

clog-canvas.lisp.

Generic Function: canvas-restore (clog-context2d)

Restore canvas from stack

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: canvas-restore ((obj clog-context2d))
Generic Function: canvas-save (clog-context2d)

Save canvas to stack

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: canvas-save ((obj clog-context2d))
Generic Function: center-children (clog-element &key vertical horizontal)

Align children of CLOG-ELEMENT VERTICAL (default t)
and/or HORIZONTAL (default t). This will set the DISPLAY property of CLOG-ELEMENT to :FLEX.

Note: if children of CLOG-ELEMENT are using :absolute positioning they will not flow with flex and will not be centered. Instead use :relative positioning.

Note: to use with CLOG Buider Panels - use ENVELOPE-PANEL or in the builder create a div at top:0 left:0 and size the div to be the boundaries of your panel to be centered, then set the positioning on the panel to :relative.
Add all controls as child of that div.

Package

clog.

Source

clog-panel.lisp.

Methods
Method: center-children ((obj clog-element) &key vertical horizontal)
Generic Reader: center-panel (clog-panel-box-layout)

Returns the center panel of a clog-panel-box-layout object.

Package

clog.

Source

clog-panel.lisp.

Methods
Reader Method: center-panel ((clog-panel-box-layout clog-panel-box-layout))

Center Panel

Target Slot

center-panel.

Generic Writer: (setf center-panel) (object)
Package

clog.

Methods
Writer Method: (setf center-panel) ((clog-panel-box-layout clog-panel-box-layout))

Center Panel

Source

clog-panel.lisp.

Target Slot

center-panel.

Generic Function: check-frame-buffer-status (clog-webgl target)

Completeness status of frame buffer. Target can be:
:FRAMEBUFFER
Collection buffer data storage of color, alpha, depth and stencil buffers used to render an image.

When using a WebGL 2 context, the following values are available additionally:

:DRAW_FRAMEBUFFER
Equivalent to :FRAMEBUFFER. Used as a destination for drawing, rendering, clearing, and writing operations.

:READ_FRAMEBUFFER
Used as a source for reading operations.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: check-frame-buffer-status ((obj clog-webgl) target)
Generic Function: checkbox-value (clog-obj name)

Returns t or nil on the selected checkbox button.

Package

clog.

Source

clog-form.lisp.

Methods
Method: checkbox-value ((obj clog-obj) name)
Generic Function: checkedp (clog-form-element)

Get/Setf form element checkedp.

Package

clog.

Source

clog-form.lisp.

Methods
Method: checkedp ((obj clog-form-element))
Generic Function: (setf checkedp) (clog-form-element)

Set VALUE if checkedp for CLOG-FORM-ELEMENT

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf checkedp) ((obj clog-form-element))
Generic Function: clear-color (clog-webgl red green blue alpha)

Specifies the color values used when clearing color buffers with CLEAR-WEBGL.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: clear-color ((obj clog-webgl) red green blue alpha)
Generic Function: clear-depth (clog-webgl depth)

Specifying the depth value used when the depth buffer is cleared.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: clear-depth ((obj clog-webgl) depth)
Generic Function: clear-rect (clog-context2d x y width height)

Clear rectangle to transparent black

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: clear-rect ((obj clog-context2d) x y width height)
Generic Function: clear-row (clog-one-row panel)

Clear current rowid and all fields in PANEL using DATA-WRITE-PLIST based on table-columns.

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: clear-row ((obj clog-db-table) panel)
Method: clear-row ((obj clog-lookup) panel)
Method: clear-row ((obj clog-one-row) panel)
Generic Function: clear-side (clog-element)

Get/Setf clear-side. When using ’float’ for layout sets
if the right or left side of block should be clear of any ’floated’ Element.

Package

clog.

Source

clog-element.lisp.

Methods
Method: clear-side ((obj clog-element))
Generic Function: (setf clear-side) (clog-element)

Set clear-side VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf clear-side) ((obj clog-element))
Generic Function: clear-stencil (clog-webgl stencil)

Specifying the stencil index used when the stencil buffer is cleared.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: clear-stencil ((obj clog-webgl) stencil)
Generic Function: clear-webgl (clog-webgl glenum-mask)

Clears buffers to preset values. GLENUM-MASK can be: :COLOR_BUFFER_BIT
:DEPTH_BUFFER_BIT
:STENCIL_BUFFER_BIT

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: clear-webgl ((obj clog-webgl) glenum-mask)
Generic Function: click (clog-element)

simulate click.

Package

clog.

Source

clog-element.lisp.

Methods
Method: click ((obj clog-element))
Generic Function: client-height (clog-element)

Get client-right. Inner height of an element in pixels.
CSS height + CSS padding - height of horizontal scrollbar (if present) Does not include the border or margin.

Package

clog.

Source

clog-element.lisp.

Methods
Method: client-height ((obj clog-element))
Generic Function: client-left (clog-element)

Get client-left. The width of the left border of an element in pixels. It does not include the margin or padding.

Package

clog.

Source

clog-element.lisp.

Methods
Method: client-left ((obj clog-element))
Generic Function: client-top (clog-element)

Get client-top. The width of the top border of an element in pixels. It does not include the margin or padding.

Package

clog.

Source

clog-element.lisp.

Methods
Method: client-top ((obj clog-element))
Generic Function: client-width (clog-element)

Get client-width. Inner width of an element in pixels.
CSS width + CSS padding - width of vertical scrollbar (if present) Does not include the border or margin.

Package

clog.

Source

clog-element.lisp.

Methods
Method: client-width ((obj clog-element))
Generic Function: clog-database (clog-obj)

Access to the CLOG-DATABASE

Package

clog.

Source

clog-dbi.lisp.

Methods
Reader Method: clog-database ((clog-one-row clog-one-row))

Database control table connected to.

Target Slot

clog-database.

Method: clog-database ((obj clog-database))
Generic Writer: (setf clog-database) (object)
Package

clog.

Methods
Writer Method: (setf clog-database) ((clog-one-row clog-one-row))

Database control table connected to.

Source

clog-dbi.lisp.

Target Slot

clog-database.

Generic Function: clog-popup-openned (clog-obj sync-key)

Used to notify open-clog-popup the new popup window is ready used for custom clog-popup handlers.

Package

clog.

Source

clog-window.lisp.

Methods
Method: clog-popup-openned ((obj clog-obj) sync-key)
Generic Function: close-connection (clog-window)

Close connection to browser with out closing browser.

Package

clog.

Source

clog-window.lisp.

Methods
Method: close-connection ((obj clog-window))
Generic Function: close-dialog (clog-dialog)

Close dialog.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: close-dialog ((obj clog-dialog))
Generic Function: close-path (clog-context2d)

Adds a line to start point of path.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: close-path ((obj clog-path2d))
Method: close-path ((obj clog-context2d))
Generic Function: close-window (clog-window)

Close browser window.

Package

clog.

Source

clog-window.lisp.

Methods
Method: close-window ((obj clog-window))
Generic Function: color (clog-element)

Get/Setf color.

Package

clog.

Source

clog-element.lisp.

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

Set color VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf color) ((obj clog-element))
Generic Function: color-mask (clog-webgl red green blue alpha)

Sets which color components to enable or to disable when drawing or rendering red green blue alpha are nil or true

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: color-mask ((obj clog-webgl) red green blue alpha)
Generic Function: column-gap (clog-element)

Get/Setf column-gap.

Package

clog.

Source

clog-element.lisp.

Methods
Method: column-gap ((obj clog-element))
Generic Function: (setf column-gap) (clog-element)

Set column-gap VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf column-gap) ((obj clog-element))
Generic Function: columns (clog-text-area)

Get/Setf form element columns.

Package

clog.

Source

clog-form.lisp.

Methods
Method: columns ((obj clog-text-area))
Generic Function: (setf columns) (clog-text-area)

Set columns COLUMNS for CLOG-TEXT-AREA

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf columns) ((obj clog-text-area))
Generic Function: compile-shader (obj)
Package

clog-webgl.

Methods
Method: compile-shader ((obj clog-webgl-shader))
Source

clog-webgl.lisp.

Generic Function: compile-shader-source (obj glenum-type source)
Package

clog-webgl.

Methods
Method: compile-shader-source ((obj clog-webgl) glenum-type source)
Source

clog-webgl.lisp.

Generic Function: compile-webgl-program (obj vertex-shader fragment-shader)
Package

clog-webgl.

Methods
Method: compile-webgl-program ((obj clog-webgl) vertex-shader fragment-shader)
Source

clog-webgl.lisp.

Generic Function: composite-bottom-left (clog-element &key padding-class)

Composite CLOG-ELEMENT on bottom-left.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-bottom-left ((obj clog-element) &key padding-class)
Generic Function: composite-bottom-middle (clog-element &key padding-class)

Composite CLOG-ELEMENT on bottom-middle.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-bottom-middle ((obj clog-element) &key padding-class)
Generic Function: composite-bottom-right (clog-element &key padding-class)

Composite CLOG-ELEMENT on bottom-right.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-bottom-right ((obj clog-element) &key padding-class)
Generic Function: composite-left (clog-element &key padding-class)

Composite CLOG-ELEMENT on left.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-left ((obj clog-element) &key padding-class)
Generic Function: composite-middle (clog-element &key padding-class)

Composite CLOG-ELEMENT on middle.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-middle ((obj clog-element) &key padding-class)
Generic Function: composite-on-hover (clog-element)

Composite CLOG-ELEMENT on on-hover.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-on-hover ((obj clog-element))
Generic Function: composite-position (clog-element &key top left padding-class)

Composite CLOG-ELEMENT to coordinate top left.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-position ((obj clog-element) &key top left padding-class)
Generic Function: composite-right (clog-element &key padding-class)

Composite CLOG-ELEMENT on right.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-right ((obj clog-element) &key padding-class)
Generic Function: composite-top-left (clog-element &key padding-class)

Composite CLOG-ELEMENT on top-left.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-top-left ((obj clog-element) &key padding-class)
Generic Function: composite-top-middle (clog-element &key padding-class)

Composite CLOG-ELEMENT on top-middle.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-top-middle ((obj clog-element) &key padding-class)
Generic Function: composite-top-right (clog-element &key padding-class)

Composite CLOG-ELEMENT on top-right.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: composite-top-right ((obj clog-element) &key padding-class)
Generic Function: connection-body (clog-obj)

Get connection’s clog-body.

Package

clog.

Source

clog-base.lisp.

Methods
Method: connection-body (clog-obj)
Generic Function: connection-data (clog-obj)

Get connection-data that is associated with
clog-obj’s connection that will persist regardless of thread calling. The event hooks are stored in this string based hash in the format of: "html-id:event-name" => #’event-handler. clog-* keys are reserved for internal use of clog.

The following default keys are set:
"clog-body" clog-body of this connection, see CONNECTION-BODY "clog-path" html path used, see CONNECTION-PATH
"clog-sync" mutex used for syncing events, see CONNECTION-SYNC

Package

clog.

Source

clog-base.lisp.

Methods
Method: connection-data ((obj clog-obj))
Generic Function: connection-data-item (clog-obj item-name)

Get/Setf item-name from connection-data.

Package

clog.

Source

clog-base.lisp.

Methods
Method: connection-data-item ((obj clog-obj) item-name)
Generic Function: (setf connection-data-item) (clog-obj item-name)

Set connection-data item-name with value.

Package

clog.

Source

clog-base.lisp.

Methods
Method: (setf connection-data-item) ((obj clog-obj) item-name)
Generic Function: connection-path (clog-obj)

Get the HTML passed used to make the connection.

Package

clog.

Source

clog-base.lisp.

Methods
Method: connection-path (clog-obj)
Generic Function: connection-sync (clog-obj)

Get connection’s clog-sync for optional syncing events.

Package

clog.

Source

clog-base.lisp.

Methods
Method: connection-sync (clog-obj)
Generic Reader: content (object)
Package

clog.

Methods
Reader Method: content ((clog-gui-window clog-gui-window))

Window body clog-element

Source

clog-gui.lisp.

Target Slot

content.

Reader Method: content ((clog-tree-item clog-tree-item))

automatically generated reader method

Source

clog-tree.lisp.

Target Slot

content.

Reader Method: content ((clog-tree clog-tree))

automatically generated reader method

Source

clog-tree.lisp.

Target Slot

content.

Generic Writer: (setf content) (object)
Package

clog.

Methods
Writer Method: (setf content) ((clog-gui-window clog-gui-window))

Window body clog-element

Source

clog-gui.lisp.

Target Slot

content.

Writer Method: (setf content) ((clog-tree-item clog-tree-item))

automatically generated writer method

Source

clog-tree.lisp.

Target Slot

content.

Writer Method: (setf content) ((clog-tree clog-tree))

automatically generated writer method

Source

clog-tree.lisp.

Target Slot

content.

Generic Function: context-attributes (obj)
Package

clog-webgl.

Methods
Method: context-attributes ((obj clog-webgl))
Source

clog-webgl.lisp.

Get if cookie enabled.

Package

clog.

Source

clog-navigator.lisp.

Methods
Generic Function: create-a (clog-obj &key link content target style hidden class html-id auto-place download)

Create a new CLOG-A as child of CLOG-OBJ with :LINK and
:CONTENT (default "") and :TARGET ("_self") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ.

Target of link, name of a frame or:
_blank = new window
_top = top most frame (full browser window)
_parent = parent frame or window
_self = current frame or window

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-a ((obj clog-obj) &key link content target download style hidden class html-id auto-place)
Generic Function: create-audio (clog-obj &key source controls preload autoplay autoloop muted html-id auto-place)

Create a CLOG Audio control

Package

clog.

Source

clog-multimedia.lisp.

Methods
Method: create-audio ((obj clog-obj) &key source controls preload autoplay autoloop muted html-id auto-place)
Generic Function: create-br (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-BR as child of CLOG-OBJ that creates a
line break and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-br ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-button (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Button as child of CLOG-OBJ with :CONTENT (default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-button ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-canvas (clog-obj &key width height class hidden html-id auto-place)

Create a new CLOG-Canvas as child of CLOG-OBJ if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-canvas ((obj clog-obj) &key width height class hidden html-id auto-place)
Generic Function: create-child (clog-obj html &key html-id auto-place clog-type)

Create a new CLOG-ELEMENT or sub-type of CLOG-TYPE from HTML
as child of CLOG-OBJ and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ, you can also set auto-place to :bottom or :top. If HTML-ID is nil one will be generated. If auto-place is nil the object is stored in the connection-data and not subject to browser-gc requests.

Package

clog.

Source

clog-element.lisp.

Methods
Method: create-child ((obj clog-obj) html &key html-id auto-place clog-type)
Generic Function: create-clog-tree (obj &key content indent-level node-html on-context-menu fill-function visible style class html-id auto-place)
Package

clog.

Methods
Method: create-clog-tree ((obj clog-obj) &key content indent-level node-html on-context-menu fill-function visible style class html-id auto-place)

Creates a clog-tree node labeled CONTENT with INDENT-LEVEL using NODE-HTML icon. When FILL-FUNCTION, when clog-tree is visible the FILL-FUNCTION is called and when not visible (such as clicked to close) the children are destroyed.

Source

clog-tree.lisp.

Generic Function: create-clog-tree-item (obj &key content indent-level node-html on-click on-context-menu style class html-id auto-place)
Package

clog.

Methods
Method: create-clog-tree-item ((obj clog-obj) &key content indent-level node-html on-click on-context-menu style class html-id auto-place)

Creates a clog-tree-item node labeled CONTENT with INDENT-LEVEL using NODE-HTML icon. If INDENT-LEVEL is nil get parent’s INDENT-LEVEL from obj if is a clog-tree.

Source

clog-tree.lisp.

Generic Function: create-conic-gradient (clog-context2d start-angle x y)

Create conic gradient

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-conic-gradient ((obj clog-context2d) start-angle x y)
Generic Function: create-context2d (clog-canvas)

Create a new CLOG-Context2d from a CLOG-Canvas

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-context2d ((obj clog-canvas))
Generic Function: create-data-list (clog-obj &key data-list html-id auto-place)

Create a new clog-data-list as child of CLOG-OBJ and optionally fill in with contents of data-list.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-data-list ((obj clog-obj) &key data-list html-id auto-place)
Generic Function: create-database (clog-obj &key hidden class html-id auto-place)

Create a new CLOG-Database element, for use in CLOG-Builder. If not using builder use to connect: (dbi:connect (database-connection clog-obj) ...) or if a connection exists assign it to the database-connecton.

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: create-database ((obj clog-obj) &key hidden class html-id auto-place)
Generic Function: create-db-table (clog-obj &key clog-database hidden class html-id auto-place)

Create a new clog-db-table as child of CLOG-OBJ.

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: create-db-table ((obj clog-obj) &key clog-database hidden class html-id auto-place)
Generic Function: create-definition-list (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Definition-List as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-definition-list ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-description (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Description as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-description ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-details (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Details as child of CLOG-OBJ with :CONTENT (default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-details ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-dialog (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Dialog as child of CLOG-OBJ with :CONTENT
(default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil. Modal does not work on firefox and dialog does not work at all on IE.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-dialog ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-div (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Div as child of CLOG-OBJ with :CONTENT (default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-div ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-element (clog-obj html-tag &rest all-args &key content clog-type html-id auto-place &allow-other-keys)

Create a new CLOG-ELEMENT as child of CLOG-OBJ with any possible tag and keywords.

Package

clog.

Source

clog-element.lisp.

Methods
Method: create-element (clog-obj html-tag &rest all-args &key content clog-type html-id auto-place &allow-other-keys)
Generic Function: create-fieldset (clog-obj &key legend hidden style class html-id auto-place)

Create a new clog-fieldset as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-fieldset ((obj clog-obj) &key legend style hidden class html-id auto-place)
Generic Function: create-form (clog-obj &key action method target encoding style hidden class html-id auto-place)

Create a new CLOG-Form as child of CLOG-OBJ that organizes
a collection of form elements in to a single form if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. In CLOG a form’s on-submit handler should be set and the form element values handled in that handler as opposed to the HTML model of submitting to a new "page". If though one wishes to submit to another page can use the :ACTION :METHOD and :TARGET keys and either do not set an on-submit handler or call (submit CLOG-FORM) to perform the form action. The default :ENCODING is application/x-www-form-urlencoded if doing file upload use multipart/form-data

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-form ((obj clog-obj) &key action method target encoding style hidden class html-id auto-place)
Generic Function: create-form-element (clog-obj element-type &rest args &key name label class style hidden html-id auto-place &allow-other-keys)

Create a new clog-form-element as child of CLOG-OBJ.
It is importamt that clog-form-elements are a child or descendant of a clog-form in the DOM. The radio ELEMENT-TYPE groups by
NAME. Additional keys will be added to the input tag as attribute/value pairs in the form attr= ’value’

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-form-element ((obj clog-obj) element-type &rest args &key name label class style hidden html-id auto-place)
Generic Function: create-gui-menu-bar (clog-obj &key class html-id main-menu)

Attached a menu bar to a CLOG-OBJ in general a clog-body. If main-menu add as main menu bar.

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-bar ((obj clog-obj) &key class html-id main-menu)
Generic Function: create-gui-menu-drop-down (clog-gui-menu-bar &key content class html-id right-align)

Attached a menu bar drop-down to a CLOG-GUI-MENU-BAR

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-drop-down ((obj clog-gui-menu-bar) &key content class right-align html-id)
Generic Function: create-gui-menu-full-screen (clog-gui-menu-bar &key html-id)

Add as last item in menu bar to allow for a full screen icon ⤢ (*menu-full-screen-item* default) and full screen mode.

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-full-screen ((obj clog-gui-menu-bar) &key html-id)
Generic Function: create-gui-menu-icon (clog-gui-menu-bar &key image-url on-click class html-id)

Add icon as menu bar item.

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-icon ((obj clog-gui-menu-bar) &key image-url on-click class html-id)
Generic Function: create-gui-menu-item (clog-gui-menu-drop-down &key content on-click class html-id)

Attached a menu item to a CLOG-GUI-MENU-DROP-DOWN

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-item ((obj clog-obj) &key content on-click class html-id)
Generic Function: create-gui-menu-window-select (clog-obj &key class content html-id)

Attaches a clog-select as a menu item that auto updates
with open windows and focuses them unless is a keep-on-top window. The first menu-window-select will receive change window notices only.

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-menu-window-select ((obj clog-obj) &key class content html-id)
Generic Function: create-gui-window (clog-obj &key title content left top width height maximize hide-title-bar drag-client-area has-pinner closer-html keep-on-top window-param hidden client-movement no-sizer border-class title-class html-id)

Create a clog-gui-window. If client-movement is t then
use jquery-ui to move/resize and will not work on mobile and touch events are limitted to clicks. When client-movement is t only on-window-move is fired once at start of drag and on-window-move-done at end of drag and on-window-resize at start of resize and on-window-resize-done at end of resize. If has-pinner a toggle will appear on title bar to allow pinning the window in place, if keep-on-top t then when pinned also will keep-on-top. If had-pinned is nil and keep-on-top t then the window will be set to keep-on-top always. window-param is a general parameter for identifiying the window to use with window-to-top-by-param or window-by-param.

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: create-gui-window ((obj clog-obj) &key title content left top width height maximize hide-title-bar drag-client-area has-pinner closer-html keep-on-top window-param hidden client-movement no-sizer border-class title-class html-id)
Generic Function: create-hr (clog-obj &key hidden style class html-id auto-place)

Create a new CLOG-HR as child of CLOG-OBJ that creates a
horizontal rule (line) and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-hr ((obj clog-obj) &key hidden style class html-id auto-place)
Generic Function: create-image-data (clog-context2d width height)

Create blank image data

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-image-data ((obj clog-context2d) width height)
Generic Function: create-img (clog-obj &key url-src alt-text style hidden class html-id auto-place)

Create a new CLOG-Img as child of CLOG-OBJ with :URL-SRC
(default "") and :ALT-TEXT (default "") if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. Use width and height properties before placing image to constrain image size.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-img ((obj clog-obj) &key url-src alt-text style hidden class html-id auto-place)
Generic Function: create-jquery (clog-obj jquery)

Create a new CLOG-JQUERY from JQUERY. Some sample jquery selectors: *
.class
element_name
#id
selector1, selectorN, ...

Package

clog.

Source

clog-jquery.lisp.

Methods
Method: create-jquery ((obj clog-obj) jquery)
Generic Function: create-label (clog-obj &key content style hidden label-for class html-id auto-place)

Create a new clog-label as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-label ((obj clog-obj) &key content label-for style hidden class html-id auto-place)
Generic Function: create-legend (clog-obj &key content style hidden class html-id auto-place)

Create a new clog-legend as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-legend ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-linear-gradient (clog-context2d x0 y0 x1 y1)

Create linear gradient

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-linear-gradient ((obj clog-context2d) x0 y0 x1 y1)
Generic Function: create-list-item (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-List-Item as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-list-item ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-lookup (clog-obj &key name multiple label class html-id clog-database)

Create a new clog-lookup as child of CLOG-OBJ.

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: create-lookup ((obj clog-obj) &key clog-database name multiple label class html-id)
Generic Function: create-matrix (clog-canvas &key matrix)

Create a new CLOG-Matrix. MATRIX can be json array 6 element for 2d or 16 for 3d.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-matrix ((obj clog-canvas) &key matrix)
Generic Function: create-meter (clog-obj &key value high low maximum minimum optimum style hidden class html-id auto-place)

Create a new CLOG-Meter as child of CLOG-OBJ with VALUE
(default 0) HIGH (default 100) LOW (default 0) MAXIMUM (default 100) MINIMUM (default 0) OPTIMUM (default 50) and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-meter ((obj clog-obj) &key value high low maximum minimum optimum style hidden class html-id auto-place)
Generic Function: create-one-row (clog-obj &key clog-database hidden class html-id auto-place)

Create a new CLOG-One-Row element. If CLOG-OBJ is
of type-of CLOG-DATABASE it is used as database source unless :CLOG-DATABASE is set.

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: create-one-row ((obj clog-obj) &key clog-database hidden class html-id auto-place)
Generic Function: create-optgroup (clog-obj &key content disabled style hidden class html-id auto-place)

Create a new clog-optgroup as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-optgroup ((obj clog-obj) &key content disabled style hidden class html-id auto-place)
Generic Function: create-option (clog-obj &key content value selected disabled style hidden class html-id auto-place)

Create a new clog-option as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-option ((obj clog-obj) &key content value selected disabled style hidden class html-id auto-place)
Generic Function: create-ordered-list (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Ordered-List as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-ordered-list ((obj clog-obj) &key hidden style class html-id auto-place)
Generic Function: create-p (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-P as child of CLOG-OBJ with :CONTENT (default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-p ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-panel (clog-obj &key left top right bottom width height units margin-left margin-top margin-right margin-bottom border-style border-width border-color background-color positioning overflow resizable content style hidden class html-id auto-place display)

Create a new CLOG-Panel as child of
CLOG-OBJ. Optionally you can set the :X, :Y, :WIDTH and :HEIGHT (in :UNITS defulting to :px, if set to nil unit type must be provided for x,y,width and height), BORDER-STYLE (see BORDER-STYLE-TYPE), BORDER-WIDTH, BORDER-COLOR, :POSITIONING (default is :FIXED the default builder panels are :STATIC) (see POSITIONING-TYPE), :OVERFLOW (default is :CLIP) with :CONTENT (default "") and :RESIZABLE defaults to :NONE. Additional css styles can be set in :STYLE (default "") if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil. Resizable only works if overflow is set to :SCROLL

Package

clog.

Source

clog-panel.lisp.

Methods
Method: create-panel ((obj clog-obj) &key left top right bottom width height units margin-left margin-top margin-right margin-bottom border-style border-width border-color background-color positioning overflow display resizable content style hidden class html-id auto-place)
Generic Function: create-panel-box (clog-obj &key width height hidden class html-id auto-place)

Create a new CLOG-Panel-Box, a div containg a
CLOG-PANEL-BOX-LAYOUT as child of CLOG-OBJ with and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil.

Package

clog.

Source

clog-panel.lisp.

Methods
Method: create-panel-box ((obj clog-obj) &key width height hidden class html-id auto-place)
Generic Function: create-path2d (clog-canvas &key path2d)

Create a new CLOG-Path2d. If CLOG-PATH2D creates a copy.

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-path2d ((obj clog-canvas) &key path2d)
Generic Function: create-pattern (clog-context2d clog-obj repetition)

Create pattern

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-pattern ((obj clog-context2d) clog-obj repetition)
Generic Function: create-phrase (clog-obj phrase &key content style hidden class html-id auto-place)

Create a new CLOG-Phrase of phrase type as child of
CLOG-OBJ with CONTENT and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

PHRASE-TYPE -
:abbr :code :strong :em :dfn :samp :kbd :var
:marked :del :ins :s :q :big :small :time :tt :cite
:i :b :u :sub :su :center

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-phrase ((obj clog-obj) phrase &key content style hidden class html-id auto-place)
Generic Function: create-program (clog-webgl)

Create a clog-webgl-program

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-program ((obj clog-webgl))
Generic Function: create-progress-bar (clog-obj &key value maximum style hidden class html-id auto-place)

Create a new CLOG-Progress-Bar as child of CLOG-OBJ with
VALUE (default 0) MAXIMUM (default 100) and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-progress-bar ((obj clog-obj) &key value maximum style hidden class html-id auto-place)
Generic Function: create-radial-gradient (clog-context2d x0 y0 r0 x1 y1 r1)

Create radial gradient

Package

clog.

Source

clog-canvas.lisp.

Methods
Method: create-radial-gradient ((obj clog-context2d) x0 y0 r0 x1 y1 r1)
Generic Function: create-section (clog-obj section &key content style hidden class html-id auto-place)

Create a new CLOG-Section of section type as child of
CLOG-OBJ with CONTENT and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ.

SECTION-TYPE -
:address :article :aside :header :main :nav
:p :pre :section :blockquote :h1 :h2 :h3 :h4 :h5 :h6
:hgroup

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-section ((obj clog-obj) section &key content style hidden class html-id auto-place)
Generic Function: create-select (clog-obj &key name multiple label style hidden class html-id auto-place)

Create a new clog-select as child of CLOG-OBJ. Use SIZE and set to greater than 1 for select to act as a listbox.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-select ((obj clog-obj) &key name multiple label style hidden class html-id auto-place)
Generic Function: create-shader (clog-webgl glenum-type)

Create a clog-webgl-shader for type :GLENUM.
See https://github.com/KhronosGroup/WebGL/blob/main/specs/latest/2.0/webgl2.idl For :GLENUM values

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-shader ((obj clog-webgl) glenum-type)
Generic Function: create-span (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Span as child of CLOG-OBJ with CONTENT
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. A span is an inline element while a div is a block element (one that takes up the entire browser width).

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-span ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-style-block (clog-obj &key content media html-id auto-place)

Ideally style blocks should be created in the (head body)
clog-element but can be placed anywhere on a document and are applied as found in the document. Although they are not ’scoped’. Media is a css media query defaulting to all. To load CSS style sheets from files see LOAD-CSS in clog-document. The add-style method can be used or can directly use the TEXT method to access blocks content.

Package

clog.

Source

clog-style.lisp.

Methods
Method: create-style-block ((obj clog-obj) &key content media html-id auto-place)
Generic Function: create-summary (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Summary as child of CLOG-OBJ with :CONTENT
(default "") and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ. If hidden is true visiblep is set to nil. Use inside a CLOG-DETAILS object for drop reveal.

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-summary ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-table (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-table-body (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table-Body as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-body ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-table-caption (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Table-Caption as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-caption ((obj clog-obj) &key content style hidden class html-id auto-place)
Generic Function: create-table-column (clog-obj &key content column-span row-span style hidden class html-id auto-place)

Create a new CLOG-Table-Column as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-column ((obj clog-obj) &key content column-span row-span style hidden class html-id auto-place)
Generic Function: create-table-column-group (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table-Column-Group as child of CLOG-OBJ and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-column-group ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-table-column-group-item (clog-obj &key column-span style hidden class html-id auto-place)

Create a new CLOG-Table-Column-Group-Item as child of CLOG-OBJ and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-column-group-item ((obj clog-obj) &key column-span style hidden class html-id auto-place)
Generic Function: create-table-footer (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table-Footer as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-footer ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-table-head (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table-Head as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-head ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-table-heading (clog-obj &key content column-span row-span style hidden class html-id auto-place)

Create a new CLOG-Table-Heading as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-heading ((obj clog-obj) &key content column-span row-span style hidden class html-id auto-place)
Generic Function: create-table-row (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Table-Row as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-table-row ((obj clog-obj) &key style hidden class html-id auto-place)
Generic Function: create-term (clog-obj &key content style hidden class html-id auto-place)

Create a new CLOG-Term as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-term ((obj clog-obj) &key style hidden content class html-id auto-place)
Generic Function: create-text-area (clog-obj &key columns rows name value label style hidden class html-id auto-place)

Create a new clog-text-area as child of CLOG-OBJ.

Package

clog.

Source

clog-form.lisp.

Methods
Method: create-text-area ((obj clog-obj) &key columns rows name value label style hidden class html-id auto-place)
Generic Function: create-unordered-list (clog-obj &key style hidden class html-id auto-place)

Create a new CLOG-Unordered-List as child of CLOG-OBJ
and if :AUTO-PLACE (default t) place-inside-bottom-of CLOG-OBJ

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: create-unordered-list ((obj clog-obj) &key hidden style class html-id auto-place)
Generic Function: create-vertex-array (clog-webgl)

Create a clog-webgl-vertex-array

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-vertex-array ((obj clog-webgl))
Generic Function: create-video (clog-obj &key source controls preload poster autoplay autoloop muted html-id auto-place)

Create a CLOG video control

Package

clog.

Source

clog-multimedia.lisp.

Methods
Method: create-video ((obj clog-obj) &key source controls preload poster autoplay autoloop muted html-id auto-place)
Generic Function: create-web-auto-column (clog-obj &key content vertical-align hidden class html-id)

Create a clog-web-auto-column. Container for auto-columns
If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-auto-column ((obj clog-obj) &key content vertical-align hidden class html-id)
Generic Function: create-web-auto-row (clog-obj &key hidden class html-id)

Create a clog-web-auto-row. Container for auto-columns
If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-auto-row ((obj clog-obj) &key hidden class html-id)
Generic Function: create-web-code (clog-obj &key content hidden class html-id)

Create a clog-web-code. Code content container.
If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-code ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-compositor (clog-obj &key content hidden class html-id)

Create a clog-web-compositor. Allows compositing of content
on top of other content. Content is added as children and then composit-location is called on the object of that content. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-compositor ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-container (clog-obj &key content column-size hidden class html-id)

Create a clog-web-container. COLUMN-SIZE can be of type container-size-type when to set size displayed on medium and large screens or can use a string of "s1-12 m1-12 l1-12" s m or l followed by how many columns this container uses on small, medium or large screens. Small screens are always displayed full row. Total columns must add to 12 or one needs to be of type :w3-rest to fill space. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-container ((obj clog-obj) &key content column-size hidden class html-id)
Generic Function: create-web-content (clog-obj &key content maximum-width hidden class html-id)

Create a clog-web-content. General container with 16px left
and right padding. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-content ((obj clog-obj) &key content maximum-width hidden class html-id)
Generic Function: create-web-main (clog-obj &key content hidden class html-id)

Create a clog-web-main. Container for main content
when using a collapsable sidebar or other whole page shifting technique. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-main ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-menu-bar (clog-obj &key class html-id)

Attach a menu bar to a CLOG-OBJ generally a clog-body.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-menu-bar ((obj clog-obj) &key class html-id)
Generic Function: create-web-menu-drop-down (clog-web-menu-bar &key content class html-id)

Attached a menu bar drop-down to a CLOG-WEB-MENU-BAR

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-menu-drop-down ((obj clog-web-menu-bar) &key content class html-id)
Generic Function: create-web-menu-full-screen (clog-web-menu-bar &key html-id)

Add as last item in menu bar to allow for a full screen icon ⤢ and full screen mode.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-menu-full-screen ((obj clog-web-menu-bar) &key html-id)
Generic Function: create-web-menu-icon (clog-web-menu-bar &key image-url on-click class html-id)

Add icon as menu bar item.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-menu-icon ((obj clog-web-menu-bar) &key image-url on-click class html-id)
Generic Function: create-web-menu-item (clog-web-menu-drop-down &key content link on-click class html-id)

Attached a menu item to a CLOG-WEB-MENU-DROP-DOWN. Use to set a link or on-click to set an on-click handler

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-menu-item ((obj clog-obj) &key content link on-click class html-id)
Generic Function: create-web-page (clog-obj page properties &key authorize)

Use the clog-web-site THEME to create PAGE with
CLOG-OBJ as parent. PAGE is a symbol to identify the pages purpose to the website theme. Themes are required to provide certain default pages see clog-web-themes file. If AUTHORIZE then PAGE is used also as a CLOG-Auth action to be checked if the current users roles have permission to PAGE

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-page ((obj clog-obj) page properties &key authorize)
Generic Function: create-web-panel (clog-obj &key content hidden class html-id)

Create a clog-web-panel. General container with 16px left
and right padding and 16x top and bottom margin. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-panel ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-row (clog-obj &key padding hidden class html-id)

Create a clog-web-row. If padding is true 8px left and
right padding is addded. If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-row ((obj clog-obj) &key padding hidden class html-id)
Generic Function: create-web-sidebar (clog-obj &key content hidden class html-id)

Create a clog-web-sidebar. Container for sidebar content.
sidebars are create with the display property set to :none if hidden it t and :block if nil. In general the visiblep property is used in clog, however in clog-web-sidebar the block property is needed to activate its animations if used. If using a sidebar that will take space and not collapse, make sure to set the sidebar’s size and set a margin equal to the size on the main container.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-sidebar ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-sidebar-item (clog-obj &key content hidden class html-id)

Create a clog-web-sidebar-item. A sidebar menu bar item.
If hidden is t then then the visiblep propetery will be set to nil on creation.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-sidebar-item ((obj clog-obj) &key content hidden class html-id)
Generic Function: create-web-site (clog-obj &key settings profile roles theme url title footer logo)

Attach a clog-web-site to a CLOG-OBJ generally a clog-body.

Package

clog-web.

Source

clog-web.lisp.

Methods
Method: create-web-site ((obj clog-obj) &key settings profile roles theme url title footer logo)
Generic Function: create-webgl (clog-canvas &key context)

Create a new CLOG-WebGL from a CLOG-Canvas. Context can be webgl (version 1) or webgl2 (default)

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-webgl ((obj clog-canvas) &key context)
Generic Function: create-webgl-buffer (clog-webgl &key bind-type)

Create a clog-webgl-buffer. If BIND-TYPE
is set binds the buffer to either :ARRAY_BUFFER or :ELEMENT_ARRAY_BUFFER in WebGL2 the following added:
:COPY_READ_BUFFER : Buffer for copying from one buffer object to another. :COPY_WRITE_BUFFER : Buffer for copying from one buffer object to another. :TRANSFORM_FEEDBACK_BUFFER : Buffer for transform feedback operations. :UNIFORM_BUFFER : Buffer used for storing uniform blocks. :PIXEL_PACK_BUFFER : Buffer used for pixel transfer operations. :PIXEL_UNPACK_BUFFER : Buffer used for pixel transfer operations.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-webgl-buffer ((obj clog-webgl) &key bind-type)
Generic Function: create-webgl-frame-buffer (clog-webgl &key bind-type)

Create a clog-webgl-frame-buffer. If BIND-TYPE
is set binds the frame-buffer to :FRAMEBUFFER in WebGL2 the following are added:
:DRAW_FRAMEBUFFER : Used as a destination for drawing operations such as draw*, clear* and blit-frame-buffer.
:READ_FRAMEBUFFER : Used as a source for reading operations such as readPixels and blit-frame-buffer.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-webgl-frame-buffer ((obj clog-webgl) &key bind-type)
Generic Function: create-webgl-render-buffer (clog-webgl &key bind-type)

Create a clog-webgl-render-buffer. If BIND-TYPE is set binds the render-buffer to :RENDERBUFFER

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-webgl-render-buffer ((obj clog-webgl) &key bind-type)
Generic Function: create-webgl-texture (clog-webgl &key bind-type)

Create a clog-webgl-texture. If BIND-TYPE
is set binds the texture to:
:TEXTURE_2D : A two-dimensional texture. :TEXTURE_CUBE_MAP : A cube-mapped texture.
in WebGL 2 also:
:TEXTURE_3D : A three-dimensional texture. :TEXTURE_2D_ARRAY : A two-dimensional array texture.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: create-webgl-texture ((obj clog-webgl) &key bind-type)
Generic Function: css-class-name (clog-element)

Get/Setf css-class-name. CSS Class name, can be multiple
seperated by <space>. See add-class, remove-class and toggle-class methods for adding and removing individual or groups of classes in an easier way.

Package

clog.

Source

clog-element.lisp.

Methods
Method: css-class-name ((obj clog-element))
Generic Function: (setf css-class-name) (clog-element)

Set css-class-name VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf css-class-name) ((obj clog-element))
Generic Function: current-window (clog-obj)

Get the current selected clog-gui-window

Package

clog-gui.

Source

clog-gui.lisp.

Methods
Method: current-window ((obj clog-obj))
Generic Function: cursor (clog-element)

Get/Setf cursor. Sets the cursor to a standard type or an
image if set to url(url_to_image). When using a url is best to suggest an alternate cursor, e.g. ’url(url_to_image),auto’
A list of standard cursor types can be found at: http://www.w3schools.com/cssref/pr_class_cursor.asp

Package

clog.

Source

clog-element.lisp.

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

Set cursor VALUE for CLOG-ELEMENT

Package

clog.

Source

clog-element.lisp.

Methods
Method: (setf cursor) ((obj clog-element))
Generic Reader: database-connection (clog-database)

Accessor to the database handle

Package

clog.

Source

clog-dbi.lisp.

Methods
Reader Method: database-connection ((clog-database clog-database))

Connection handle to database

Target Slot

connection.

Generic Writer: (setf database-connection) (object)
Package

clog.

Methods
Writer Method: (setf database-connection) ((clog-database clog-database))

Connection handle to database

Source

clog-dbi.lisp.

Target Slot

connection.

Generic Function: default-value (clog-form-element)

Get/Setf form element default-value.
If the form is reset the value will be set to default value
If Value is set at time of creation it also sets it as the Default_Value

Package

clog.

Source

clog-form.lisp.

Methods
Method: default-value ((obj clog-form-element))
Generic Function: (setf default-value) (clog-form-element)

Set default-value VALUE for CLOG-FORM-ELEMENT

Package

clog.

Source

clog-form.lisp.

Methods
Method: (setf default-value) ((obj clog-form-element))
Generic Function: delete-buffer (obj)
Package

clog-webgl.

Methods
Method: delete-buffer ((obj clog-webgl-buffer))
Source

clog-webgl.lisp.

Generic Function: delete-frame-buffer (obj)
Package

clog-webgl.

Methods
Method: delete-frame-buffer ((obj clog-webgl-frame-buffer))
Source

clog-webgl.lisp.

Generic Function: delete-multipart-data (clog-obj)

Delete the multipart data upload

Package

clog.

Source

clog-form.lisp.

Methods
Method: delete-multipart-data ((obj clog-obj))
Generic Function: delete-program (obj)
Package

clog-webgl.

Methods
Method: delete-program ((obj clog-webgl-program))
Source

clog-webgl.lisp.

Generic Function: delete-render-buffer (obj)
Package

clog-webgl.

Methods
Method: delete-render-buffer ((obj clog-webgl-render-buffer))
Source

clog-webgl.lisp.

Generic Function: delete-row (clog-one-row panel)

Delete a row from a database table based on current rowid and then call CLEAR-ROW

Package

clog.

Source

clog-dbi.lisp.

Methods
Method: delete-row ((obj clog-one-row) panel)
Generic Function: delete-shader (obj)
Package

clog-webgl.

Methods
Method: delete-shader ((obj clog-webgl-shader))
Source

clog-webgl.lisp.

Generic Function: delete-texture (obj)
Package

clog-webgl.

Methods
Method: delete-texture ((obj clog-webgl-texture))
Source

clog-webgl.lisp.

Generic Function: delete-vertex-array (obj)
Package

clog-webgl.

Methods
Method: delete-vertex-array ((obj clog-webgl-vertex-array))
Source

clog-webgl.lisp.

Generic Function: depth-function (clog-webgl glenum-func)

Specifies a function that compares incoming pixel depth to
the current depth buffer value. GLENUM-FUNC can be:
:NEVER (never pass)
:LESS (pass if the incoming value is less than the depth buffer value)
:EQUAL (pass if the incoming value equals the depth buffer value)
:LEQUAL (pass if the incoming value is less than or equal to the depth buffer value) :GREATER (pass if the incoming value is greater than the depth buffer value) :NOTEQUAL (pass if the incoming value is not equal to the depth buffer value) :GEQUAL (pass if the incoming value is greater than or equal to the depth buffer value) :ALWAYS (always pass)

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: depth-function ((obj clog-webgl) glenum-func)
Generic Function: depth-mask (clog-webgl enablep)

Specifying whether or not writing into the depth buffer is enabled

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: depth-mask ((obj clog-webgl) enablep)
Generic Function: depth-range (clog-webgl znear zfar)

Specifies the depth range mapping from normalized device coordinates to window or viewport coordinates.

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: depth-range ((obj clog-webgl) znear zfar)
Generic Function: destroy (clog-element)

Remove CLOG-Element from the DOM on browser and clog cache on browser.

Package

clog.

Source

clog-element.lisp.

Methods
Method: destroy ((obj clog-element))
Generic Function: destroy-children (clog-element)

Destroy all children in DOM contained with in CLOG-ELEMENT
and run a BROWSER-GC. See also clog-connect:*browser-gc-on-ping* if using this often.

Package

clog.

Source

clog-element.lisp.

Methods
Method: destroy-children ((obj clog-element))
Generic Function: detach-shader (clog-webgl-program clog-webgl-shader)

Detaches a CLOG-WEBGL-SHADER

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: detach-shader ((obj clog-webgl-program) (shader clog-webgl-shader))
Generic Function: details-openp (clog-details)

Get/Setf details-openp. Will show details

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: details-openp ((obj clog-details))
Generic Function: (setf details-openp) (clog-details)

Set details-openp VALUE for CLOG-DETAILS

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: (setf details-openp) ((obj clog-details))
Generic Function: dialog-openp (clog-dialog)

Get/Setf dialog-openp. Will show dialog

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: dialog-openp ((obj clog-dialog))
Generic Function: (setf dialog-openp) (clog-dialog)

Set dialog-openp VALUE for CLOG-DIALOG

Package

clog.

Source

clog-element-common.lisp.

Methods
Method: (setf dialog-openp) ((obj clog-dialog))
Generic Function: disable-capability (clog-webgl glenum-capability)

Disables specific WebGL capabilities for this context.
For GLENUM-CAPABILITY see: https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/disable

Package

clog-webgl.

Source

clog-webgl.lisp.

Methods
Method: disable-capability ((obj clog-webgl) glenum-capability)
Generic Function: disable-resize (clog-text-area)

Disable resize of text area.

Package

clog.

Source

clog-form.lisp.

Methods