Skip to content

Reference

Documents kept in the repository and published here unchanged. They are written for people working on the crate as much as with it.

Release history

  • Upgrading to 3.0.0 — the ordered list of what to change in a crate that implements views of its own, and what reaches ordinary application code.
  • Changelog — every release, in Keep a Changelog form. The 3.0.0 entry doubles as the migration guide.
  • What's new — the same recent work, in prose.

Architecture

  • Design document — the long one. How the Borland class tree became layered traits, and why each decision went the way it did.
  • Owner-relative coordinates — the coordinate model: the origin stack, extent, and how a view draws and receives events in its own space.
  • Missing inheritance — the analysis that produced the 3.0.0 shape, listing what C++ inheritance provided and what replaced each piece.
  • Implementation reference — events, commands, menus, status lines, message boxes and the enable/disable system, with code for each.

API

  • API index — the map. Start here to find a type.
  • API catalogue — every public type and method.
  • More controls — the widgets added beyond the Borland set.
  • Coding guidelines — the conventions the crate holds itself to. Worth reading before sending a patch.

Palettes

  • Palette system — how a colour index is resolved through the chain of owners.
  • Palette design — why the chain is pushed down at draw time rather than pulled up through a parent pointer.
  • Borland palette chart — the original colour tables, entry by entry.

Persistence

Elsewhere