Xport Interface: markup::iterator::operator *

Dereference operator for markup::iterator and markup::const_iterator.

markup& iterator::operator *() const; iterator

const markup& const_iterator::operator *() const; const_iterator

Parameters

None

Returns

Returns a reference (or const reference for const_iterator) to the underlying markup object.

Remarks

Dereferences the markup iterator, returning a reference to the underlying markup object (for iterator), and a const reference to the underlying markup object (for const_iterator). This can be very handy, especially for the iterator, as it allows the insertion of other child markup objects using the insertion operator, as shown in the example below.

Complexity

Constant

Example

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

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

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

  // insert a unordered list in the body
  markup::iterator it = doc.body()->insert(element(ul));
  *it << (element(li) << "Item 1");
  *it << (element(li) << "Item 2");
  *it << (element(li) << "Item 3");

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

  // use the iterator to traverse the unordered list
  it = it->begin();
  fmtr << *it;
  ++it;
  fmtr << *it;
  ++it;
  fmtr << *it;
}