CBase.js

Inherits from: CGUI.js

1 ) function: getContentWidth
2 ) function: getContentHeight
3 ) function: setScrollVis
4 ) function: setScrollValue
5 ) function: setScrollMinmax
6 ) function: ScrollResize
7 ) function: addPane
8 ) function: addContentPane
9 ) function: setBkColor
10 ) function: addContentAsText
11 ) function: addContentAsSVG
12 ) function: addContentAsObject

Object: CBase

Object Description:
Example:
Inherits from: CGUI

There is documentation/code mismatch

There is documentation/code mismatch

There is documentation/code mismatch

There is documentation/code mismatch

There is documentation/code mismatch

There is documentation/code mismatch

Method: addPane
Description: add and pane to this frame.
  • Parameter
    : pane - the pane to add
  • Parameter
    : ax - "left" "center" "right", the horizontal anchor position
  • Parameter
    : offsetx - the offset ('+':right '-':left) from the ax position
  • Parameter
    : ay - "top" "center" "bottom", the vertical anchor position
  • Parameter
    : offsety - the offset ('+':down '-':up) from the ay position

Description:
This method adds a pane to the frame. Started to use this to
allow multi-pane frames, but that's still buggy.
Currently their can only be one contentpane in a frame, but
I think the heirarchy should be modified to allow multiple
panes of any type. This will complicate window resizing, but is
I think, a necessary part of the GUI.

Method: addContentPane
Description: add a content pane to this frame
  • Parameter
    : contentpane - the contentpane to add

Notes: At present their can only be one contentpane in a frame.

Method: setBkColor
Description: sets background color of content, if there is one
  • Parameter
    : iColor - any valid svg color format
Added - Chris Peto

Method: addContentAsText
Description: passes the xml string to the contentpane's addAsText
method, and attaches eventhandlers to show the id
of any SVG element the mouse passes over.

  • Parameter
    : text - the XML encoded SVG string to display as content.

Method: addContentAsText
Description: passes the svg node to the contentpane's addAsSVG
method, and attaches eventhandlers to show the id
of any SVG element the mouse passes over.

  • Parameter
    : text - the XML encoded SVG string to display as content.

There is documentation/code mismatch

Method: addContentAsObject
Description: passes the javascript object (obj) to the contentpane's addAsObj
method, and attaches eventhandlers to show the id
of any SVG element the mouse passes over.

  • Parameter
    : obj - CGUI based object, i.e. Slider