Module: RiCal::Properties::Calendar

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

Overview

  • ©2009 Rick DeNatale

  • All rights reserved. Refer to the file README.txt for the license

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:


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

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

Instance Method Details

#==(o) ⇒ Object

:nodoc:


127
128
129
130
131
132
133
134
135
136
# File 'lib/ri_cal/properties/calendar.rb', line 127

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:


146
147
# File 'lib/ri_cal/properties/calendar.rb', line 146

def add_date_times_to(required_timezones) #:nodoc:
end

#calscaleObject

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


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

def calscale
  calscale_property ? calscale_property.ruby_value : nil
end

#calscale_propertyObject

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


17
18
19
# File 'lib/ri_cal/properties/calendar.rb', line 17

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

#calscale_property_from_string(line) ⇒ Object

:nodoc:


27
28
29
# File 'lib/ri_cal/properties/calendar.rb', line 27

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

#export_properties_to(export_stream) ⇒ Object

:nodoc:


120
121
122
123
124
125
# File 'lib/ri_cal/properties/calendar.rb', line 120

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_methodObject

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


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

def icalendar_method
  method_property ? method_property.ruby_value : nil
end

#icalendar_method=(ruby_value) ⇒ Object

set the value of the METHOD property


50
51
52
# File 'lib/ri_cal/properties/calendar.rb', line 50

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

#initialize_copy(o) ⇒ Object

:nodoc:


138
139
140
141
142
143
144
# File 'lib/ri_cal/properties/calendar.rb', line 138

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_propertyObject

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


39
40
41
# File 'lib/ri_cal/properties/calendar.rb', line 39

def method_property
  @method_property
end

#method_property=(property_value) ⇒ Object

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


45
46
47
# File 'lib/ri_cal/properties/calendar.rb', line 45

def method_property=(property_value)
  @method_property = property_value
end

#method_property_from_string(line) ⇒ Object

:nodoc:


60
61
62
# File 'lib/ri_cal/properties/calendar.rb', line 60

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

#mutual_exclusion_violationObject

:nodoc:


159
160
161
# File 'lib/ri_cal/properties/calendar.rb', line 159

def mutual_exclusion_violation #:nodoc:
  false
end

#prodidObject

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


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

def prodid
  prodid_property ? prodid_property.ruby_value : nil
end

#prodid=(ruby_value) ⇒ Object

set the value of the PRODID property


83
84
85
# File 'lib/ri_cal/properties/calendar.rb', line 83

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

#prodid_propertyObject

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


72
73
74
# File 'lib/ri_cal/properties/calendar.rb', line 72

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


78
79
80
# File 'lib/ri_cal/properties/calendar.rb', line 78

def prodid_property=(property_value)
  @prodid_property = property_value
end

#prodid_property_from_string(line) ⇒ Object

:nodoc:


93
94
95
# File 'lib/ri_cal/properties/calendar.rb', line 93

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

#versionObject

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


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

def version
  version_property ? version_property.ruby_value : nil
end

#version_propertyObject

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


105
106
107
# File 'lib/ri_cal/properties/calendar.rb', line 105

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

#version_property_from_string(line) ⇒ Object

:nodoc:


115
116
117
# File 'lib/ri_cal/properties/calendar.rb', line 115

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