Xport Interface: document::document

Constructor for document.

document::document(
  document_formation formation = document_formation(0)
);

Parameters

formation

A document_formation emumerator, which determines if the document will have root elements present after being created. This optional argument can be one of two values, the default value of document_formation(0), and root_doc. If the document object is to be cleared of all elements, no argument should be supplied. Supply the root_doc argument to have the document contain the root elements after being created, thus making the document a root document.

Returns

Nothing.

Remarks

Constructor for document. If supplied no argument, constructs an empty document object. If supplied the enumerator root_doc, the constructed document object will include the root elements. document_formation(0) and root_doc are the only possible arguments which can be passed in document's constructor.

Complexity

Constant

Example

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

// create a unary predicate which checks if the markup object is an element
bool is_element(Xport::markup& mkup) {return mkup.markup_type() == Xport::mt_element; }

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

  // create a non-root doc
  document doc1;

  // count the number of elements in the document
  markup::size_type element_count = std::count_if(doc1.descendant_begin(), doc1.descendant_end(), is_element);
  std::cout << "non-root document contains " << element_count << " elements.\n";

  // create a root doc
  document doc2(root_doc);

  // count the number of elements in the document
  element_count = std::count_if(doc2.descendant_begin(), doc2.descendant_end(), is_element);
  std::cout << "root document contains " << element_count << " elements.\n";

  return 0;
}