Documentation for gcanvas.ew v0.10.5
Table of Contents

ScrollBars

Controlling and accessing Scroll Bars


  • const GC_SCROLL_*   Rather unfriendlily named constants of the automatically added scroll bar width and heights
  • func getGfxCanvasAutoScroll(integer canvasID)   Return the canvas's auto scroll behaviour
  • func getGfxCanvasHScrollMax(integer canvasID)   Get the maximum value of the horizontal scroll bar given the dimensions of the view port and the OSB
  • func getGfxCanvasScrollButtonID(canvasID)   Get the win32lib id of the button created at the conjunction of both scroll bars
  • func getGfxCanvasVScrollMax(integer canvasID)   Get the maximum value of the vertical scroll bar given the dimensions of the view port and the OSB
  • proc gfxCanvasAddHScroll(integer canvasID)   Cause a horizontal scroll bar to be displayed on the canvas
  • proc gfxCanvasAddScrollBars(integer canvasID)   Cause both scroll bars and the button to be added to the canvas
  • proc gfxCanvasAddVScroll(integer canvasID)   Cause a Vertical scroll bar to be displayed on the canvas
  • proc gfxCanvasRemoveHScroll(integer canvasID)   Cause the canvas's Horizontal sroll bar to be removed
  • proc gfxCanvasRemoveScrollBars(integer canvasID)   Cause both scroll bars and the button to be removed from the canvas
  • proc gfxCanvasRemoveVScroll(integer canvasID)   Cause the canvas's Vertical sroll bar to be removed
  • proc gfxCanvasResize(canvasID, new_width, new_height)   Change the size of the canvas (eg if the window is resized)
  • proc setGfxCanvasAutoScroll(integer canvasID, integer true_or_false)   Determine whether scroll bars will automatically appear on the canvas (default is true if needed)
  • proc setGfxCanvasScrollButtonHandler(canvasID, routineid)   nominate the routine to receive w32HClick on the button between the scroll bars

    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [const]
    GC_SCROLL_*

    Rather unfriendlily named constants of the automatically added scroll bar width and heights

    Category: ScrollBars

    GC_SCROLL_H_HEIGHT height of the horizontal scroll bar GC_SCROLL_V_WIDTH width of vertical scroll bar

    See Also: getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [func]
    getGfxCanvasAutoScroll
    (integer canvasID)

    Return the canvas's auto scroll behaviour

    Returns: True = will automatically add scroll bars, False = won't

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [func]
    getGfxCanvasHScrollMax
    (integer canvasID)

    Get the maximum value of the horizontal scroll bar given the dimensions of the view port and the OSB

    Returns: The integer value

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [func]
    getGfxCanvasScrollButtonID
    (canvasID)

    Get the win32lib id of the button created at the conjunction of both scroll bars

    Returns: the win32lib ID of the button or -1 if there is none

    Category: ScrollBars

    You can use this to do things with this button which has such a natural existence in this habitat.

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [func]
    getGfxCanvasVScrollMax
    (integer canvasID)

    Get the maximum value of the vertical scroll bar given the dimensions of the view port and the OSB

    Returns: The integer value

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasAddHScroll
    (integer canvasID)

    Cause a horizontal scroll bar to be displayed on the canvas

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasAddScrollBars
    (integer canvasID)

    Cause both scroll bars and the button to be added to the canvas

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasAddVScroll
    (integer canvasID)

    Cause a Vertical scroll bar to be displayed on the canvas

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasRemoveHScroll
    (integer canvasID)

    Cause the canvas's Horizontal sroll bar to be removed

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasRemoveScrollBars
    (integer canvasID)

    Cause both scroll bars and the button to be removed from the canvas

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasRemoveVScroll
    (integer canvasID)

    Cause the canvas's Vertical sroll bar to be removed

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasResize, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    gfxCanvasResize
    (canvasID, new_width, new_height)

    Change the size of the canvas (eg if the window is resized)

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, setGfxCanvasAutoScroll, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    setGfxCanvasAutoScroll
    (integer canvasID, integer true_or_false)

    Determine whether scroll bars will automatically appear on the canvas (default is true if needed)

    Category: ScrollBars

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasScrollButtonHandler


    Documentation for gcanvas.ew v0.10.5
    Table of Contents

    [proc]
    setGfxCanvasScrollButtonHandler
    (canvasID, routineid)

    nominate the routine to receive w32HClick on the button between the scroll bars

    Category: ScrollBars

    This routine is remembered even if the scroll bars disappear an reappear d You should call this only after the canvas is drawn with drawGfxCanvas
    You can only use w32HClick with this button though...
    Call this routine with -1 to disable the routine callback

    See Also: GC_SCROLL_*, getGfxCanvasAutoScroll, getGfxCanvasHScrollMax, getGfxCanvasScrollButtonID, getGfxCanvasVScrollMax, gfxCanvasAddHScroll, gfxCanvasAddScrollBars, gfxCanvasAddVScroll, gfxCanvasRemoveHScroll, gfxCanvasRemoveScrollBars, gfxCanvasRemoveVScroll, gfxCanvasResize, setGfxCanvasAutoScroll