Xport Interface: markup::descendant_begin

When called on a derived element object, returns a descendant iterator pointing to the first child markup object in the element.

markup::descendant_iterator markup::descendant_begin();1st Variety

markup::const_descendant_iterator markup::descendant_begin() const;2nd Variety

Parameters

None

Returns

When called from a derived element object, returns a descendant markup iterator (or const descendant iterator in the second variety) pointing to the first child markup object in the element. If called from any other markup derived markup object or if the element contains no children, returns markup::descendant_end().

Remarks

This operation is revelant only if it is called on a derived element object. When called from any other object derived from markup, returns markup::descendant_end(). When called from a derived element, this operation returns a descendant iterator pointing to the first child markup object in the element, which can be used for traversing the element's descendants, retrieving information on the descendants, or inserting content into the descendants. If the called element is a const object, a const_descendant_iterator will be returned. The descendant iterators traverse the document tree in a pre-order fashion. In a pre-order traversal, the beginning node is naturally the first child node of the called node.

Complexity

Constant

Example

#include "xhtml_doc.h"
#include "xport_brochure.h"
#include <iostream>

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

  // create an xhtml strict root doc
  document doc(root_doc);
  stylesheet ss;

  // create xport brochure
  xport_brochure brochure;
  brochure.create(doc, ss);

  // output the unordered list item contents
  markup::const_descendant_iterator it = doc.body()->descendant_begin();
  formatter fmtr(std::cout);
  for (; it != doc.body()->descendant_end(); ++it) {
    if (it->markup_type() == mt_element && it->tag() == li) {
      // found a li element.  verify it has content
      if (!it->empty()) {
        it->front().write(fmtr);
        std::cout << "\n";
      }
    }
  }

  return 0;
}