The caveman2-widgets-bootstrap Reference Manual

Table of Contents

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

The caveman2-widgets-bootstrap Reference Manual

This is the caveman2-widgets-bootstrap Reference Manual, version 0.2, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:01:50 2018 GMT+0.


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

1 Introduction

* Caveman2-Widgets-Bootstrap 
This is an extension to [[https://github.com/ritschmaster/caveman2-widgets][caveman2-widgets]]. It supplies widgets which are using
[[https://getbootstrap.com/][Bootstrap]]. Before you start using it you may have a look at the [[https://github.com/ritschmaster/caveman2-widgets#usage][basic usage
documentation]] to understand how to use those (extra) widgets.

** Installation
You can load it through Quicklisp or you can use the git repository. To use the
git repository clone it into "~/quicklisp/local-projects" or (if you are using
[[https://github.com/roswell/roswell][Roswell]]) "~/.roswell/local-projects".

To QUICKLOAD it, use:
#+BEGIN_SRC lisp
(ql:quickload :caveman2-widgets-bootstrap)
#+END_SRC

** Contributions
You are very welcomed to contribute to this project! You can contribute by:
- Using it and spreading the word!
- Finding flaws and submitting [[https://github.com/ritschmaster/caveman2-widgets/issues][Issues]].
- Finding flaws and removing them (as [[https://github.com/ritschmaster/caveman2-widgets/pulls][Pull-requests]]).
- Adding new features (as [[https://github.com/ritschmaster/caveman2-widgets/pulls][Pull-requests]]). Before shooting in the dark
  create either an [[https://github.com/ritschmaster/caveman2-widgets/issues][Issues]] or mail me. Maybe your feature is on my
  agenda too.
- Showing your appreciation through a donation (please mail me for my
  data).

If you add new features, please document them. Otherwise other
developers will have a hard time using this framework.
** Usage
*** A new header widget
A new header widget is added which uses specific CDN links for getting
Bootstrap. Please notice, that the global variables, where you can
specify the locations, are not simple string variables! They are
 objects.
- *BOOTSTRAP-JS* :: Must be a  object.
- *BOOTSTRAP-CSS* :: Must be a  object.

*** Navigation widget
The navigation widget is fully redesigned for the use with
Bootstrap. The  has some special
slots:
- BRAND-TEXT :: A HTML code which will be displayed in the upper left
                corner.
- NAVBAR-FIXED :: A non-nil value will fix the navbar on the upper
                  edge.

You can use it fairly easy by just using
 as KIND for the DEFNAV macro:
#+BEGIN_SRC lisp
(defvar *first-widget*
  (make-widget :global '
               :text "

Hello world from first

")) (defvar *second-widget* (make-widget :global ' :text "

Hello world from second

")) (defclass () () (:documentation "This class enables session based widgets for a navigation.")) (defmethod render-widget ((this )) (set-widget-for-session :string-widget (make-widget :session ' :text "hello world")) (render-widget (get-widget-for-session :string-widget))) (defnav "/" ((make-instance ' :title "Navigation test") (list (list "First widget" "first" *first-widget*) (list "Second widget" "second" *second-widget*) (list "Third widget" "third" (make-widget :global '))) :kind ')) #+END_SRC If you need extra header objects, you can create them via the RENDER-WIDGET-HEADER method. This means you only have to overwrite it for your own navigation class. #+BEGIN_SRC lisp (defvar *first-widget* (make-widget :global ' :text "

Hello world from first

")) (defvar *second-widget* (make-widget :global ' :text "

Hello world from second

")) (defclass () () (:default-initargs :brand-text "
" :navbar-fixed t)) (defmethod caveman2-widgets-bootstrap.navigation::render-widget-header ((this ) (args (eql :right))) (with-output-to-string (ret-val) (format ret-val "" (let ((link (make-widget :global ' :label "GitHub" :callback #'(lambda () "http://github.com/ritschmaster") :target-foreign-p t))) (uri-path link))))) (defnav "/" ((make-instance ' :title "Navigation test") (list (list "First widget" "first" *first-widget*) (list "Second widget" "second" *second-widget*)) :kind ')) #+END_SRC ** Author + Richard Paul Bäck (richard.baeck@free-your-pc.com) ** Copyright Copyright (c) 2016 Richard Paul Bäck (richard.baeck@free-your-pc.com) ** License Licensed under the LLGPL License.

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

2 Systems

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


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

2.1 caveman2-widgets-bootstrap

Author

Richard Paul Bäck

License

LLGPL

Description

An extension to caveman2-widgets which enables the simple usage of Twitter Bootstrap.

Version

0.2

Dependencies
Source

caveman2-widgets-bootstrap.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 caveman2-widgets-bootstrap/src

Parent

caveman2-widgets-bootstrap (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 caveman2-widgets-bootstrap.asd

Location

caveman2-widgets-bootstrap.asd

Systems

caveman2-widgets-bootstrap (system)


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

4.1.2 caveman2-widgets-bootstrap/src/widget.lisp

Parent

src (module)

Location

src/widget.lisp

Packages

caveman2-widgets-bootstrap.widget

Exported Definitions

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

4.1.3 caveman2-widgets-bootstrap/src/callback-widgets.lisp

Parent

src (module)

Location

src/callback-widgets.lisp

Packages

caveman2-widgets-bootstrap.callback-widgets

Exported Definitions
Internal Definitions

*default-button-class* (special variable)


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

4.1.4 caveman2-widgets-bootstrap/src/document.lisp

Parent

src (module)

Location

src/document.lisp

Packages

caveman2-widgets-bootstrap.document

Exported Definitions

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

4.1.5 caveman2-widgets-bootstrap/src/navigation.lisp

Parent

src (module)

Location

src/navigation.lisp

Packages

caveman2-widgets-bootstrap.navigation

Exported Definitions

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

4.1.6 caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap.lisp

Parent

src (module)

Location

src/caveman2-widgets-bootstrap.lisp

Packages

caveman2-widgets-bootstrap


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

5 Packages

Packages are listed by definition order.


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

5.1 caveman2-widgets-bootstrap.widget

Source

widget.lisp (file)

Use List

common-lisp

Used By List
Exported Definitions

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

5.2 caveman2-widgets-bootstrap.callback-widgets

Source

callback-widgets.lisp (file)

Use List
Used By List

caveman2-widgets-bootstrap

Exported Definitions
Internal Definitions

*default-button-class* (special variable)


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

5.3 caveman2-widgets-bootstrap.document

Source

document.lisp (file)

Use List
Used By List

caveman2-widgets-bootstrap

Exported Definitions

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

5.4 caveman2-widgets-bootstrap.navigation

Source

navigation.lisp (file)

Use List
Used By List

caveman2-widgets-bootstrap

Exported Definitions

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

5.5 caveman2-widgets-bootstrap

Source

caveman2-widgets-bootstrap.lisp (file)

Use List

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

6 Definitions

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


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

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *application-root*
Package

caveman2-widgets-bootstrap.widget

Source

widget.lisp (file)

Special Variable: *bootstrap-css*
Package

caveman2-widgets-bootstrap.document

Source

document.lisp (file)

Special Variable: *bootstrap-js*
Package

caveman2-widgets-bootstrap.document

Source

document.lisp (file)

Special Variable: *js-directory*
Package

caveman2-widgets-bootstrap.widget

Source

widget.lisp (file)

Special Variable: *static-directory*
Package

caveman2-widgets-bootstrap.widget

Source

widget.lisp (file)

Special Variable: *widgets-js-filename*

The filename of the JavaScript file which manages all bootstrap widget functionality.

Package

caveman2-widgets-bootstrap.widget

Source

widget.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Generic functions

Generic Function: brand-text OBJECT
Generic Function: (setf brand-text) NEW-VALUE OBJECT
Package

caveman2-widgets-bootstrap.navigation

Methods
Method: brand-text (<BOOTSTRAP-MENU-NAVIGATION-WIDGET> <bootstrap-menu-navigation-widget>)
Method: (setf brand-text) NEW-VALUE (<BOOTSTRAP-MENU-NAVIGATION-WIDGET> <bootstrap-menu-navigation-widget>)

This can be HTML too.

Source

navigation.lisp (file)

Generic Function: kind OBJECT
Generic Function: (setf kind) NEW-VALUE OBJECT
Package

caveman2-widgets-bootstrap.callback-widgets

Methods
Method: kind (<BOOTSTRAP-BUTTON-WIDGET> <bootstrap-button-widget>)

The button kind. Available keywords: - :default
- :primary
- :success
- :info
- :warning
- :danger

Source

callback-widgets.lisp (file)

Method: (setf kind) VALUE (THIS <bootstrap-button-widget>)
Source

callback-widgets.lisp (file)

Generic Function: navbar-fixed OBJECT
Generic Function: (setf navbar-fixed) NEW-VALUE OBJECT
Package

caveman2-widgets-bootstrap.navigation

Methods
Method: navbar-fixed (<BOOTSTRAP-MENU-NAVIGATION-WIDGET> <bootstrap-menu-navigation-widget>)

automatically generated reader method

Source

navigation.lisp (file)

Method: (setf navbar-fixed) NEW-VALUE (<BOOTSTRAP-MENU-NAVIGATION-WIDGET> <bootstrap-menu-navigation-widget>)

automatically generated writer method

Source

navigation.lisp (file)

Generic Function: render-widget-header THIS ARGS
Package

caveman2-widgets-bootstrap.navigation

Source

navigation.lisp (file)

Methods
Method: render-widget-header (THIS <bootstrap-menu-navigation-widget>) (ARGS (eql right))
Method: render-widget-header (THIS <bootstrap-menu-navigation-widget>) (ARGS (eql middle))
Method: render-widget-header (THIS <bootstrap-menu-navigation-widget>) (ARGS (eql left))

Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Classes

Class: <bootstrap-button-widget> ()
Package

caveman2-widgets-bootstrap.callback-widgets

Source

callback-widgets.lisp (file)

Direct superclasses

<button-widget> (class)

Direct methods
  • kind (method)
  • initialize-instance (method)
  • kind (method)
Direct slots
Slot: kind

The button kind. Available keywords: - :default
- :primary
- :success
- :info
- :warning
- :danger

Initargs

:kind

Initform

:default

Readers

kind (generic function)

Writers

(setf kind) (generic function)

Class: <bootstrap-header-widget> ()
Package

caveman2-widgets-bootstrap.document

Source

document.lisp (file)

Direct superclasses

<header-widget> (class)

Direct methods

initialize-instance (method)

Direct Default Initargs
InitargValue
:other-header-content(list "<meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">")
Class: <bootstrap-menu-navigation-widget> ()
Package

caveman2-widgets-bootstrap.navigation

Source

navigation.lisp (file)

Direct superclasses

<menu-navigation-widget> (class)

Direct methods
Direct slots
Slot: brand-text

This can be HTML too.

Initargs

:brand-text

Initform

""

Readers

brand-text (generic function)

Writers

(setf brand-text) (generic function)

Slot: navbar-fixed
Initargs

:navbar-fixed

Readers

navbar-fixed (generic function)

Writers

(setf navbar-fixed) (generic function)


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

6.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Special variables

Special Variable: *default-button-class*
Package

caveman2-widgets-bootstrap.callback-widgets

Source

callback-widgets.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
caveman2-widgets-bootstrap.asd: The caveman2-widgets-bootstrap<dot>asd file
caveman2-widgets-bootstrap/src: The caveman2-widgets-bootstrap/src module
caveman2-widgets-bootstrap/src/callback-widgets.lisp: The caveman2-widgets-bootstrap/src/callback-widgets<dot>lisp file
caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap.lisp: The caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap<dot>lisp file
caveman2-widgets-bootstrap/src/document.lisp: The caveman2-widgets-bootstrap/src/document<dot>lisp file
caveman2-widgets-bootstrap/src/navigation.lisp: The caveman2-widgets-bootstrap/src/navigation<dot>lisp file
caveman2-widgets-bootstrap/src/widget.lisp: The caveman2-widgets-bootstrap/src/widget<dot>lisp file

F
File, Lisp, caveman2-widgets-bootstrap.asd: The caveman2-widgets-bootstrap<dot>asd file
File, Lisp, caveman2-widgets-bootstrap/src/callback-widgets.lisp: The caveman2-widgets-bootstrap/src/callback-widgets<dot>lisp file
File, Lisp, caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap.lisp: The caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap<dot>lisp file
File, Lisp, caveman2-widgets-bootstrap/src/document.lisp: The caveman2-widgets-bootstrap/src/document<dot>lisp file
File, Lisp, caveman2-widgets-bootstrap/src/navigation.lisp: The caveman2-widgets-bootstrap/src/navigation<dot>lisp file
File, Lisp, caveman2-widgets-bootstrap/src/widget.lisp: The caveman2-widgets-bootstrap/src/widget<dot>lisp file

L
Lisp File, caveman2-widgets-bootstrap.asd: The caveman2-widgets-bootstrap<dot>asd file
Lisp File, caveman2-widgets-bootstrap/src/callback-widgets.lisp: The caveman2-widgets-bootstrap/src/callback-widgets<dot>lisp file
Lisp File, caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap.lisp: The caveman2-widgets-bootstrap/src/caveman2-widgets-bootstrap<dot>lisp file
Lisp File, caveman2-widgets-bootstrap/src/document.lisp: The caveman2-widgets-bootstrap/src/document<dot>lisp file
Lisp File, caveman2-widgets-bootstrap/src/navigation.lisp: The caveman2-widgets-bootstrap/src/navigation<dot>lisp file
Lisp File, caveman2-widgets-bootstrap/src/widget.lisp: The caveman2-widgets-bootstrap/src/widget<dot>lisp file

M
Module, caveman2-widgets-bootstrap/src: The caveman2-widgets-bootstrap/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   (  
B   G   K   M   N   R  
Index Entry  Section

(
(setf brand-text): Exported generic functions
(setf brand-text): Exported generic functions
(setf kind): Exported generic functions
(setf kind): Exported generic functions
(setf navbar-fixed): Exported generic functions
(setf navbar-fixed): Exported generic functions

B
brand-text: Exported generic functions
brand-text: Exported generic functions

G
Generic Function, (setf brand-text): Exported generic functions
Generic Function, (setf kind): Exported generic functions
Generic Function, (setf navbar-fixed): Exported generic functions
Generic Function, brand-text: Exported generic functions
Generic Function, kind: Exported generic functions
Generic Function, navbar-fixed: Exported generic functions
Generic Function, render-widget-header: Exported generic functions

K
kind: Exported generic functions
kind: Exported generic functions

M
Method, (setf brand-text): Exported generic functions
Method, (setf kind): Exported generic functions
Method, (setf navbar-fixed): Exported generic functions
Method, brand-text: Exported generic functions
Method, kind: Exported generic functions
Method, navbar-fixed: Exported generic functions
Method, render-widget-header: Exported generic functions
Method, render-widget-header: Exported generic functions
Method, render-widget-header: Exported generic functions

N
navbar-fixed: Exported generic functions
navbar-fixed: Exported generic functions

R
render-widget-header: Exported generic functions
render-widget-header: Exported generic functions
render-widget-header: Exported generic functions
render-widget-header: Exported generic functions

Jump to:   (  
B   G   K   M   N   R  

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

A.3 Variables

Jump to:   *  
B   K   N   S  
Index Entry  Section

*
*application-root*: Exported special variables
*bootstrap-css*: Exported special variables
*bootstrap-js*: Exported special variables
*default-button-class*: Internal special variables
*js-directory*: Exported special variables
*static-directory*: Exported special variables
*widgets-js-filename*: Exported special variables

B
brand-text: Exported classes

K
kind: Exported classes

N
navbar-fixed: Exported classes

S
Slot, brand-text: Exported classes
Slot, kind: Exported classes
Slot, navbar-fixed: Exported classes
Special Variable, *application-root*: Exported special variables
Special Variable, *bootstrap-css*: Exported special variables
Special Variable, *bootstrap-js*: Exported special variables
Special Variable, *default-button-class*: Internal special variables
Special Variable, *js-directory*: Exported special variables
Special Variable, *static-directory*: Exported special variables
Special Variable, *widgets-js-filename*: Exported special variables

Jump to:   *  
B   K   N   S  

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

A.4 Data types

Jump to:   <  
C   P   S  
Index Entry  Section

<
<bootstrap-button-widget>: Exported classes
<bootstrap-header-widget>: Exported classes
<bootstrap-menu-navigation-widget>: Exported classes

C
caveman2-widgets-bootstrap: The caveman2-widgets-bootstrap system
caveman2-widgets-bootstrap: The caveman2-widgets-bootstrap package
caveman2-widgets-bootstrap.callback-widgets: The caveman2-widgets-bootstrap<dot>callback-widgets package
caveman2-widgets-bootstrap.document: The caveman2-widgets-bootstrap<dot>document package
caveman2-widgets-bootstrap.navigation: The caveman2-widgets-bootstrap<dot>navigation package
caveman2-widgets-bootstrap.widget: The caveman2-widgets-bootstrap<dot>widget package
Class, <bootstrap-button-widget>: Exported classes
Class, <bootstrap-header-widget>: Exported classes
Class, <bootstrap-menu-navigation-widget>: Exported classes

P
Package, caveman2-widgets-bootstrap: The caveman2-widgets-bootstrap package
Package, caveman2-widgets-bootstrap.callback-widgets: The caveman2-widgets-bootstrap<dot>callback-widgets package
Package, caveman2-widgets-bootstrap.document: The caveman2-widgets-bootstrap<dot>document package
Package, caveman2-widgets-bootstrap.navigation: The caveman2-widgets-bootstrap<dot>navigation package
Package, caveman2-widgets-bootstrap.widget: The caveman2-widgets-bootstrap<dot>widget package

S
System, caveman2-widgets-bootstrap: The caveman2-widgets-bootstrap system

Jump to:   <  
C   P   S