DVDocsApp class

The documentation site.

document is what to draw, and is the whole of what the app needs: a test hands it one, and the compiled site fetches its own through source.

source reads it when there is no document to hand, which is also how an application embedding the documentation points at a payload of its own. It is read once, at startup, and a failure is shown as itself rather than as an empty site: the commonest cause is a directory still serving the pages this replaced, and "empty documentation" sends whoever is looking for the cause somewhere else.

base is where the site is mounted, for the browser's own reader; location is the address it was opened at, the browser's by default; open is the app's own way out for a link that leaves the site.

Inheritance

Constructors

DVDocsApp({Key? key, DVDocsDocument? document, DVDocsSource? source, String base = '/', String? title, Uri? location, void open(String url)?})
const

Properties

base → String
Where the site is mounted, for the browser's own reader.
final
document → DVDocsDocument?
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
location → Uri?
The address the app was opened at; the browser's by default.
final
open → void Function(String url)?
Opens a destination that leaves the site, where the platform has no way of its own to answer with.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → DVDocsSource?
Where the document comes from, when it is not handed in.
final
title → String?
The document title. The application's name by default.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<DVDocsApp>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited