RiCal::Properties::Calendar

 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

Public Instance Methods

calscale() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 23
      def calscale
        calscale_property ? calscale_property.ruby_value : nil
      end
calscale_property() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 17
      def calscale_property
        @calscale_property ||= RiCal::PropertyValue::Text.convert(self, "GREGORIAN")
      end
icalendar_method() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 56
      def icalendar_method
        method_property ? method_property.ruby_value : nil
      end
icalendar_method=(ruby_value) click to toggle source

set the value of the METHOD property

# 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
method_property() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 39
      def method_property
        @method_property
      end
method_property=(property_value) click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 45
      def method_property=(property_value)
        @method_property = property_value
      end
prodid() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 89
      def prodid
        prodid_property ? prodid_property.ruby_value : nil
      end
prodid=(ruby_value) click to toggle source

set the value of the PRODID property

# 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_property() click to toggle source

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

# 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) click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 78
      def prodid_property=(property_value)
        @prodid_property = property_value
      end
version() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 111
      def version
        version_property ? version_property.ruby_value : nil
      end
version_property() click to toggle source

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

# File lib/ri_cal/properties/calendar.rb, line 105
      def version_property
        @version_property ||= RiCal::PropertyValue::Text.convert(self, "2.0")
      end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.