membrane.ui — com.phronemophobic/membrane 0.9.8-beta

-default-mouse-move-global clj/s

(-default-mouse-move-global elem offset)

Arc clj/s

Bordered clj/s

bordered clj/s

(bordered padding drawable)

Graphical elem that will draw drawable with a gray border.

bordered-draw clj/s

(bordered-draw this)

bounds clj/s

(bounds elem)

Returns a 2 element vector with the [width, height] of an element's bounds with respect to its origin

box-contains? clj/s

(box-contains? [x y width height] [px py])

Tests whether [px py] is within [x y width height].

Button clj/s

button clj/s

(button text)

(button text on-click)

(button text on-click hover?)

Graphical elem that draws a button. Optional on-click function may be provided that is called with no arguments when button has a mouse-down event.

button-draw clj/s

(button-draw this)

center clj/s

(center elem [width height])

Checkbox clj/s

checkbox clj/s

(checkbox checked?)

Graphical elem that will draw a checkbox.

children clj/s

(children elem)

Returns sub elements of elem. Useful for traversal.

clipboard-copy clj/s

(clipboard-copy elem)

Returns the effects of a clipboard copy event on elem.

clipboard-cut clj/s

(clipboard-cut elem)

Returns the effects of a clipboard cut event on elem.

clipboard-paste clj/s

(clipboard-paste elem s)

Returns the effects of a clipboard paste event on elem.

copy-to-clipboard clj/s

(copy-to-clipboard s)

default-font clj/s

defcomponent clj/s macro

(defcomponent name [& fields] & opts+specs)

draw-checkbox clj/s

(draw-checkbox checked?)

EventHandler clj/s

fill-bordered clj/s

(fill-bordered color padding drawable)

Graphical elem that will draw elem with filled border.

fill-bordered-draw clj/s

(fill-bordered-draw this)

FillBordered clj/s

filled-rectangle clj/s

(filled-rectangle color width height)

Graphical elem that draws a filled rectangle with color, [r g b] or [r g b a].

font clj/s

(font name size)

Creates a font.

name: Should be the path to a font file on desktop. If nil, use the default font. size: Size of the font. If nil, use the default font size.

Font clj/s

group clj/s

(group & drawables)

Creates a graphical elem that will draw drawables in order

Group clj/s

height clj/s

(height elem)

Returns the height of elem.

horizontal-layout clj/s

(horizontal-layout & elems)

Returns a graphical elem of elems layed out next to eachother.

IBounds clj/s protocol

-bounds clj/s

(-bounds elem)

Returns a 2 element vector with the [width, height] of an element's bounds with respect to its origin

IBubble clj/s protocol

Allows an element add, remove, modify effects emitted from its children.

-bubble clj/s

(-bubble _ effects)

Called when an effect is being emitted by a child element. The parent element can either return the same effects or allow them to continue to bubble.

IChildren clj/s protocol

-children clj/s

(-children elem)

Returns sub elements of elem. Useful for traversal.

IClipboardCopy clj/s protocol

-clipboard-copy clj/s

(-clipboard-copy _)

IClipboardCut clj/s protocol

-clipboard-cut clj/s

(-clipboard-cut _)

IClipboardPaste clj/s protocol

-clipboard-paste clj/s

(-clipboard-paste this info)

IComponent clj/s protocol

IDraw clj/s protocol

draw clj/s

(draw this)

IHandleEvent clj/s protocol

-can-handle? clj/s

(-can-handle? this event-type)

-handle-event clj/s

(-handle-event this event-type event-args)

IHasKeyEvent clj/s protocol

has-key-event clj/s

(has-key-event this)

IHasKeyPress clj/s protocol

has-key-press clj/s

(has-key-press this)

IHasMouseMoveGlobal clj/s protocol

has-mouse-move-global clj/s

(has-mouse-move-global this)

IKeyEvent clj/s protocol

-key-event clj/s

(-key-event this key scancode action mods)

IKeyPress clj/s protocol

-key-press clj/s

(-key-press this info)

IKeyType clj/s protocol

-key-type clj/s

(-key-type this info)

image clj/s

(image image-path)

(image image-path [width height :as size])

(image image-path [width height :as size] opacity)

Graphical element that draws an image.

image-path: using the skia backend, image-path can be one of

• a string filename
• a java.net.URL This is useful for drawing images included in a jar. Simply put your image in your resources folder, typically resources. Draw the images in the jar with (ui/image (clojure.java.io/resource "filename.png"))

The image can be drawn at a different size by supplying a size. Supply a nil size will use the the original image size.

The image can be aspect scaled by supply a size with one of the dimensions as nil.

For example, to draw an image with width 30 with aspect scaling, (image "path.png" [30 nil])

opacity is a float between 0 and 1.

Allowable image formats may vary by platform, but will typically include png and jpeg.

Image clj/s

image-size clj/s≠

(image-size image-path)

clj

Returns the [width, height] of the file at image-path.

IMouseDown clj/s protocol

-mouse-down clj/s

(-mouse-down this info)

IMouseEvent clj/s protocol

-mouse-event clj/s

(-mouse-event this pos button mouse-down? mods)

IMouseMove clj/s protocol

-mouse-move clj/s

(-mouse-move this info)

IMouseMoveGlobal clj/s protocol

-mouse-move-global clj/s

(-mouse-move-global this info)

IMouseUp clj/s protocol

-mouse-up clj/s

(-mouse-up this info)

IMouseWheel clj/s protocol

-mouse-wheel clj/s

(-mouse-wheel this info)

index-for-position clj/s

(index-for-position font text x y)

IOrigin clj/s protocol

-origin clj/s

(-origin elem)

Specifies the top left corner of a component's bounds

The origin is vector or 2 numbers [x, y]

IScroll clj/s protocol

-scroll clj/s

(-scroll this info)

key-event clj/s

(key-event elem key scancode action mods)

Returns the effects of a key event on elem.

key-press clj/s

(key-press elem key)

Returns the effects of a key press event on elem.

label clj/s

(label text)

(label text font)

Graphical elem that can draw text.

label will use the default line spacing for newline. font should be a membrane.ui.Font

Label clj/s

make-event-handler clj/s

(make-event-handler protocol-name protocol protocol-fn)

maybe-key-event clj/s macro

(maybe-key-event test body)

memoize-var clj/s

(memoize-var f)

Returns a memoized version of a referentially transparent function. The memoized version of the function keeps a cache of the mapping from arguments to results and, when calls with the same arguments are repeated often, has higher performance at the expense of higher memory use.

mouse-down clj/s

(mouse-down elem [mx my :as pos])

Returns the effects of a mouse down event on elem. Will only call -mouse-event or -mouse-down if the position is in the element's bounds.

mouse-event clj/s

(mouse-event elem global-pos button mouse-down? mods)

(mouse-event elem global-pos button mouse-down? mods offset)

Returns the effects of a mouse move event on elem. Will only call -mouse-move on mouse events within an elements bounds.

mouse-event is used for both mouse up and mouse down events.

mouse-move clj/s

(mouse-move elem global-pos)

(mouse-move elem global-pos offset)

Returns the effects of a mouse move event on elem. Will only call -mouse-move on mouse events within an elements bounds.

mouse-move-global clj/s

(mouse-move-global elem global-pos)

(mouse-move-global elem global-pos offset)

Returns the effects of a mouse move event on elem. Will -mouse-move-global for all elements and their children.

mouse-up clj/s

(mouse-up elem [mx my :as pos])

Returns the effects of a mouse up event on elem. Will only call -mouse-event or -mouse-down if the position is in the element's bounds.

no-events clj/s

(no-events body)

NoEvents clj/s

NoKeyEvent clj/s

on clj/s

(on & events)

Wraps an elem with event handlers.

events are pairs of events and event handlers and the last argument should be an elem.

example:

Adds do nothing event handlers for mouse-down and mouse-up events on a label that says "Hello!" (on :mouse-down (fn [[mx my]] nil) :mouse-up (fn [[mx my]] nil) (label "Hello!"))

on-bubble clj/s

(on-bubble on-bubble & drawables)

Wraps drawables and adds a handler for bubbling

on-bubble should take seq of effects

on-click clj/s

(on-click on-click & drawables)

Wrap an element with a mouse down event handler, on-click.

on-click must accept 0 arguments and should return a sequence of effects.

on-clipboard-copy clj/s

(on-clipboard-copy on-clipboard-copy & drawables)

Wraps drawables and adds a handler for clipboard copy events.

on-clipboard-copy should take 0 arguments and return a sequence of effects.

on-clipboard-cut clj/s

(on-clipboard-cut on-clipboard-cut & drawables)

Wraps drawables and adds a handler for clipboard cut events.

on-clipboard-copy should take 0 arguments and return a sequence of effects.

on-clipboard-paste clj/s

(on-clipboard-paste on-clipboard-paste & drawables)

Wraps drawables and adds a handler for clipboard paste events.

on-clipboard-paste should take 1 arguments s and return a sequence of effects.

on-key-event clj/s

(on-key-event on-key-event & drawables)

Wraps drawables and adds a handler for key events.

on-key-event should take 4 arguments key, scancode, action, mods and return a sequence of effects.

on-key-press clj/s

(on-key-press on-key-press & drawables)

Wraps drawables and adds an event handler for key-press events.

on-key-press should take 1 argument key and return a sequence of effects.

on-mouse-down clj/s

(on-mouse-down on-mouse-down & drawables)

Wraps drawables and adds an event handler for mouse-down events.

on-mouse-down should take 1 argument [mx my] of the mouse position in local coordinates and return a sequence of effects.

on-mouse-event clj/s

(on-mouse-event on-mouse-event & drawables)

Wraps drawables and adds an event handler for mouse events.

on-mouse-event should take 4 arguments [pos button mouse-down? mods] and return a sequence of effects.

on-mouse-move clj/s

(on-mouse-move on-mouse-move & drawables)

Wraps drawables and adds an event handler for mouse-move events.

on-mouse-move down should take 1 argument [mx my] of the mouse position in local coordinates and return a sequence of effects.

on-mouse-move-global clj/s

(on-mouse-move-global on-mouse-move-global & drawables)

Wraps drawables and adds an event handler for mouse-move-global events.

on-mouse-move-global down should take 1 argument [mx my] of the mouse position in global coordinates and return a sequence of effects.

on-mouse-up clj/s

(on-mouse-up on-mouse-up & drawables)

Wraps drawables and adds an event handler for mouse-up events.

on-mouse-up should take 1 argument [mx my] of the mouse position in local coordinates and return a sequence of effects.

on-scroll clj/s

(on-scroll on-scroll & drawables)

Wraps drawables and adds an event handler for scroll events.

on-scroll should take 1 argument [offset-x offset-y] of the scroll offset and return a sequence of effects.

OnBubble clj/s

OnClick clj/s

OnClipboardCopy clj/s

OnClipboardCut clj/s

OnClipboardPaste clj/s

OnKeyEvent clj/s

OnKeyPress clj/s

OnMouseDown clj/s

OnMouseEvent clj/s

OnMouseMove clj/s

OnMouseMoveGlobal clj/s

OnMouseUp clj/s

OnScroll clj/s

origin clj/s

(origin elem)

Specifies the top left corner of a component's bounds

The origin is vector or 2 numbers [x, y]

origin-x clj/s

(origin-x elem)

Convience function for returning the x coordinate of elem's origin

origin-y clj/s

(origin-y elem)

Convience function for returning the y coordinate of elem's origin

padding clj/s

(padding px py elem)

Padding clj/s

Path clj/s

path clj/s

(path & points)

A graphical element that will draw lines connecting points.

See with-style, with-stroke-width, and with-color for more options.

PWrapped clj protocol

-unwrap clj

(-unwrap this)

rectangle clj/s

(rectangle width height)

Graphical elem that draws a rectangle.

See with-style, with-stroke-width, and with-color for more options.

Rotate clj/s

rounded-rectangle clj/s

(rounded-rectangle width height border-radius)

Graphical elem that draws a rounded rectangle.

RoundedRectangle clj/s

run clj/s

(run & args)

run-sync clj

(run-sync & args)

scale clj/s

(scale sx sy & drawables)

Draw drawables using scalars which is a vector of [scale-x scale-y]

Scale clj/s

scissor-view clj/s

(scissor-view offset bounds drawable)

Graphical elem to only draw drawable within bounds with an offset.

All other drawing will be clipped.

ScissorView clj/s

scroll clj/s

(scroll elem [offset-x offset-y :as offset])

Returns the effects of a scroll event on elem.

ScrollView clj/s

scrollview clj/s

(scrollview bounds offset drawable)

Graphical elem that will draw drawable offset by offset and clip its drawings to bounds.

Spacer clj/s

spacer clj/s

(spacer x y)

An empty graphical element with width x and height y.

Useful for layout.

text-bounds clj/s

text-cursor clj/s

(text-cursor text cursor)

(text-cursor text cursor font)

Graphical elem that can draw a text cursor

font should be a membrane.ui.Font

text-selection clj/s

(text-selection text [selection-start selection-end :as selection])

(text-selection text [selection-start selection-end :as selection] font)

Graphical elem for drawing a selection of text.

TextCursor clj/s

TextSelection clj/s

translate clj/s

(translate x y drawable)

A graphical elem that will shift drawable's origin by x and y and draw it at its new origin.

Translate clj/s

vertical-layout clj/s

(vertical-layout & elems)

Returns a graphical elem of elems stacked on top of each other

width clj/s

(width elem)

Returns the width of elem.

with-color clj/s

(with-color color & drawables)

Use color for all children. Color is a vector of [r g b] or [r g b a]. All values should be between 0 and 1 inclusive.

with-stroke-width clj/s

(with-stroke-width stroke-width & drawables)

Set the stroke width for drawables.

with-style clj/s

(with-style style & drawables)

Style for drawing paths and polygons

style is one of: :membrane.ui/style-fill :membrane.ui/style-stroke :membrane.ui/style-stroke-and-fill

WithColor clj/s

WithStrokeWidth clj/s

WithStyle clj/s

wrap clj

(wrap o)

wrap-on clj/s

(wrap-on & events)

Wraps an elem with event handlers.

events are pairs of events and event handlers and the last argument should be an elem. The event handlers should accept an extra first argument to the event which is the original event handler.

example:

Wraps a button with a mouse-down handler that only returns an effect when the x coordinate is even. (on :mouse-down (fn [handler [mx my]] (when (even? mx) (handler [mx my]))) (button "Hello!" (fn [] [[:hello!]])))