Canvas layout system

Canvas - the FlightGear 2D drawing API
Canvas - Main Page Canvas News - for the latest developments Shiva Alternatives - ongoing work for Core Profile support Canvas FAQs - frequently asked questions Canvas - Getting started Canvas Development (core) Canvas Troubleshooting (core) Canvas Sandbox (core) PUI2Canvas (PUI/XML Parser) Canvas GUI Canvas Widgets Canvas Maps Canvas Snippets
RFC
Canvas Instancing Howto:New Canvas Execution Model Canvas SVG Canvas Popout Windows Canvas Scenery Overlays
Frameworks
Canvas Map API (soon deprecated!) Canvas MapStructure Canvas MapStructure Layers MapStructure Snippets Canvas Radar Canvas Animation Framework (WIP) Canvas Plotting Framework (WIP) Canvas MFD Framework Canvas ND Framework Canvas PFD Framework Canvas MCDU Framework Canvas EFB Framework Canvas Wrappers Canvas Glass Cockpit Efforts
Tutorials
Howto: Canvas Troubleshooting Howto:Adding a canvas to a GUI dialog (PUI!) Howto:Creating a Canvas GUI dialog file (New) Howto:Dynamic Liveries via Canvas (new) Howto:Creating a Canvas GUI Widget Howto:Add a 2D canvas instrument to your aircraft Howto:Parsing 2D Instruments using the Canvas Howto:Creating fullscreen Canvas applications Howto:Use SVG inside a Canvas Howto:Extend the Canvas SVG module Howto:Serializing a Canvas to SVG Howto:Canvas applications as Nasal submodules Howto:Using raster images and nested canvases Canvas HUD Howto:Project 3D to 2D coordinates on desktop canvas
Reference
Canvas Element Group Image Map Path Text Canvas Nasal API MessageBox Layout System Canvas GUI API Canvas draw library Event Handling
Related
Canvas Properties Unifying the 2D rendering backend via canvas Howto:Use a Camera View in an Instrument Howto:Extending Canvas to support rendering 3D models Howto:Extending Canvas to support MathGL
To be ported
Navigation display Map FGCanvas Canvas Nasal/JavaScript Subset
Deprecated by Canvas
Complex Glass Cockpit Avionics
(click on headings to toggle)

#
# Base class for all widgets/layouts
#
var LayoutItem = {
  getCanvas: func(),

  setCanvas: func(<Canvas>),

  getParent: func(),

  setParent: func(<LayoutItem>),

  sizeHint: func(),

  minimumSize: func(),

  maximumSize: func(),

  hasHeightForWidth: func(),

  heightForWidth: func(<int: width>),

  minimumHeightForWidth: func(<int: width>),

  setVisible: func(<bool: visible>),

  isVisible: func(),

  isExplicitlyHidden: func(),

  show: func(),

  hide: func(),

  setGeometry: func([<int: x>, <int: y>, <int: width>, <int: height>]),

  geometry: func()
};

#
# Base class for all layouts
#
var Layout = {
  parents: [LayoutItem],

  # Add an item.
  addItem: func(<LayoutItem>),

  # Set the spacing/padding between items.
  setSpacing: func(<int: space>),

  # Get the spacing/padding between items.
  spacing: func(),

  # Get the number of items (excluding nested items).
  count: func(),

  # Get the item at the given position.
  itemAt: func(<int: index>),

  # Remove and get the item at the given position.
  takeAt: func(<int: index>),

  # Remove the given item from the layout.
  removeItem: func(<LayoutItem>),

  # Remove all items.
  clear: func()
};

#
# Vertical or horizontal box layout
#
var BoxLayout = {
  parents: [Layout],

  addItem: func(<LayoutItem>[, <int: stretch> = 0]),

  addStretch: func([<int: stretch> = 0]),

  addSpacing: func(<int: size>),

  insertItem: func(<int: index>, <LayoutItem>[, <int: stretch> = 0]),

  insertStretch: func(<int: index>[, <int: stretch> = 0]),

  insertSpacing: func(<int: index>, <int: size>),

  # Set the stretch factor of the item at the given position to <stretch>.
  setStretch: func(<int: index>, <int: stretch>),

  # Set the stretch factor of the given item to <stretch>
  # (if it exists in this layout).
  setStretchFactor: func(<LayoutItem>, <int: stretch>),

  # Get the stretch factor of the item at the given position.
  stretch: func(<int: index>)
};

#
# Horizontal box layout
#
var HBoxLayout = {
  parents: [BoxLayout],

  # Create a horizontal box layout
  new: func()
};

#
# Vertical box layout
#
var VBoxLayout = {
  parents: [BoxLayout],

  # Create a vertical box layout
  new: func()
};