Class RTF::DocumentStyle
In: lib/rtf/style.rb
Parent: Style

This class represents styling attributes that are to be applied at the document level.

Methods

Constants

PORTRAIT = :portrait   Definition for a document orientation setting.
LANDSCAPE = :landscape   Definition for a document orientation setting.
DEFAULT_LEFT_MARGIN = 1800   Definition for a default margin setting.
DEFAULT_RIGHT_MARGIN = 1800   Definition for a default margin setting.
DEFAULT_TOP_MARGIN = 1440   Definition for a default margin setting.
DEFAULT_BOTTOM_MARGIN = 1440   Definition for a default margin setting.

Attributes

bottom_margin  [R]  Attribute accessor.
bottom_margin  [W]  Attribute mutator.
gutter  [W]  Attribute mutator.
gutter  [R]  Attribute accessor.
left_margin  [R]  Attribute accessor.
left_margin  [W]  Attribute mutator.
orientation  [R]  Attribute accessor.
orientation  [W]  Attribute mutator.
paper  [W]  Attribute mutator.
paper  [R]  Attribute accessor.
right_margin  [R]  Attribute accessor.
right_margin  [W]  Attribute mutator.
top_margin  [W]  Attribute mutator.
top_margin  [R]  Attribute accessor.

Public Class methods

This is a constructor for the DocumentStyle class. This creates a document style with a default paper setting of A4 and portrait orientation (all other attributes are nil).

Public Instance methods

This method fetches the height of the available work area space for a DocumentStyle object.

This method fetches the width of the available work area space for a DocumentStyle object.

This method overrides the is_document_style? method inherited from the Style class to always return true.

This method generates a string containing the prefix associated with a style object.

Parameters

document:A reference to the document using the style.

[Validate]