Xport Interface: document::begin

returns a child iterator pointing to the first markup object in the document.

markup::iterator document::begin();1st Variety

markup::const_iterator document::begin() const;2nd Variety

Parameters

none

Returns

A child markup iterator (or const_iterator in the second variety) pointing to the first markup object in the document. If the document is empty, returns document::end().

Remarks

Although you will be primarily concerned with the markup objects which exist in the head or body elements, there may be sometimes where you'll be interested in accessing elements in the root of the document. In a normal xhtml document, the begin() operation will return an iterator pointing to the doctype declaration, as this is normally the first element of a valid xhtml document. Once an iterator is obtained, it can be used like any other markup iterator, to iterate over all of the markup objects in the root of the document.

Complexity

Constant

Example

#include "xhtml_doc.h"
#include <string>
#include <iostream>
#include <cassert>


int main(int argc, char* argv[])
{
  using namespace Xport;

  // create an xhtml transitional root doc
  tdocument doc(root_doc);

  // iterate over the root of the document with a child iterator
  tmarkup::iterator it = doc.begin();

  for (int i = 1; it != doc.end(); ++it, ++i) {
    std::cout << "markup object #" << i << ": ";
    switch (it->markup_type())
    {
    case mt_doctype_declaration:
      std::cout << "doctype declaration\n";
      break;
    case mt_element:
      std::cout << "<" << it->tag_name() << "> element\n";
    }
  }

  return 0;
}