Skip to content

Latest commit

 

History

History
103 lines (59 loc) · 1.72 KB

KeyNode.md

File metadata and controls

103 lines (59 loc) · 1.72 KB
Raw

KeyNode

class KeyNode

Inherited from: Node.

Required header: <Eclog/KeyNode.h>

The KeyNode abstract class represents a key node in a document tree (See Document).

Member functions

Name Description
str Gets the key.
setNotation Sets the string notation.
notation Gets the string notation.
setDelimiter Sets the string delimiter.
delimiter Gets the string delimiter.

str

virtual cstring str() const;

Gets the key.

Return value

cstring The key.

setNotation

virtual void setNotation(StringNotation notation);

Sets the string notation.

Parameters

StringNotation notation The string notation to be used when rendering the key.

notation

virtual StringNotation notation() const;

Gets the string notation.

Return value

StringNotation The string notation to be used when rendering the key.

setDelimiter

virtual void setDelimiter(cstring delimiter);
virtual void setDelimiter(cstring delimiter, ErrorCode& ec);

Sets the string delimiter.

Parameters

cstring delimiter The string delimiter to be used when rendering the key.

ErrorCode& ec Set to indicate what error occurred, if any.

Errors

An InvalidArgument error occurs if delimiter is invalid.

delimiter

virtual cstring delimiter() const;

Gets the string delimiter.

Return value

cstring The string delimiter to be used when rendering the key.