Home	Xport Overview	Xport Download	XportPro Overview	Buy XportPro Now!

Xport Interface: `document::document_type`

Returns the document type of the called document.

  std::string document::document_type();

Parameters

None.

Returns

Returns a string which describes the type of document.

Remarks

Use this operation to determine the document type of the called document object. The document type of a document will be the document type specified when creating the document object. In Xport, the document type is specified as a template argument for most of the defined class templates. Since Xport uses type aliases to allow users of the library to avoid using template nomenclature, the document type for a specific document object depends on the type alias which was used to create the document object. The document types associated for the different document type aliases can be viewed in Xport's Usage Overview.

Currently, there are three document types supplied with Xport, xhtml strict 1.0, xhtml transitional 1.0, and xhtml frameset 1.0. Additional document types can easily be added, in most cases without changing any existing code in Xport, since Xport was designed so that document types can be seamlessly added.

The string values returned for the three document types currently supplied in Xport are listed below.

document type	document_type() return value
xhtml_strict	xhtml strict 1.0
xhtml_traditional	xhtml traditional 1.0
xthtml frameset	xhtml frameset 1.0

Complexity

Constant

Example

#include "xhtml_doc.h"
#include <string>
#include <cassert>

template<typename DT> void parse_document(Xport::xhtml_doc<DT, char>& doc);

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

  // create documents of three different doctypes
  document doc1(root_doc);
  tdocument doc2(root_doc);
  fdocument doc3(root_doc);

  // test the doctype
  assert(doc1.document_type() == "xhtml strict 1.0");
  assert(doc2.document_type() == "xhtml transitional 1.0");
  assert(doc3.document_type() == "xhtml frameset 1.0");

  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