Class RTF::Information
In: lib/rtf/information.rb
Parent: Object

This class represents an information group for a RTF document.

Methods

created=   new   to_rtf   to_s  

Attributes

author  [W]  Attribute mutator.
author  [R]  Attribute accessor.
comments  [W]  Attribute mutator.
comments  [R]  Attribute accessor.
company  [R]  Attribute accessor.
company  [W]  Attribute mutator.
created  [R]  Attribute accessor.
title  [W]  Attribute mutator.
title  [R]  Attribute accessor.

Public Class methods

This is the constructor for the Information class.

Parameters

title:A string containing the document title information. Defaults to nil.
author:A string containing the document author information. Defaults to nil.
company:A string containing the company name information. Defaults to nil.
comments:A string containing the information comments. Defaults to nil to indicate no comments.
creation:A Time object or a String that can be parsed into a Time object (using ParseDate) indicating the document creation date and time. Defaults to nil to indicate the current date and time.

Exceptions

RTFError:Generated whenever invalid creation date/time details are specified.

Public Instance methods

This method provides the created attribute mutator for the Information class.

Parameters

setting:The new creation date/time setting for the object. This should be either a Time object or a string containing date/time details that can be parsed into a Time object (using the parsedate method).

Exceptions

RTFError:Generated whenever invalid creation date/time details are specified.

This method generates the RTF text for an Information object.

Parameters

indent:The number of spaces to prefix to the lines generated by the method. Defaults to zero.

This method creates a textual description for an Information object.

Parameters

indent:The number of spaces to prefix to the lines generated by the method. Defaults to zero.

[Validate]