Xport Interface: markup::pop_front

For a derived element object, erases the first child element.

  void markup::pop_front();

Parameters

None

Returns

Nothing

Remarks

This operation is revelant only if it is called on an element derived object. The behavior is undefined if called on a pcdata, comment, or procinstr object, or if called on an element object which has no children. Caller is responsible to insure this operation is called on only element derived objects which has at least one child markup object.

There is some misconseption of this operation's return value, as many assume that it erases the first element while returning it's value. This operation does not return the value of the erased markup object. If you need the value of the forst markup object in an element, use the markup::front() operation.

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 an unordered list to the body
  markup::iterator it = doc.body()->insert(element(ul));
  *it << (element(li) << "List item 1");
  *it << (element(li) << "List item 2");
  *it << (element(li) << "List item 3");
  *it << (element(li) << "List item 4");
  *it << (element(li) << "List item 5");

  // erase the first 2 list items
  it->pop_front();
  it->pop_front();

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

  return 0;
}