|
|
              
Atom ClassThe Atom class is the fundamental unit for representing documents internally. More... #include <Atom>
Public Types
Public Functions
Detailed DescriptionThe Atom class is the fundamental unit for representing documents internally. Atoms have a type and are completed by a string whose meaning depends on the type. For example, the string
is represented by the following atoms:
Member Type Documentation
|
| Constant | Value |
|---|---|
| Atom::AbstractLeft | 0 |
| Atom::AbstractRight | 1 |
| Atom::AnnotatedList | 2 |
| Atom::AutoLink | 3 |
| Atom::BaseName | 4 |
| Atom::BriefLeft | 5 |
| Atom::BriefRight | 6 |
| Atom::C | 7 |
| Atom::CaptionLeft | 8 |
| Atom::CaptionRight | 9 |
| Atom::Code | 10 |
| Atom::CodeBad | 11 |
| Atom::CodeNew | 12 |
| Atom::CodeOld | 13 |
| Atom::CodeQuoteArgument | 14 |
| Atom::CodeQuoteCommand | 15 |
| Atom::DivLeft | 16 |
| Atom::DivRight | 17 |
| Atom::EndQmlText | 18 |
| Atom::FormatElse | 21 |
| Atom::FormatEndif | 22 |
| Atom::FormatIf | 23 |
| Atom::FootnoteLeft | 19 |
| Atom::FootnoteRight | 20 |
| Atom::FormattingLeft | 24 |
| Atom::FormattingRight | 25 |
| Atom::GeneratedList | 26 |
| Atom::Image | 29 |
| Atom::ImageText | 30 |
| Atom::ImportantNote | ? |
| Atom::InlineImage | 33 |
| Atom::LineBreak | 38 |
| Atom::Link | 39 |
| Atom::LinkNode | 40 |
| Atom::ListLeft | 41 |
| Atom::ListItemNumber | 42 |
| Atom::ListTagLeft | 43 |
| Atom::ListTagRight | 44 |
| Atom::ListItemLeft | 45 |
| Atom::ListItemRight | 46 |
| Atom::ListRight | 47 |
| Atom::Nop | 48 |
| Atom::Note | ? |
| Atom::ParaLeft | 51 |
| Atom::ParaRight | 52 |
| Atom::Qml | 53 |
| Atom::QmlText | 54 |
| Atom::QuotationLeft | 55 |
| Atom::QuotationRight | 56 |
| Atom::RawString | 57 |
| Atom::SectionLeft | 58 |
| Atom::SectionRight | 59 |
| Atom::SectionHeadingLeft | 60 |
| Atom::SectionHeadingRight | 61 |
| Atom::SidebarLeft | 62 |
| Atom::SidebarRight | 63 |
| Atom::SinceList | 64 |
| Atom::String | 68 |
| Atom::TableLeft | 69 |
| Atom::TableRight | 70 |
| Atom::TableHeaderLeft | 71 |
| Atom::TableHeaderRight | 72 |
| Atom::TableRowLeft | 73 |
| Atom::TableRowRight | 74 |
| Atom::TableItemLeft | 75 |
| Atom::TableItemRight | 76 |
| Atom::TableOfContents | 77 |
| Atom::Target | 78 |
| Atom::UnhandledFormat | 79 |
| Atom::UnknownCommand | 80 |
Member Function Documentation
Atom::Atom(Type type, const QString & string = "")
Constructs an atom of the specified type with the single parameter string and does not put the new atom in a list.
Atom::Atom(Type type, const QString & p1, const QString & p2)
Constructs an atom of the specified type with the two parameters p1 and p2 and does not put the new atom in a list.
Atom::Atom(Atom * previous, Type type, const QString & string = "")
Constructs an atom of the specified type with the single parameter string and inserts the new atom into the list after the previous atom.
Atom::Atom(Atom * previous, Type type, const QString & p1, const QString & p2)
Constructs an atom of the specified type with the two parameters p1 and p2 and inserts the new atom into the list after the previous atom.
void Atom::appendChar(QChar ch)
Appends ch to the string parameter of this atom.
\alsostring()
void Atom::appendString(const QString & string)
Appends string to the string parameter of this atom.
\alsostring()
void Atom::chopString()
\alsostring()
int Atom::count() const
void Atom::dump() const
Dumps this Atom to stderr in printer friendly form.
Atom * Atom::next()
Return the next atom in the atom list. \also type(), string()
See also setNext().
const Atom * Atom::next() const
Return the next atom in the atom list. \also type(), string()
const Atom * Atom::next(Type t) const
Return the next Atom in the list if it is of Type t. Otherwise return 0.
const Atom * Atom::next(Type t, const QString & s) const
Return the next Atom in the list if it is of Type t and its string part is s. Otherwise return 0.
void Atom::setNext(Atom * newNext)
See also next().
void Atom::setString(const QString & string)
See also string().
const QString & Atom::string() const
Returns the string parameter that together with the type characterizes this atom.
See also setString().
const QString & Atom::string(int i) const
Type Atom::type() const
Return the type of this atom. \also string(), next()
QString Atom::typeString() const
Return the type of this atom as a string. Return "Invalid" if type() returns an impossible value.
This is only useful for debugging.
\alsotype()