Class: PDF::Writer::Object::Catalog

### Home Classes Methods

### In Files

- lib/pdf/writer/object/catalog.rb

### Parent

PDF::Writer::Object

### Methods

- ::new
- #to_s

### Files

- ChangeLog

### Class/Module Index

Quicksearch

- PDF
- PDF::Charts
- PDF::Charts::StdDev
- PDF::Charts::StdDev::Label
- PDF::Charts::StdDev::Marker
- PDF::Charts::StdDev::Scale
- PDF::Math
- PDF::QuickRef
- PDF::SimpleTable
- PDF::SimpleTable::Column
- PDF::SimpleTable::Column::Heading
- PDF::TechBook
- PDF::TechBook::TagTocDots
- PDF::TechBook::TagXref
- PDF::Writer
- PDF::Writer::ARC4
- PDF::Writer::Complex
- PDF::Writer::External
- PDF::Writer::FontMetrics
- PDF::Writer::Graphics
- PDF::Writer::Graphics::ImageInfo
- PDF::Writer::Graphics::ImageInfo::Formats
- PDF::Writer::Graphics::ImageInfo::Type
- PDF::Writer::Lang
- PDF::Writer::Lang::EN
- PDF::Writer::OHash
- PDF::Writer::Object
- PDF::Writer::Object::Action
- PDF::Writer::Object::Annotation
- PDF::Writer::Object::Catalog
- PDF::Writer::Object::Contents
- PDF::Writer::Object::Destination
- PDF::Writer::Object::Encryption
- PDF::Writer::Object::Font
- PDF::Writer::Object::FontDescriptor
- PDF::Writer::Object::FontEncoding
- PDF::Writer::Object::Info
- PDF::Writer::Object::Outline
- PDF::Writer::Object::Outlines
- PDF::Writer::Object::Pages
- PDF::Writer::Object::Procset
- PDF::Writer::Object::ViewerPreferences
- PDF::Writer::OffsetReader
- PDF::Writer::PolygonPoint
- PDF::Writer::State
- PDF::Writer::StateStack
- PDF::Writer::StrokeStyle

No matching classes.

# PDF::Writer::Object::Catalog

Define the document catalog, the overall controller for the document

### Attributes

open_here[RW]
outlines[RW]
page_mode[RW]
pages[RW]
viewer_preferences[RW]

### Public Class Methods

new(parent) click to toggle source

    # File lib/pdf/writer/object/catalog.rb, line 13
    def initialize(parent)
      super(parent)

      @outlines           = nil
      @pages              = nil
      @open_here          = nil
      @viewer_preferences  = nil
      @page_mode          = nil
    end

### Public Instance Methods

to_s() click to toggle source

    # File lib/pdf/writer/object/catalog.rb, line 29
    def to_s
      res = "\n#{@oid} 0 obj\n<< /Type /Catalog"
      res << "\n/Outlines #{@outlines.oid} 0 R" unless @outlines.nil?
      res << "\n/Pages #{@pages.oid} 0 R" unless @pages.nil?
      res << "\n/ViewerPreferences #{@viewer_preferences.oid} 0 R" if @viewer_preferences and @parent.version >= '1.2'
      res << "\n/OpenAction #{@open_here.oid} 0 R" unless @open_here.nil?
      res << "\n/PageMode /#{@page_mode}" unless @page_mode.nil?
      res << "\n/Version /#{@parent.version}" if @parent.version >= '1.4'
      res << ">>\nendobj"
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.