Xport Interface: stylesheet_comment::write

Writes the called stylesheet_comment to a file or output stream, through a stylesheet_formatter object.

virtual bool stylesheet_comment::write(
  const stylesheet_formatter& fmtr
);

Parameters

fmtr

A formatter object, which allows the user to set specific formatting options before writing the stylesheet_comment.

Returns

true if the stylesheet_comment is written successfully, false otherwise.

Remarks

This operation is used to write a stylesheet_comment. Normally, however, you will not use this operation to write a single stylesheet comment. You'll normally use stylesheet::write() which writes the whole stylesheet, rather than a single comment. This operations was added for completeness, however, in case users would like to write portions of the stylesheet rather than the whole stylesheet.

In this operation, you pass a stylesheet_formatter which writes the stylesheet_comment to the file or output stream that was specified when creating the stylesheet_formatter object. A stylesheet_formatter is first created, and in it's constructor, the filename or output stream is specified.

Complexity

Linear

Example

Examples

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

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

  stylesheet ss;

  ss << stylesheet_comment("Sample stylesheet");

  ss << stylesheet_comment("---------- h1 rule for main heading ------------");
  ss << (stylesheet_rule("h1") << declaration(css::color, "red") << declaration(text_align, "center"));

  // iterate over all stylesheet items and send them to cout
  stylesheet_formatter fmtr(std::cout);

  stylesheet::iterator it = ss.begin();
  for (; it != ss.end(); ++it) {
    it->write(fmtr);
    std::cout << "\n";
  }
}