axlsx 1.0.8 → 1.0.9

data/lib/axlsx/stylesheet/border_pr.rb

@@ -3,7 +3,7 @@ module Axlsx
   class BorderPr
     
     # @return [Color] The color of this border part.
-    attr_accessor :color
+    attr_reader :color
 
     # @return [Symbol] The syle of this border part. 
     # @note 
@@ -22,7 +22,7 @@ module Axlsx
     #   :dashDotDot
     #   :mediumDashDotDot
     #   :slantDashDot
-    attr_accessor :style
+    attr_reader :style
 
     # @return [Symbol] The name of this border part
     # @note 
@@ -36,7 +36,7 @@ module Axlsx
     #   :diagonal
     #   :vertical
     #   :horizontal
-    attr_accessor :name
+    attr_reader :name
     
     # Creates a new Border Part Object
     # @option options [Color] color
@@ -49,15 +49,18 @@ module Axlsx
       end
     end
 
+    # @see name
     def name=(v) RestrictionValidator.validate "BorderPr.name", [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal], v; @name = v end
+    # @see color
     def color=(v) DataTypeValidator.validate(:color, Color, v); @color = v end    
+    # @see style
     def style=(v) RestrictionValidator.validate "BorderPr.style", [:none, :thin, :medium, :dashed, :dotted, :thick, :double, :hair, :mediumDashed, :dashDot, :mediumDashDot, :dashDotDot, :mediumDashDotDot, :slantDashDot], v; @style = v end
 
     # Serializes the border part
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
     # @return [String]
     def to_xml(xml)
-      xml.send(@name, :style=>@style) {
+      xml.send(@name, :style => @style) {
         @color.to_xml(xml) if @color.is_a? Color
       } 
     end

data/lib/axlsx/stylesheet/cell_alignment.rb

@@ -15,7 +15,7 @@ module Axlsx
     #   :centerContinuous
     #   :distributed
     # @return [Symbol]
-    attr_accessor :horizontal
+    attr_reader :horizontal
 
     # The vertical alignment of the cell.
     # @note
@@ -26,38 +26,38 @@ module Axlsx
     #   :justify
     #   :distributed
     # @return [Symbol]
-    attr_accessor :vertical
+    attr_reader :vertical
 
     # The textRotation of the cell.
     # @return [Integer]
-    attr_accessor :textRotation
+    attr_reader :textRotation
 
     # Indicate if the text of the cell should wrap
     # @return [Boolean]
-    attr_accessor :wrapText
+    attr_reader :wrapText
     
     # The amount of indent
     # @return [Integer]
-    attr_accessor :indent
+    attr_reader :indent
 
     # The amount of relativeIndent
     # @return [Integer]
-    attr_accessor :relativeIndent
+    attr_reader :relativeIndent
 
     # Indicate if the last line should be justified.
     # @return [Boolean]
-    attr_accessor :justifyLastLine
+    attr_reader :justifyLastLine
 
     # Indicate if the text should be shrunk to the fit in the cell.
     # @return [Boolean]
-    attr_accessor :shrinkToFit
+    attr_reader :shrinkToFit
 
     # The reading order of the text
     # 0 Context Dependent 
     # 1 Left-to-Right
     # 2 Right-to-Left
     # @return [Integer]
-    attr_accessor :readingOrder
+    attr_reader :readingOrder
     
     # Create a new cell_alignment object
     # @option options [Symbol] horizontal
@@ -75,14 +75,23 @@ module Axlsx
       end
     end        
     
+    # @see horizontal
     def horizontal=(v) Axlsx::validate_horizontal_alignment v; @horizontal = v end    
+    # @see vertical
     def vertical=(v) Axlsx::validate_vertical_alignment v; @vertical = v end    
+    # @see textRotation
     def textRotation=(v) Axlsx::validate_unsigned_int v; @textRotation = v end    
+    # @see wrapText
     def wrapText=(v) Axlsx::validate_boolean v; @wrapText = v end    
+    # @see indent
     def indent=(v) Axlsx::validate_unsigned_int v; @indent = v end    
+    # @see relativeIndent
     def relativeIndent=(v) Axlsx::validate_int v; @relativeIndent = v end    
+    # @see justifyLastLine
     def justifyLastLine=(v) Axlsx::validate_boolean v; @justifyLastLine = v end    
+    # @see shrinkToFit
     def shrinkToFit=(v) Axlsx::validate_boolean v; @shrinkToFit = v end    
+    # @see readingOrder
     def readingOrder=(v) Axlsx::validate_unsigned_int v; @readingOrder = v end  
 
     # Serializes the cell alignment

data/lib/axlsx/stylesheet/cell_protection.rb

@@ -6,11 +6,11 @@ module Axlsx
     
     # specifies locking for cells that have the style containing this protection
     # @return [Boolean]
-    attr_accessor :hidden
+    attr_reader :hidden
 
     # specifies if the cells that have the style containing this protection
     # @return [Boolean]
-    attr_accessor :locked
+    attr_reader :locked
 
     # Creates a new CellProtection
     # @option options [Boolean] hidden value for hidden protection
@@ -20,7 +20,10 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
+
+    # @see hidden
     def hidden=(v) Axlsx::validate_boolean v; @hidden = v end    
+    # @see locked
     def locked=(v) Axlsx::validate_boolean v; @locked = v end    
 
     # Serializes the cell protection

data/lib/axlsx/stylesheet/cell_style.rb

@@ -5,29 +5,29 @@ module Axlsx
   class CellStyle
     # The name of this cell style
     # @return [String]
-    attr_accessor :name
+    attr_reader :name
     
     # The formatting record id this named style utilizes
     # @return [Integer]
     # @see Axlsx::Xf
-    attr_accessor :xfId
+    attr_reader :xfId
 
     # The buildinId to use when this named style is applied
     # @return [Integer]
     # @see Axlsx::NumFmt
-    attr_accessor :builtinId
+    attr_reader :builtinId
 
     # Determines if this formatting is for an outline style, and what level of the outline it is to be applied to.
     # @return [Integer]
-    attr_accessor :iLevel
+    attr_reader :iLevel
 
     # Determines if this named style should show in the list of styles when using excel
     # @return [Boolean]
-    attr_accessor :hidden
+    attr_reader :hidden
 
     # Indicates that the build in style reference has been customized.
     # @return [Boolean]
-    attr_accessor :customBuiltin
+    attr_reader :customBuiltin
 
     # Creats a new CellStyle object
     # @option options [String] name
@@ -41,12 +41,17 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
       end
     end
-
+    # @see name
     def name=(v)  Axlsx::validate_string v; @name = v end
+    # @see xfId
     def xfId=(v) Axlsx::validate_unsigned_int v; @xfId = v end
+    # @see builtinId
     def builtinId=(v) Axlsx::validate_unsigned_int v; @builtinId = v end
+    # @see iLivel
     def iLevel=(v) Axlsx::validate_unsigned_int v; @iLevel = v end
+    # @see hidden
     def hidden=(v) Axlsx::validate_boolean v; @hidden = v end
+    # @see customBuiltin
     def customBuiltin=(v) Axlsx::validate_boolean v; @customBuiltin = v end
 
     # Serializes the cell style

data/lib/axlsx/stylesheet/color.rb

@@ -3,11 +3,11 @@ module Axlsx
   class Color
     # Determines if the color is system color dependant
     # @return [Boolean]
-    attr_accessor :auto
+    attr_reader :auto
     
     # Backwards compatability color index
     # return [Integer]
-    #attr_accessor :indexed
+    #attr_reader :indexed
 
     # The color as defined in rgb terms. 
     # @note 
@@ -16,16 +16,16 @@ module Axlsx
     #  "FF000000" is black
     #  "FFFFFFFF" is white
     # @return [String]
-    attr_accessor :rgb
+    attr_reader :rgb
 
     # no support for theme just yet
     # @return [Integer]
-    #attr_accessor :theme
+    #attr_reader :theme
     
     # The tint value.
     # @note valid values are between -1.0 and 1.0
     # @return [Float]
-    attr_accessor :tint
+    attr_reader :tint
     
     # Creates a new Color object
     # @option options [Boolean] auto
@@ -37,9 +37,11 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
       end
     end
-    
+    # @see auto
     def auto=(v) Axlsx::validate_boolean v; @auto = v end    
+    # @see rgb
     def rgb=(v) Axlsx::validate_string v; @rgb = v end    
+    # @see tint
     def tint=(v) Axlsx::validate_float v; @tint = v end
 
     # This version does not support themes

data/lib/axlsx/stylesheet/fill.rb

@@ -8,7 +8,7 @@ module Axlsx
 
     # The type of fill
     # @return [PatternFill, GradientFill]
-    attr_accessor :fill_type
+    attr_reader :fill_type
 
     # Creates a new Fill object
     # @param [PatternFill, GradientFill] fill_type 
@@ -24,6 +24,7 @@ module Axlsx
       xml.fill { @fill_type.to_xml(xml) }
     end
 
+    # @see fill_type
     def fill_type=(v) DataTypeValidator.validate "Fill.fill_type", [PatternFill, GradientFill], v; @fill_type = v; end
 
 

data/lib/axlsx/stylesheet/font.rb

@@ -5,7 +5,7 @@ module Axlsx
   class Font
     # The name of the font
     # @return [String]
-    attr_accessor :name
+    attr_reader :name
     
     # The charset of the font
     # @return [Integer]
@@ -30,7 +30,7 @@ module Axlsx
     #   222 THAI_CHARSET
     #   238 EASTEUROPE_CHARSET
     #   255 OEM_CHARSET
-    attr_accessor :charset
+    attr_reader :charset
     
     # The font's family
     # @note 
@@ -43,43 +43,43 @@ module Axlsx
     #   5 Decorative
     #   6..14 Reserved for future use
     # @return [Integer]
-    attr_accessor :family
+    attr_reader :family
 
     # Indicates if the font should be rendered in *bold*
     # @return [Boolean]
-    attr_accessor :b
+    attr_reader :b
 
     # Indicates if the font should be rendered italicized
     # @return [Boolean]
-    attr_accessor :i
+    attr_reader :i
 
     # Indicates if the font should be rendered with a strikthrough
     # @return [Boolean]
-    attr_accessor :strike
+    attr_reader :strike
 
     # Indicates if the font should be rendered with an outline
     # @return [Boolean]
-    attr_accessor :outline
+    attr_reader :outline
 
     # Indicates if the font should be rendered with a shadow
     # @return [Boolean]
-    attr_accessor :shadow
+    attr_reader :shadow
 
     # Indicates if the font should be condensed
     # @return [Boolean]
-    attr_accessor :condense
+    attr_reader :condense
 
     # The font's extend property
     # @return [Boolean]
-    attr_accessor  :extend
+    attr_reader  :extend
 
     # The color of the font
     # @return [Color]
-    attr_accessor :color
+    attr_reader :color
 
     # The size of the font.
     # @return [Integer]
-    attr_accessor :sz
+    attr_reader :sz
 
     # Creates a new Font
     # @option options [String] name
@@ -100,18 +100,29 @@ module Axlsx
         self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
       end
     end
-
+    # @see name
     def name=(v) Axlsx::validate_string v; @name = v end    
+    # @see charset
     def charset=(v) Axlsx::validate_unsigned_int v; @charset = v end
+    # @see family
     def family=(v) Axlsx::validate_unsigned_int v; @family = v end
+    # @see b
     def b=(v) Axlsx::validate_boolean v; @b = v end    
+    # @see i
     def i=(v) Axlsx::validate_boolean v; @i = v end
+    # @see strike
     def strike=(v) Axlsx::validate_boolean v; @strike = v end
+    # @see outline
     def outline=(v) Axlsx::validate_boolean v; @outline = v end
+    # @see shadow
     def shadow=(v) Axlsx::validate_boolean v; @shadow = v end    
+    # @see condense
     def condense=(v) Axlsx::validate_boolean v; @condense = v end
+    # @see extend
     def extend=(v) Axlsx::validate_boolean v; @extend = v end
+    # @see color
     def color=(v) DataTypeValidator.validate "Font.color", Color, v; @color=v end
+    # @see sz
     def sz=(v) Axlsx::validate_unsigned_int v; @sz=v end
 
     # Serializes the fill

data/lib/axlsx/stylesheet/gradient_fill.rb

@@ -10,27 +10,27 @@ module Axlsx
     #   :linear
     #   :path
     # @return [Symbol]
-    attr_accessor :type
+    attr_reader :type
 
     # Angle of the linear gradient
     # @return [Float]
-    attr_accessor :degree
+    attr_reader :degree
 
     # Percentage format left
     # @return [Float]
-    attr_accessor :left
+    attr_reader :left
 
     # Percentage format right
     # @return [Float]
-    attr_accessor :right
+    attr_reader :right
 
     # Percentage format top
     # @return [Float]
-    attr_accessor :top 
+    attr_reader :top 
 
     # Percentage format bottom
     # @return [Float]
-    attr_accessor :bottom
+    attr_reader :bottom
 
     # Collection of stop objects
     # @return [SimpleTypedList]
@@ -51,12 +51,18 @@ module Axlsx
       @stop = SimpleTypedList.new GradientStop
     end
 
+    # @see type
     def type=(v) Axlsx::validate_gradient_type v; @type = v end    
+    # @see degree
     def degree=(v) Axlsx::validate_float v; @degree = v end    
-    def left=(v) DataTypeValidator.validate "GradientFill.left", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @left = v end    
-    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @right = v end    
-    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @top = v end    
-    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |v| v >= 0.0 && v <= 1.0}; @bottom= v end    
+    # @see left
+    def left=(v) DataTypeValidator.validate "GradientFill.left", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @left = v end    
+    # @see right
+    def right=(v) DataTypeValidator.validate "GradientFill.right", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @right = v end    
+    # @see top
+    def top=(v) DataTypeValidator.validate "GradientFill.top", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @top = v end    
+    # @see bottom
+    def bottom=(v) DataTypeValidator.validate "GradientFill.bottom", Float, v, lambda { |arg| arg >= 0.0 && arg <= 1.0}; @bottom= v end    
 
     # Serializes the gradientFill
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.

data/lib/axlsx/stylesheet/gradient_stop.rb

@@ -6,11 +6,11 @@ module Axlsx
     # The color for this gradient stop
     # @return [Color]
     # @see Color
-    attr_accessor :color
+    attr_reader :color
 
     # The position of the color
     # @return [Float]
-    attr_accessor :position
+    attr_reader :position
 
     # Creates a new GradientStop object
     # @param [Color] color
@@ -20,8 +20,10 @@ module Axlsx
       self.position = position
     end
 
+    # @see color
     def color=(v) DataTypeValidator.validate "GradientStop.color", Color, v; @color=v end
-    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |v| v >= 0 && v <= 1}; @position = v end    
+    # @see position
+    def position=(v) DataTypeValidator.validate "GradientStop.position", Float, v, lambda { |arg| arg >= 0 && arg <= 1}; @position = v end    
 
     # Serializes the gradientStop
     # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.