Module: RiCal::Properties::Calendar

Included in:
Component::Calendar
Defined in:
lib/ri_cal/properties/calendar.rb

Overview

Properties::Calendar provides property accessing methods for the Calendar class This source file is generated by the rical:gen_propmodules rake tasks, DO NOT EDIT

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(mod) ⇒ Object

:nodoc:



152
153
154
 
# File 'lib/ri_cal/properties/calendar.rb', line 152

def self.included(mod) #:nodoc:
  mod.extend ClassMethods
end

Instance Method Details

#==(o) ⇒ Object

:nodoc:



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/ri_cal/properties/calendar.rb', line 124

def ==(o) #:nodoc:
  if o.class == self.class
  (calscale_property == o.calscale_property) &&
  (prodid_property == o.prodid_property) &&
  (version_property == o.version_property) &&
  (method_property == o.method_property)
  else
     super
  end
end

#add_date_times_to(required_timezones) ⇒ Object

:nodoc:



143
144
 
# File 'lib/ri_cal/properties/calendar.rb', line 143

def add_date_times_to(required_timezones) #:nodoc:
end

#calscale ⇒ Object

return the value of the CALSCALE property which will be an instance of String



20
21
22
 
# File 'lib/ri_cal/properties/calendar.rb', line 20

def calscale
  calscale_property ? calscale_property.ruby_value : nil
end

#calscale_property ⇒ Object

return the the CALSCALE property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property defines the calendar scale used for the calendar information specified in the calendar object.

see RFC 2445 4.7.1 p 73



14
15
16
 
# File 'lib/ri_cal/properties/calendar.rb', line 14

def calscale_property
  @calscale_property ||= RiCal::PropertyValue::Text.convert(self, "GREGORIAN")
end

#calscale_property_from_string(line) ⇒ Object

:nodoc:



24
25
26
 
# File 'lib/ri_cal/properties/calendar.rb', line 24

def calscale_property_from_string(line) # :nodoc:
  @calscale_property = RiCal::PropertyValue::Text.new(self, line)
end

#export_properties_to(export_stream) ⇒ Object

:nodoc:



117
118
119
120
121
122
 
# File 'lib/ri_cal/properties/calendar.rb', line 117

def export_properties_to(export_stream) #:nodoc:
  export_prop_to(export_stream, "CALSCALE", @calscale_property)
  export_prop_to(export_stream, "PRODID", @prodid_property)
  export_prop_to(export_stream, "VERSION", @version_property)
  export_prop_to(export_stream, "METHOD", @method_property)
end

#icalendar_method ⇒ Object

return the value of the METHOD property which will be an instance of String



53
54
55
 
# File 'lib/ri_cal/properties/calendar.rb', line 53

def icalendar_method
  method_property ? method_property.ruby_value : nil
end

#icalendar_method=(ruby_value) ⇒ Object

set the value of the METHOD property



47
48
49
 
# File 'lib/ri_cal/properties/calendar.rb', line 47

def icalendar_method=(ruby_value)
  self.method_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#initialize_copy(o) ⇒ Object

:nodoc:



135
136
137
138
139
140
141
 
# File 'lib/ri_cal/properties/calendar.rb', line 135

def initialize_copy(o) #:nodoc:
  super
  calscale_property = calscale_property && calscale_property.dup
  prodid_property = prodid_property && prodid_property.dup
  version_property = version_property && version_property.dup
  method_property = method_property && method_property.dup
end

#method_property ⇒ Object

return the the METHOD property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property defines the iCalendar object method associated with the calendar object

see RFC 2445 4.7.2 p 74-75



36
37
38
 
# File 'lib/ri_cal/properties/calendar.rb', line 36

def method_property
  @method_property
end

#method_property=(property_value) ⇒ Object

set the METHOD property property value should be an instance of RiCal::PropertyValueText



42
43
44
 
# File 'lib/ri_cal/properties/calendar.rb', line 42

def method_property=(property_value)
  @method_property = property_value
end

#method_property_from_string(line) ⇒ Object

:nodoc:



57
58
59
 
# File 'lib/ri_cal/properties/calendar.rb', line 57

def method_property_from_string(line) # :nodoc:
  @method_property = RiCal::PropertyValue::Text.new(self, line)
end

#mutual_exclusion_violation ⇒ Object

:nodoc:



156
157
158
 
# File 'lib/ri_cal/properties/calendar.rb', line 156

def mutual_exclusion_violation #:nodoc:
  false
end

#prodid ⇒ Object

return the value of the PRODID property which will be an instance of String



86
87
88
 
# File 'lib/ri_cal/properties/calendar.rb', line 86

def prodid
  prodid_property ? prodid_property.ruby_value : nil
end

#prodid=(ruby_value) ⇒ Object

set the value of the PRODID property



80
81
82
 
# File 'lib/ri_cal/properties/calendar.rb', line 80

def prodid=(ruby_value)
  self.prodid_property= RiCal::PropertyValue::Text.convert(self, ruby_value)
end

#prodid_property ⇒ Object

return the the PRODID property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property specifies the identifier for the product that created the iCalendar object.

see RFC 2445 4.7.3 pp 75-76



69
70
71
 
# File 'lib/ri_cal/properties/calendar.rb', line 69

def prodid_property
  @prodid_property ||= RiCal::PropertyValue::Text.convert(self, "-//com.denhaven2/NONSGML ri_cal gem//EN")
end

#prodid_property=(property_value) ⇒ Object

set the PRODID property property value should be an instance of RiCal::PropertyValueText



75
76
77
 
# File 'lib/ri_cal/properties/calendar.rb', line 75

def prodid_property=(property_value)
  @prodid_property = property_value
end

#prodid_property_from_string(line) ⇒ Object

:nodoc:



90
91
92
 
# File 'lib/ri_cal/properties/calendar.rb', line 90

def prodid_property_from_string(line) # :nodoc:
  @prodid_property = RiCal::PropertyValue::Text.new(self, line)
end

#version ⇒ Object

return the value of the VERSION property which will be an instance of String



108
109
110
 
# File 'lib/ri_cal/properties/calendar.rb', line 108

def version
  version_property ? version_property.ruby_value : nil
end

#version_property ⇒ Object

return the the VERSION property which will be an instances of RiCal::PropertyValueText

purpose (from RFC 2445)

This property specifies the identifier corresponding to thehighest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object.

see RFC 2445 4.7.4 pp 76-77



102
103
104
 
# File 'lib/ri_cal/properties/calendar.rb', line 102

def version_property
  @version_property ||= RiCal::PropertyValue::Text.convert(self, "2.0")
end

#version_property_from_string(line) ⇒ Object

:nodoc:



112
113
114
 
# File 'lib/ri_cal/properties/calendar.rb', line 112

def version_property_from_string(line) # :nodoc:
  @version_property = RiCal::PropertyValue::Text.new(self, line)
end