In Files

RiCal

 The RiCal module provides the outermost namespace, along with several convenience methods for parsing
 and building calendars and calendar components.

Constants

TimeWithZone

TimeWithZone will be set to ActiveSupport::TimeWithZone if the activesupport gem is loaded otherwise it will be nil

Public Class Methods

Alarm(&init_block) click to toggle source

return a new Alarm event or todo component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties of the new Alarm.

# File lib/ri_cal.rb, line 103
  def self.Alarm(&init_block)
    Component::Alarm.new(&init_block)
  end
Calendar(&init_block) click to toggle source

return a new Calendar. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and components of the new calendar.

# File lib/ri_cal.rb, line 110
  def self.Calendar(&init_block)
    Component::Calendar.new(&init_block)
  end
Event(&init_block) click to toggle source

return a new Event calendar component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and alarms of the new Event.

# File lib/ri_cal.rb, line 117
  def self.Event(&init_block)
    Component::Event.new(&init_block)
  end
Freebusy(&init_block) click to toggle source

return a new Freebusy calendar component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and components of the new Freebusy.

# File lib/ri_cal.rb, line 124
  def self.Freebusy(&init_block)
    Component::Freebusy.new(&init_block)
  end
Journal(&init_block) click to toggle source

return a new Journal calendar component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and components of the new Event.

# File lib/ri_cal.rb, line 131
  def self.Journal(&init_block)
    Component::Journal.new(&init_block)
  end
RationalOffset() click to toggle source

(Not documented)

# File lib/ri_cal.rb, line 172
  def self.RationalOffset
    self.ro_calls += 1
    @rational_offset ||= Hash.new {|h, seconds|
      self.ro_misses += 1
      h[seconds] = Rational(seconds, 86400)}
  end
Timezone(&init_block) click to toggle source

return a new Timezone calendar component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and timezone periods of the new Timezone.

# File lib/ri_cal.rb, line 138
  def self.Timezone(&init_block)
    Component::Timezone.new(&init_block)
  end
TimezonePeriod(&init_block) click to toggle source

return a new TimezonePeriod timezone component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties of the new TimezonePeriod.

# File lib/ri_cal.rb, line 145
  def self.TimezonePeriod(&init_block)
    Component::TimezonePeriod.new(&init_block)
  end
Todo(&init_block) click to toggle source

return a new Todo calendar component. If a block is provided it will will be executed in the context of a builder object which can be used to initialize the properties and alarms of the new Todo.

# File lib/ri_cal.rb, line 152
  def self.Todo(&init_block)
    Component::Todo.new(&init_block)
  end
parse(io) click to toggle source

Parse an io stream and return an array of iCalendar entities. Normally this will be an array of RiCal::Component::Calendar instances

# File lib/ri_cal.rb, line 82
  def self.parse(io)
    Parser.new(io).parse
  end
parse_string(string) click to toggle source

Parse a string and return an array of iCalendar entities. see RiCal.parse

# File lib/ri_cal.rb, line 88
  def self.parse_string(string)
    parse(StringIO.new(string))
  end
ro_calls() click to toggle source

(Not documented)

# File lib/ri_cal.rb, line 160
  def self.ro_calls
    @ro_calls ||= 0
  end
ro_calls=(value) click to toggle source

(Not documented)

# File lib/ri_cal.rb, line 156
  def self.ro_calls=(value)
    @ro_calls = value
  end
ro_misses() click to toggle source

(Not documented)

# File lib/ri_cal.rb, line 168
  def self.ro_misses
    @ro_misses ||= 0
  end
ro_misses=(value) click to toggle source

(Not documented)

# File lib/ri_cal.rb, line 164
  def self.ro_misses=(value)
    @ro_misses = value
  end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.