Xport Interface: markup::descendant_end

Returns a descendant iterator pointing just past the last pre-order descendant markup object in the called derived element.

Parameters

None

Returns

Returns a descendant markup iterator (or const descendant iterator in the second variety) pointing just past the last pre-order descendant markup object in the called derived element.

Remarks

This operation is revelant only if it is called on a derived element object. This is because the element is the only type derived from markup which can contain child markup objects. If the called markup object is a const object, a const_descendant_iterator will be returned. The descendant iterators traverse the document tree in a pre-order fashion. This operation returns a descendant_iterator, (or const_descendant_iterator in the 2nd variety), which points just past the last descendant markup object in the derived element. By nature of pre-order traversals, this the last pre-order descendant node would be the right most descendant node of the element at the deepest level.

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);

  // count the number of <em> elements
  int em_count = 0;
  markup::const_descendant_iterator it = doc.body()->descendant_begin();
  for (; it != doc.body()->descendant_end(); ++it) {
    if (it->markup_type() == mt_element && it->tag() == em) {
      ++em_count;
    }
  }

  std::cout << "The Xport brochure document contains " << em_count << " <em> elements.\n\n";

  return 0;
}