org_flutter library

Classes

DecryptedContentSerializer
IdentityTextScale
A utility for overriding the text scale to be 1
Org
Display an Org Mode document with full interaction.
OrgBlock
A block, like
OrgBlockWidget
An Org Mode block
A bracketed link, like
OrgComment
OrgCommentWidget
OrgContent
A generic node that contains children
OrgContentGrammarDefinition
Content grammar definition
OrgContentParserDefinition
Content-level parser definition
OrgContentWidget
Generic Org Mode content
OrgController
Control behavior of an Org Mode document widget. Not needed if you are using the Org widget.
OrgControllerData
OrgDataNode
OrgDataNodeMap
A collection of temporary data about an Org Mode document used for display purposes.
OrgDecryptedContent
OrgDecryptedContentWidget
OrgDocument
The top-level node representing a full Org document
OrgDocumentWidget
The root of the actual Org Mode document itself. Assumes that OrgRootWidget and OrgController are available in the build context. See the Org widget for a more user-friendly entrypoint.
OrgDrawer
A drawer, like
OrgDrawerWidget
An Org Mode drawer
OrgEntity
An entity, like \Omega
A link to a file, like
OrgFileLinkGrammarDefinition
Grammar rules for file links, which are basically a mini-format of their own
OrgFileLinkParserDefinition
File link parser definition
OrgFixedWidthArea
A fixed-width area, like
OrgFixedWidthAreaWidget
An Org Mode fixed-width area
OrgFootnote
A footnote, like
OrgFootnoteReference
A footnote reference, like [fn:1]
OrgFootnoteReferenceWidget
OrgFootnoteWidget
OrgGrammarDefinition
Top-level grammar definition
OrgHeadline
An Org headline, like
OrgHeadlineWidget
An Org Mode section headline
OrgKeyword
A planning keyword, like SCHEDULED: or DEADLINE:
OrgLatexBlock
A LaTeX block, like
OrgLatexBlockWidget
An Org Mode LaTeX block
OrgLatexInline
An inline LaTeX snippet, like $E=mc^2$
OrgLatexInlineWidget
An Org Mode LaTeX inline span
OrgLeafNode
A link, like
OrgList
A list, like
OrgListItem
OrgListItemWidget
An Org Mode list item
OrgListOrderedItem
An ordered list item, like
OrgListUnorderedItem
An unordered list item, like
OrgListWidget
An Org Mode list
OrgLocalVariables
OrgLocalVariablesWidget
OrgMacroReference
A macro reference, like
OrgMarkup
Emphasis markup, like
OrgMeta
A "meta" line, like
OrgMetaWidget
An Org Mode meta line
OrgNode
The base type of all Org AST objects
OrgParagraph
OrgParagraphWidget
An Org Mode paragraph
OrgParentNode
OrgParserDefinition
Top-level parser definitions
OrgPgpBlock
OrgPgpBlockWidget
OrgPlainText
Plain text that has no markup
OrgPlanningLine
A planning line, like
OrgPlanningLineWidget
An Org Mode planning line
OrgProperty
A property in a drawer, like
OrgPropertyWidget
An Org Mode property
OrgQueryAndMatcher
OrgQueryGrammarDefinition
Grammar rules for the section query language described at https://orgmode.org/manual/Matching-tags-and-properties.html
OrgQueryMatcher
A matcher for displaying the document as a "sparse tree" as in org-match-sparse-tree
OrgQueryNotMatcher
OrgQueryOrMatcher
OrgQueryParserDefinition
OrgQueryPropertyMatcher
OrgQueryTagMatcher
OrgRootWidget
A widget that sits above the OrgDocumentWidget and orchestrates OrgTheme and OrgEvents.
OrgSection
An Org section. May have nested sections, like
OrgSectionWidget
An Org Mode section
OrgSettings
A collection of settings that affect the appearance of the document
OrgSrcBlock
A source block, like
OrgTable
A table, like
OrgTableCell
OrgTableCellRow
OrgTableDividerRow
OrgTableRow
OrgTableWidget
An Org Mode table
OrgText
Display an Org Mode document with minimal interaction, suitable for use as a rich equivalent to a Text widget.
OrgTheme
The theme for the Org Mode document
OrgThemeData
OrgTimestamp
A timestamp, like [2020-05-05 Tue]
OrgTree
A node potentially containing OrgSections

Enums

OrgStyle
Supported styles for OrgMarkup nodes
OrgVisibilityState

Extensions

LayeredOrgSettings on List<OrgSettings>
ZipperExt on ZipperLocation<ZR, ZI, ZS>

Properties

org → Parser
The top-level Org parser
final
File link parser
final
orgQuery → Parser
final

Functions

isOrgCustomIdUrl(String url) bool
Identify URLs that point to a custom ID (starting with '#').
isOrgIdUrl(String url) bool
Identify URLs that point to IDs (starting with 'id:').
isOrgLocalSectionUrl(String url) bool
Identify URLs that point to a section within the current document (starting with '*')
looksLikeImagePath(String text) bool
looksLikeUrl(String text) bool
parseOrgCustomIdUrl(String url) String
Return the CUSTOM_ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgIdUrl(String url) String
Return the ID of the section pointed to by the URL. The URL must be one for which isOrgCustomIdUrl returns true.
parseOrgLocalSectionUrl(String url) String
Return the title of the section pointed to by the URL. The URL must be one for which isOrgLocalSectionUrl returns true.

Typedefs

FootnoteKey = GlobalKey<State<StatefulWidget>>
OrgErrorHandler = void Function(dynamic)
OrgPath = List<OrgNode>
OrgStateListener = void Function(Map<String, dynamic>)
OrgZipper = ZipperLocation<OrgNode, OrgLeafNode, OrgParentNode>
SearchResultKey = GlobalKey<SearchResultState>