`controlcl` package

<< back to controlcl index

Exported symbols:

Variables

`controlcl`

The global controlcl instance.

This should be created with WITH-CONTROLCL macro.

`current-theme`

The current theme.

`theme-a`

`theme-grey`

`theme-red`

`theme-cp5blue`

`theme-cp52014`

`theme-retro`

`colors`

A list of colors with their hexadecimal codes.

Functions

`controlcl-move-to`

`controlcl-mouse-over`

`controlcl-add-image`

`controlcl-add-slider`

`controlcl-add-checkbox`

`controlcl-add-bang`

`controlcl-get-ctrl`

get the CTRL from CONTROLCL with the id

`controlcl-hide`

`controlcl-show`

`controlcl-draw`

`set-color-from-theme`

Set the color from the CURRENT-THEME or THEME when given.

`set-color-from-code`

Set the color from a hexadecimal code, like #xFF0000FF.: The order is a r g b.

`set-color-from-palette`

Set a color from a palette of colors.

`color-values`

Return the encoded alpha, red, green, blue values of a color

`theme-value-color`

Return the value color of the CURRENT-THEME or optionally given THEME.

`theme-caption-color`

Return the caption color of the CURRENT-THEME or optionally given THEME.

`theme-active-color`

Return the active color of the CURRENT-THEME or optionally given THEME.

`theme-bg-color`

Return the background color of the CURRENT-THEME or optionally given THEME.

`theme-fg-color`

Return the foreground color of the CURRENT-THEME or optionally given THEME.

`controlcl-version`

Return the version of the controlcl library

`controlcl-init`

Initialize the controlcl library

`v-factor`

Return a value between 0 and 1, expressing the relation of value to min-v and max-v.

`point-in-rect`

Return true if the point x1,y1 is inside the rectangle x,y,w,h

Macros

`with-controlcl`

`with-theme`

Used to dynamically bind the CURRENT-THEME variable to the given theme.

Generic Functions

`controlcl-emit-event`

`controller-set-mouse-over-color`

decide if the active or foreground color should be returned

`controller-mouse-over-p`

return T if the point x,y is over the controller

`controller-move-to`

move the controller to the position x,y

`controller-hide`

Hide the controller. By default it sets the VISIBLE flag to NIL, unless the STICKY flag for the controller is set.

`controller-show`

show the controller. By default it sets the VISIBLE flag to T.

`controller-draw`

draw the controller to the renderer

`on-event`

`render-text`

Render text at x,y

Classes

`controlcl`

ControlCL main class.

An instance holds references to all controllers and is reponsible for delegating events to them.

`checkbox`

`slider`

`bang`

`controller`

A controller is a visual element that can be drawn and interacted with.

`event-value`

A value event is an event that is generated by a value changing.

`event-key`

A key event is an event that is generated by the keyboard.

`event-mouse-clicked`

A mouse clicked event is an event that is generated by the mouse when a button is clicked.

`event-mouse`

A mouse event is an event that is generated by the mouse.

`event`

An event is a message sent from one object to another. If the target is nil the event is considered to be a broadcast event.

controlcl package

`controlcl` package