OrgHeadline class - org_parser library

Constructors

OrgHeadline(({String trailing, String value}) stars, ({bool done, String trailing, String value})? keyword, ({String leading, String trailing, String value})? priority, OrgContent? title, String? rawTitle, ({String leading, String trailing, Iterable<String> values})? tags, String trailing, [String? id])

Properties

children → List<OrgNode>: The children of this node. May be empty (no children) or null (an object that can't have children).
no setteroverride
hashCode → int: The hash code for this object.
no setterinherited
id → String: A unique ID for this node. Use this to identify nodes across edits via OrgTree.edit, because OrgParentNodes can be recreated and thus will not be equal via identical.
finalinherited
keyword → ({bool done, String trailing, String value})?: Headline keyword, like TODO. done indicates whether the keyword represents an in-progress state or a done state (as in org-done-keywords). See also OrgTodoStates.
final
level → int: no setter
priority → ({String leading, String trailing, String value})?: Headline priority, like A
final
rawTitle → String?: A raw representation of the headline title. This is useful for resolving section links (see isOrgLocalSectionUrl), which will reference the raw title rather than the parsed title.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
stars → ({String trailing, String value}): Headline stars, like *** . Includes trailing spaces.
final
tags → ({String leading, String trailing, List<String> values})?: Headline tags, like :tag1:tag2:
final
title → OrgContent?: Headline title
final
trailing → String: final

Methods

contains(Pattern pattern) → bool: Return true if this node or any of its children recursively match the supplied pattern
override
copyWith({({String trailing, String value})? stars, ({bool done, String trailing, String value})? keyword, ({String leading, String trailing, String value})? priority, OrgContent? title, String? rawTitle, ({String leading, String trailing, List<String> values})? tags, String? trailing, String? id}) → OrgHeadline
cycleTodo([List<OrgTodoStates>? todoStates]) → OrgHeadline: Cycle todo state like (null) -> TODO -> DONE -> (null). Uses defaultTodoStates if none provided. If the keyword value is not found in the states then will throw ArgumentError.
edit() → OrgZipper: Obtain a zipper starting at the root of this node. The zipper can be used to edit the node; call ZipperLocation.commit to obtain a new node with the edits applied.
inherited
editNode(OrgNode node) → OrgZipper?: Obtain a zipper for the specified node, which is presumed to be a descendant of this node. Returns null if the node is not found. The zipper can be used to edit this node; call ZipperLocation.commit to obtain a new node with the edits applied.
inherited
ensureTrailingNewLine() → OrgHeadline
find<T extends OrgNode>(bool predicate(T), [OrgPath path = const []]) → ({T node, OrgPath path})?: Find the first node in the AST that satisfies predicate. Specify a type T to only visit nodes of that type. Returns a tuple of the node and its path from the root of the tree, or null if no node is found.
inherited
fromChildren(List<OrgNode> children) → OrgHeadline: override
keywordIsEndState(List<OrgTodoStates> todoStates) → bool
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMarkup({OrgSerializer? serializer}) → String: inherited
toPlainText({OrgPlainTextSerializer? serializer}) → String: inherited
toString() → String: A string representation of this object.
override
visit<T extends OrgNode>(bool visitor(T)) → bool: Walk AST with visitor. Specify a type T to only visit nodes of that type. The visitor function must return true to continue iterating, or false to stop.
inherited
withoutKeyword() → OrgHeadline

Operators

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