aspose_cells_cloud 20.11 → 21.6

data/lib/aspose_cells_cloud/models/ole_object.rb

@@ -0,0 +1,567 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2021 Aspose.Cells Cloud
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+--------------------------------------------------------------------------------------------------------------------
+
+=end
+
+require 'date'
+
+module AsposeCellsCloud
+
+  class OleObject
+    attr_accessor :alternative_text
+
+    attr_accessor :bottom
+
+    attr_accessor :top
+
+    attr_accessor :width
+
+    attr_accessor :html_text
+
+    attr_accessor :text_vertical_alignment
+
+    attr_accessor :auto_shape_type
+
+    attr_accessor :is_printable
+
+    attr_accessor :upper_left_column
+
+    attr_accessor :is_lock_aspect_ratio
+
+    attr_accessor :is_group
+
+    attr_accessor :rotation_angle
+
+    attr_accessor :z_order_position
+
+    attr_accessor :text_horizontal_overflow
+
+    attr_accessor :mso_drawing_type
+
+    attr_accessor :text_orientation_type
+
+    attr_accessor :placement
+
+    attr_accessor :name
+
+    attr_accessor :is_word_art
+
+    attr_accessor :linked_cell
+
+    attr_accessor :upper_left_row
+
+    attr_accessor :is_locked
+
+    attr_accessor :lower_right_row
+
+    attr_accessor :is_text_wrapped
+
+    attr_accessor :y
+
+    attr_accessor :x
+
+    attr_accessor :is_hidden
+
+    attr_accessor :left
+
+    attr_accessor :right
+
+    attr_accessor :text
+
+    attr_accessor :lower_right_column
+
+    attr_accessor :height
+
+    attr_accessor :text_horizontal_alignment
+
+    attr_accessor :text_vertical_overflow
+
+    attr_accessor :link
+
+    attr_accessor :display_as_icon
+
+    attr_accessor :file_format_type
+
+    attr_accessor :source_full_name
+
+    attr_accessor :is_auto_size
+
+    attr_accessor :image_source_full_name
+
+    attr_accessor :prog_id
+
+    attr_accessor :is_link
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'alternative_text' => :'AlternativeText',
+        :'bottom' => :'Bottom',
+        :'top' => :'Top',
+        :'width' => :'Width',
+        :'html_text' => :'HtmlText',
+        :'text_vertical_alignment' => :'TextVerticalAlignment',
+        :'auto_shape_type' => :'AutoShapeType',
+        :'is_printable' => :'IsPrintable',
+        :'upper_left_column' => :'UpperLeftColumn',
+        :'is_lock_aspect_ratio' => :'IsLockAspectRatio',
+        :'is_group' => :'IsGroup',
+        :'rotation_angle' => :'RotationAngle',
+        :'z_order_position' => :'ZOrderPosition',
+        :'text_horizontal_overflow' => :'TextHorizontalOverflow',
+        :'mso_drawing_type' => :'MsoDrawingType',
+        :'text_orientation_type' => :'TextOrientationType',
+        :'placement' => :'Placement',
+        :'name' => :'Name',
+        :'is_word_art' => :'IsWordArt',
+        :'linked_cell' => :'LinkedCell',
+        :'upper_left_row' => :'UpperLeftRow',
+        :'is_locked' => :'IsLocked',
+        :'lower_right_row' => :'LowerRightRow',
+        :'is_text_wrapped' => :'IsTextWrapped',
+        :'y' => :'Y',
+        :'x' => :'X',
+        :'is_hidden' => :'IsHidden',
+        :'left' => :'Left',
+        :'right' => :'Right',
+        :'text' => :'Text',
+        :'lower_right_column' => :'LowerRightColumn',
+        :'height' => :'Height',
+        :'text_horizontal_alignment' => :'TextHorizontalAlignment',
+        :'text_vertical_overflow' => :'TextVerticalOverflow',
+        :'link' => :'link',
+        :'display_as_icon' => :'DisplayAsIcon',
+        :'file_format_type' => :'FileFormatType',
+        :'source_full_name' => :'SourceFullName',
+        :'is_auto_size' => :'IsAutoSize',
+        :'image_source_full_name' => :'ImageSourceFullName',
+        :'prog_id' => :'ProgID',
+        :'is_link' => :'IsLink'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'alternative_text' => :'String',
+        :'bottom' => :'Integer',
+        :'top' => :'Integer',
+        :'width' => :'Integer',
+        :'html_text' => :'String',
+        :'text_vertical_alignment' => :'String',
+        :'auto_shape_type' => :'String',
+        :'is_printable' => :'BOOLEAN',
+        :'upper_left_column' => :'Integer',
+        :'is_lock_aspect_ratio' => :'BOOLEAN',
+        :'is_group' => :'BOOLEAN',
+        :'rotation_angle' => :'Float',
+        :'z_order_position' => :'Integer',
+        :'text_horizontal_overflow' => :'String',
+        :'mso_drawing_type' => :'String',
+        :'text_orientation_type' => :'String',
+        :'placement' => :'String',
+        :'name' => :'String',
+        :'is_word_art' => :'BOOLEAN',
+        :'linked_cell' => :'String',
+        :'upper_left_row' => :'Integer',
+        :'is_locked' => :'BOOLEAN',
+        :'lower_right_row' => :'Integer',
+        :'is_text_wrapped' => :'BOOLEAN',
+        :'y' => :'Integer',
+        :'x' => :'Integer',
+        :'is_hidden' => :'BOOLEAN',
+        :'left' => :'Integer',
+        :'right' => :'Integer',
+        :'text' => :'String',
+        :'lower_right_column' => :'Integer',
+        :'height' => :'Integer',
+        :'text_horizontal_alignment' => :'String',
+        :'text_vertical_overflow' => :'String',
+        :'link' => :'Link',
+        :'display_as_icon' => :'BOOLEAN',
+        :'file_format_type' => :'String',
+        :'source_full_name' => :'String',
+        :'is_auto_size' => :'BOOLEAN',
+        :'image_source_full_name' => :'String',
+        :'prog_id' => :'String',
+        :'is_link' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'AlternativeText')
+        self.alternative_text = attributes[:'AlternativeText']
+      end
+
+      if attributes.has_key?(:'Bottom')
+        self.bottom = attributes[:'Bottom']
+      end
+
+      if attributes.has_key?(:'Top')
+        self.top = attributes[:'Top']
+      end
+
+      if attributes.has_key?(:'Width')
+        self.width = attributes[:'Width']
+      end
+
+      if attributes.has_key?(:'HtmlText')
+        self.html_text = attributes[:'HtmlText']
+      end
+
+      if attributes.has_key?(:'TextVerticalAlignment')
+        self.text_vertical_alignment = attributes[:'TextVerticalAlignment']
+      end
+
+      if attributes.has_key?(:'AutoShapeType')
+        self.auto_shape_type = attributes[:'AutoShapeType']
+      end
+
+      if attributes.has_key?(:'IsPrintable')
+        self.is_printable = attributes[:'IsPrintable']
+      end
+
+      if attributes.has_key?(:'UpperLeftColumn')
+        self.upper_left_column = attributes[:'UpperLeftColumn']
+      end
+
+      if attributes.has_key?(:'IsLockAspectRatio')
+        self.is_lock_aspect_ratio = attributes[:'IsLockAspectRatio']
+      end
+
+      if attributes.has_key?(:'IsGroup')
+        self.is_group = attributes[:'IsGroup']
+      end
+
+      if attributes.has_key?(:'RotationAngle')
+        self.rotation_angle = attributes[:'RotationAngle']
+      end
+
+      if attributes.has_key?(:'ZOrderPosition')
+        self.z_order_position = attributes[:'ZOrderPosition']
+      end
+
+      if attributes.has_key?(:'TextHorizontalOverflow')
+        self.text_horizontal_overflow = attributes[:'TextHorizontalOverflow']
+      end
+
+      if attributes.has_key?(:'MsoDrawingType')
+        self.mso_drawing_type = attributes[:'MsoDrawingType']
+      end
+
+      if attributes.has_key?(:'TextOrientationType')
+        self.text_orientation_type = attributes[:'TextOrientationType']
+      end
+
+      if attributes.has_key?(:'Placement')
+        self.placement = attributes[:'Placement']
+      end
+
+      if attributes.has_key?(:'Name')
+        self.name = attributes[:'Name']
+      end
+
+      if attributes.has_key?(:'IsWordArt')
+        self.is_word_art = attributes[:'IsWordArt']
+      end
+
+      if attributes.has_key?(:'LinkedCell')
+        self.linked_cell = attributes[:'LinkedCell']
+      end
+
+      if attributes.has_key?(:'UpperLeftRow')
+        self.upper_left_row = attributes[:'UpperLeftRow']
+      end
+
+      if attributes.has_key?(:'IsLocked')
+        self.is_locked = attributes[:'IsLocked']
+      end
+
+      if attributes.has_key?(:'LowerRightRow')
+        self.lower_right_row = attributes[:'LowerRightRow']
+      end
+
+      if attributes.has_key?(:'IsTextWrapped')
+        self.is_text_wrapped = attributes[:'IsTextWrapped']
+      end
+
+      if attributes.has_key?(:'Y')
+        self.y = attributes[:'Y']
+      end
+
+      if attributes.has_key?(:'X')
+        self.x = attributes[:'X']
+      end
+
+      if attributes.has_key?(:'IsHidden')
+        self.is_hidden = attributes[:'IsHidden']
+      end
+
+      if attributes.has_key?(:'Left')
+        self.left = attributes[:'Left']
+      end
+
+      if attributes.has_key?(:'Right')
+        self.right = attributes[:'Right']
+      end
+
+      if attributes.has_key?(:'Text')
+        self.text = attributes[:'Text']
+      end
+
+      if attributes.has_key?(:'LowerRightColumn')
+        self.lower_right_column = attributes[:'LowerRightColumn']
+      end
+
+      if attributes.has_key?(:'Height')
+        self.height = attributes[:'Height']
+      end
+
+      if attributes.has_key?(:'TextHorizontalAlignment')
+        self.text_horizontal_alignment = attributes[:'TextHorizontalAlignment']
+      end
+
+      if attributes.has_key?(:'TextVerticalOverflow')
+        self.text_vertical_overflow = attributes[:'TextVerticalOverflow']
+      end
+
+      if attributes.has_key?(:'link')
+        self.link = attributes[:'link']
+      end
+
+      if attributes.has_key?(:'DisplayAsIcon')
+        self.display_as_icon = attributes[:'DisplayAsIcon']
+      end
+
+      if attributes.has_key?(:'FileFormatType')
+        self.file_format_type = attributes[:'FileFormatType']
+      end
+
+      if attributes.has_key?(:'SourceFullName')
+        self.source_full_name = attributes[:'SourceFullName']
+      end
+
+      if attributes.has_key?(:'IsAutoSize')
+        self.is_auto_size = attributes[:'IsAutoSize']
+      end
+
+      if attributes.has_key?(:'ImageSourceFullName')
+        self.image_source_full_name = attributes[:'ImageSourceFullName']
+      end
+
+      if attributes.has_key?(:'ProgID')
+        self.prog_id = attributes[:'ProgID']
+      end
+
+      if attributes.has_key?(:'IsLink')
+        self.is_link = attributes[:'IsLink']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          alternative_text == o.alternative_text &&
+          bottom == o.bottom &&
+          top == o.top &&
+          width == o.width &&
+          html_text == o.html_text &&
+          text_vertical_alignment == o.text_vertical_alignment &&
+          auto_shape_type == o.auto_shape_type &&
+          is_printable == o.is_printable &&
+          upper_left_column == o.upper_left_column &&
+          is_lock_aspect_ratio == o.is_lock_aspect_ratio &&
+          is_group == o.is_group &&
+          rotation_angle == o.rotation_angle &&
+          z_order_position == o.z_order_position &&
+          text_horizontal_overflow == o.text_horizontal_overflow &&
+          mso_drawing_type == o.mso_drawing_type &&
+          text_orientation_type == o.text_orientation_type &&
+          placement == o.placement &&
+          name == o.name &&
+          is_word_art == o.is_word_art &&
+          linked_cell == o.linked_cell &&
+          upper_left_row == o.upper_left_row &&
+          is_locked == o.is_locked &&
+          lower_right_row == o.lower_right_row &&
+          is_text_wrapped == o.is_text_wrapped &&
+          y == o.y &&
+          x == o.x &&
+          is_hidden == o.is_hidden &&
+          left == o.left &&
+          right == o.right &&
+          text == o.text &&
+          lower_right_column == o.lower_right_column &&
+          height == o.height &&
+          text_horizontal_alignment == o.text_horizontal_alignment &&
+          text_vertical_overflow == o.text_vertical_overflow &&
+          link == o.link &&
+          display_as_icon == o.display_as_icon &&
+          file_format_type == o.file_format_type &&
+          source_full_name == o.source_full_name &&
+          is_auto_size == o.is_auto_size &&
+          image_source_full_name == o.image_source_full_name &&
+          prog_id == o.prog_id &&
+          is_link == o.is_link
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [alternative_text, bottom, top, width, html_text, text_vertical_alignment, auto_shape_type, is_printable, upper_left_column, is_lock_aspect_ratio, is_group, rotation_angle, z_order_position, text_horizontal_overflow, mso_drawing_type, text_orientation_type, placement, name, is_word_art, linked_cell, upper_left_row, is_locked, lower_right_row, is_text_wrapped, y, x, is_hidden, left, right, text, lower_right_column, height, text_horizontal_alignment, text_vertical_overflow, link, display_as_icon, file_format_type, source_full_name, is_auto_size, image_source_full_name, prog_id, is_link].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = AsposeCellsCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end