Xport Interface: markup::push_front

For a derived element object, inserts one or more markup objects or PCDATA at the beginning of the called element.

virtual markup::iterator markup::push_front(1st Variety
  >const markup& mkup
);

virtual markup::iterator markup::push_front(2nd Variety
  const std::string& pcdat
);

Parameters

mkup

A markup derived object, which can be one of the following, an element, pcdata, comment, or procinstr.

pcdat

A string argument which represents PCDATA to insert as content.

Returns

Returns an iterator which points to the inserted markup object.

Remarks

This operation is relevant only if it is called on an element derived object. If called on a pcdata, comment, or procinstr object, no action will take place, and the end() iterator will be returned.

The first variety is equivalent to the operation markup::insert(markup::begin(), markup& mkup). The second variety is equivalent to the operation markup::insert(markup::begin(), std::string& pcdat). This operation provides a handy way to insert markup at the beginning of the called element, rather than at the end of the called element, which is more customary.

Complexity

logarithmic

Example

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

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

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

  // add a comment and unordered list to the body
  doc.body()->push_back(comment("This comment will end up at the end of the body element."));
  markup::iterator it = doc.body()->push_front(element(ul));
  it->push_front(element(li) << "List item 1");
  it->push_front(element(li) << "List item 2");
  it->push_front(element(li) << "List item 3");
  it->push_front(element(li) << "List item 4");
  it->push_front(element(li) << "List item 5");

  doc.body()->push_front(comment("The list below will be in descending order"));

  // send the document to cout
  formatter fmtr(std::cout);
  doc.write(fmtr);
  std::cout << "\n\n";

  return 0;
}