Xport Interface: document::descendant_begin

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

  descendant_iterator document::descendant_begin();1st Variety

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

Parameters

None

Returns

Returns a descendant_iterator, (or const_descendant_iterator in the 2nd variety), which points to the first child markup object in the document. If there are no markup objects in the document, this operation returns descendant_end().

Remarks

Use this operation to obtain a descendant iterator which can be used to traverse every markup object in the document in a pre-order fashion. The first descendant node in a pre-order traversal is by nature of the pre-order traversal, the first child markup object of the called node. This operation is also available in element (see element::descendant_begin()).

Complexity

Constant

Example

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

// create a unary predicate which checks for the table element
bool is_table(Xport::markup& mkup) {return mkup.tag() == Xport::table; }

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 table elements in the document
  markup::size_type table_count = std::count_if(doc.descendant_begin(), doc.descendant_end(), is_table);
  std::cout << "Xport Brochure contains " << table_count << " table elements.\n";
  return 0;
}