Class Hierarchy   Compound List   File List   Header Files   Compound Members   File Members  

---

FormattedText Class Reference

Control structure for outputting a tree of data Handles indentation automatically. More...

#include <common/formatted.h>

List of all members.

Public Members

• FormattedText ( int maxline = 80, int the_indent = 4, bool nolinemerge=false)

  Create a formatted text object. More...

• String pointer_header (class String, void *)

  Output a header for a pointer. More...

• void set_use_diff_mode (bool diff)

  Set (or reset) use of diff mode for pointers diff mode is useful when you want to diff output from different runs.

• void set_special_print_mode (PrintAddress *p)

  Use your own class for printing pointers.

• ~FormattedText ()
• void start_block (const String &title)

  Start and indented block with the given title.

• void set_value (const String &val)

  set_value - set the value associated with an entry entries can have values or children, not both.

• void set_value (const LString &val)
• void set_value (int i)
• void set_value (bool b)
• void set_value (long l)
• void set_value (double d)
• void set_value (LString &l)
• void set_value (const char *c)
• void set_value (const IInteger &v)
• void set_value (const void *p)
• void end_block ()

  EndBlock - return to previous level.

• int get_indent (int cur,TextBlock *block) const

  get indentation required for given text.

• int total_len (TextBlock *block) const
• String get_value () const

  get value of text block as a String.

• String get_value (const String cur_pad,const String indent,bool no_newlines,TextBlock *block) const

---

Detailed Description

Control structure for outputting a tree of data Handles indentation automatically.

---

Member Function Documentation

FormattedText::FormattedText (int maxline = 80, int the_indent = 4, bool nolinemerge = false)

Create a formatted text object.

Parameters:

maxline - {longest line to output (default 80)}

the_indent - {indent for nested fields (default 4)}

nolinemerge - {merge short lines (default false)}

String FormattedText::pointer_header (class String, void *)

Output a header for a pointer.

Output looks like par1[pointer]=>

Parameters:

identifying - string}

the - pointer}

See also:

PrintAddress

void FormattedText::set_use_diff_mode (bool diff)

Set (or reset) use of diff mode for pointers diff mode is useful when you want to diff output from different runs.

void FormattedText::set_special_print_mode (PrintAddress * p)

Use your own class for printing pointers.

FormattedText::~FormattedText ()

void FormattedText::start_block (const String & title)

Start and indented block with the given title.

void FormattedText::set_value (const String & val)

set_value - set the value associated with an entry entries can have values or children, not both.

void FormattedText::set_value (const LString & val)

void FormattedText::set_value (int i)

void FormattedText::set_value (bool b)

void FormattedText::set_value (long l)

void FormattedText::set_value (double d)

void FormattedText::set_value (LString & l)

void FormattedText::set_value (const char * c)

void FormattedText::set_value (const IInteger & v)

void FormattedText::set_value (const void * p)

void FormattedText::end_block ()

EndBlock - return to previous level.

int FormattedText::get_indent (int cur, TextBlock * block) const

get indentation required for given text.

int FormattedText::total_len (TextBlock * block) const

String FormattedText::get_value () const

get value of text block as a String.

String FormattedText::get_value (const String cur_pad, const String indent, bool no_newlines, TextBlock * block) const

---

The documentation for this class was generated from the following file:

• formatted.h
• formatted.cpp

---