Xport Interface: document::operator <<

Inserts/adds content (markup objects) to the document.

document& document::operator <<(
  const markup& mkup
);

Parameters

mkup

The markup object to insert into the document.

Returns

Returns a reference to the document object. This allows the natural chaining of this operation, as shown in the example below.

Remarks

This operation can be used in addition to document's insert() operation, to insert markup into the root of the document. Since the operation returns a reference to the document, this operation can be chained, as shown in the example below. Although this operation can be used to insert the doctype declaration and html element, the insertion of these markup types isn't necessary, since these elements will be included automatically when creating a root document. (see document's constructor).

Complexity

Constant

Example

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

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

  // create an xhtml strict empty document
  document doc;

  // insert a comment and html element
  doc << comment("Very simple document, with only the html element")
      << element(Xport::html);

  // output the document's head content
  formatter fmtr(std::cout);
  doc.write(fmtr);

  return 0;
}