Home	Xport Overview	Xport Download	XportPro Overview	Buy XportPro Now!

Xport Interface: `comment::markup_type`

Returns the mt_comment enumerator of xhtml_markup_type, to indicate the called markup object is a comment object.

xhtml_markup_type comment::markup_type() const;

Parameters

None

Returns

Returns mt_comment, which is an enumerator of xhtml_markup_type.

Remarks

This operation is used to determine the derived type of the called object derived from markup. This operation is overridden from all types derived from markup to return the respective enumerator for that type. This operation is overridden in comment to simply return the enumerator mt_comment.

Many object oriented experts feel that operations such as this, break the object oriented paradigm, and that there should be no reason to disclose the derived type of an object. In practice, however, this need often arises, so this operation is included for those events.

Complexity

Constant

Example

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

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

  document doc(root_doc);

  // create a comment in the body element
  doc.body()->insert(comment("The content of the document goes here."));

  markup::iterator it = doc.body()->insert(element(ul));
  it->insert(comment("This is an unordered list"));
  *it << (element(li) << "List item 1");
  *it << (element(li) << "List item 2");

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

  // count the comments in the document
  int comment_count = 0;
  markup::const_descendant_iterator dit = doc.descendant_begin();
  for (; dit != doc.descendant_end(); ++dit) {
    if (dit->markup_type() == mt_comment) {
      ++comment_count;
    }
  }

  std::cout << "There are " << comment_count << " comments in the document.\n";

  return 0;
}

Datasoft Solutions is proud to present their landmark product, Work Time Studio. Utilizing the tree container library, Work Time Studio provides unparalleled features in personal time, project and task management software. If you're looking for a way to increase your productivity, visit Work Time Studio's product website, and start being more productive today.

XHTML Parsing &Objective Reporting Toolkit

Xport Interface: comment::markup_type