factor/library/ui/gadgets/scrolling.factor

! Copyright (C) 2005, 2006 Slava Pestov.
! See http://factorcode.org/license.txt for BSD license.
IN: gadgets-scrolling
USING: arrays gadgets gadgets-frames gadgets-theme
gadgets-viewports generic kernel math namespaces sequences ;

! A scroller combines a viewport with two x and y sliders.
! The follows slot is set by scroll>gadget.
TUPLE: scroller viewport x y follows ;

: scroller-origin ( scroller -- { x y 0 } )
    dup scroller-x slider-value
    swap scroller-y slider-value
    2array ;

: find-scroller [ scroller? ] find-parent ;

: scroll>gadget ( gadget -- )
    #! Scroll the scroller that contains this gadget, if any, so
    #! that the gadget becomes visible.
    dup find-scroller dup
    [ [ set-scroller-follows ] keep relayout ] [ 2drop ] if ;

: scroll-up-line scroller-y -1 swap slide-by-line ;

: scroll-down-line scroller-y 1 swap slide-by-line ;

M: scroller gadget-gestures
    drop H{
        { T{ wheel-up } [ scroll-up-line ] }
        { T{ wheel-down } [ scroll-down-line ] }
        { T{ slider-changed } [ relayout-1 ] }
    } ;

C: scroller ( gadget -- scroller )
    #! Wrap a scrolling pane around the gadget.
    {
        { [ <viewport> ] set-scroller-viewport @center }
        { [ <x-slider> ] set-scroller-x @bottom }
        { [ <y-slider> ] set-scroller-y @right }
    } make-frame*
    t over set-gadget-root?
    dup faint-boundary ;

: set-slider ( value page max slider -- )
    #! page/max/value are 3-vectors.
    [ [ gadget-orientation v. ] keep set-slider-max ] keep
    [ [ gadget-orientation v. ] keep set-slider-page ] keep
    [ [ gadget-orientation v. ] keep set-slider-value* ] keep
    slider-elevator relayout-1 ;

: update-slider ( scroller value slider -- )
    >r swap scroller-viewport dup rect-dim swap viewport-dim
    r> set-slider ;

: position-viewport ( scroller -- )
    dup scroller-origin vneg
    swap scroller-viewport gadget-child
    set-rect-loc ;

: scroll ( scroller value -- )
    2dup over scroller-x update-slider
    dupd over scroller-y update-slider
    position-viewport ;

: include-point ( point rect -- rect )
    rect-extent >r over r> vmax >r vmin r> <extent-rect> ;

: scroll>point ( point scroller -- )
    [
        scroller-viewport [ include-point ] keep
        [ rect-extent v+ ] 2apply v-
    ] keep dup scroller-origin rot v+ scroll ;

: (scroll>gadget) ( gadget scroller -- )
    #! First ensure top left is visible, then bottom right.
    over screen-loc over scroll>point
    over screen-loc rot rect-dim v+ swap scroll>point ;

: update-scroller ( scroller -- )
    dup scroller-follows dup [
        swap
        f over set-scroller-follows
        (scroll>gadget)
    ] [
        drop dup scroller-origin scroll
    ] if ;

M: scroller layout* ( scroller -- )
    dup delegate layout*
    dup layout-children
    update-scroller ;

M: scroller focusable-child* ( scroller -- viewport )
    scroller-viewport ;

: scroller-gadget ( scroller -- gadget )
    #! Gadget being scrolled.
    scroller-viewport gadget-child ;