aspose_slides_cloud 1.0.3 → 19.9.0

data/lib/aspose_slides_cloud/models/pdf_export_options.rb

@@ -1,101 +1,519 @@
+=begin
+Copyright (c) 2019 Aspose Pty Ltd
+
+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 AsposeSlidesCloud
-  # 
-  class PdfExportOptions < BaseObject
-    attr_accessor :text_compression, :embed_full_fonts, :compliance, :jpeg_quality, :save_metafiles_as_png, :password, :embed_true_type_fonts_for_ascii, :export_format
-    # attribute mapping from ruby-style variable name to JSON key
+  # Provides options that control how a presentation is saved in Pdf format.
+  class PdfExportOptions
+    # Export format.
+    attr_accessor :format
+
+    # Specifies compression type to be used for all textual content in the document.
+    attr_accessor :text_compression
+
+    # Determines if all characters of font should be embedded or only used subset.
+    attr_accessor :embed_full_fonts
+
+    # Desired conformance level for generated PDF document.
+    attr_accessor :compliance
+
+    # Returns or sets a value determining resolution of images inside PDF document.  Property affects on file size, time of export and image quality. The default value is 96.
+    attr_accessor :sufficient_resolution
+
+    # Returns or sets a value determining the quality of the JPEG images inside PDF document.
+    attr_accessor :jpeg_quality
+
+    # True to draw black frame around each slide.
+    attr_accessor :draw_slides_frame
+
+    # Specifies whether the generated document should include hidden slides or not. Default is false. 
+    attr_accessor :show_hidden_slides
+
+    # True to convert all metafiles used in a presentation to the PNG images.
+    attr_accessor :save_metafiles_as_png
+
+    # Setting user password to protect the PDF document. 
+    attr_accessor :password
+
+    # Determines if Aspose.Slides will embed common fonts for ASCII (33..127 code range) text. Fonts for character codes greater than 127 are always embedded. Common fonts list includes PDF's base 14 fonts and additional user specified fonts.
+    attr_accessor :embed_true_type_fonts_for_ascii
+
+    # Returns or sets an array of user-defined names of font families which Aspose.Slides should consider common.
+    attr_accessor :additional_common_font_families
+
+    # Gets or sets the position of the notes on the page.
+    attr_accessor :notes_position
+
+    # Gets or sets the position of the comments on the page.
+    attr_accessor :comments_position
+
+    # Gets or sets the width of the comment output area in pixels (Applies only if comments are displayed on the right).
+    attr_accessor :comments_area_width
+
+    # Gets or sets the color of comments area (Applies only if comments are displayed on the right).
+    attr_accessor :comments_area_color
+
+    # True if comments that have no author are displayed. (Applies only if comments are displayed).
+    attr_accessor :show_comments_by_no_author
+
+    # Image transparent color.
+    attr_accessor :image_transparent_color
+
+    # True to apply specified ImageTransparentColor  to an image.
+    attr_accessor :apply_image_transparent
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.any?{ |s| s.casecmp(value) == 0 }
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
-        # 
+        :'format' => :'Format',
         :'text_compression' => :'TextCompression',
-        
-        # 
         :'embed_full_fonts' => :'EmbedFullFonts',
-        
-        # 
         :'compliance' => :'Compliance',
-        
-        # 
+        :'sufficient_resolution' => :'SufficientResolution',
         :'jpeg_quality' => :'JpegQuality',
-        
-        # 
+        :'draw_slides_frame' => :'DrawSlidesFrame',
+        :'show_hidden_slides' => :'ShowHiddenSlides',
         :'save_metafiles_as_png' => :'SaveMetafilesAsPng',
-        
-        # 
         :'password' => :'Password',
-        
-        # 
         :'embed_true_type_fonts_for_ascii' => :'EmbedTrueTypeFontsForASCII',
-        
-        # 
-        :'export_format' => :'ExportFormat'
-        
+        :'additional_common_font_families' => :'AdditionalCommonFontFamilies',
+        :'notes_position' => :'NotesPosition',
+        :'comments_position' => :'CommentsPosition',
+        :'comments_area_width' => :'CommentsAreaWidth',
+        :'comments_area_color' => :'CommentsAreaColor',
+        :'show_comments_by_no_author' => :'ShowCommentsByNoAuthor',
+        :'image_transparent_color' => :'ImageTransparentColor',
+        :'apply_image_transparent' => :'ApplyImageTransparent'
       }
     end
 
-    # attribute type
+    # Attribute type mapping.
     def self.swagger_types
       {
+        :'format' => :'String',
         :'text_compression' => :'String',
         :'embed_full_fonts' => :'BOOLEAN',
         :'compliance' => :'String',
-        :'jpeg_quality' => :'String',
+        :'sufficient_resolution' => :'Float',
+        :'jpeg_quality' => :'Integer',
+        :'draw_slides_frame' => :'BOOLEAN',
+        :'show_hidden_slides' => :'BOOLEAN',
         :'save_metafiles_as_png' => :'BOOLEAN',
         :'password' => :'String',
         :'embed_true_type_fonts_for_ascii' => :'BOOLEAN',
-        :'export_format' => :'String'
-        
+        :'additional_common_font_families' => :'Array<String>',
+        :'notes_position' => :'String',
+        :'comments_position' => :'String',
+        :'comments_area_width' => :'Integer',
+        :'comments_area_color' => :'String',
+        :'show_comments_by_no_author' => :'BOOLEAN',
+        :'image_transparent_color' => :'String',
+        :'apply_image_transparent' => :'BOOLEAN'
       }
     end
 
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return if !attributes.is_a?(Hash) || attributes.empty?
+      return unless attributes.is_a?(Hash)
 
       # convert string to symbol for hash key
-      attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      
-      if attributes[:'TextCompression']
+      if attributes.has_key?(:'Format')
+        self.format = attributes[:'Format']
+      else
+        self.format = "pdf"
+      end
+
+      if attributes.has_key?(:'TextCompression')
         self.text_compression = attributes[:'TextCompression']
       end
-      
-      if attributes[:'EmbedFullFonts']
+
+      if attributes.has_key?(:'EmbedFullFonts')
         self.embed_full_fonts = attributes[:'EmbedFullFonts']
       end
-      
-      if attributes[:'Compliance']
+
+      if attributes.has_key?(:'Compliance')
         self.compliance = attributes[:'Compliance']
       end
-      
-      if attributes[:'JpegQuality']
+
+      if attributes.has_key?(:'SufficientResolution')
+        self.sufficient_resolution = attributes[:'SufficientResolution']
+      end
+
+      if attributes.has_key?(:'JpegQuality')
         self.jpeg_quality = attributes[:'JpegQuality']
       end
-      
-      if attributes[:'SaveMetafilesAsPng']
+
+      if attributes.has_key?(:'DrawSlidesFrame')
+        self.draw_slides_frame = attributes[:'DrawSlidesFrame']
+      end
+
+      if attributes.has_key?(:'ShowHiddenSlides')
+        self.show_hidden_slides = attributes[:'ShowHiddenSlides']
+      end
+
+      if attributes.has_key?(:'SaveMetafilesAsPng')
         self.save_metafiles_as_png = attributes[:'SaveMetafilesAsPng']
       end
-      
-      if attributes[:'Password']
+
+      if attributes.has_key?(:'Password')
         self.password = attributes[:'Password']
       end
-      
-      if attributes[:'EmbedTrueTypeFontsForASCII']
+
+      if attributes.has_key?(:'EmbedTrueTypeFontsForASCII')
         self.embed_true_type_fonts_for_ascii = attributes[:'EmbedTrueTypeFontsForASCII']
       end
-      
-      if attributes[:'ExportFormat']
-        self.export_format = attributes[:'ExportFormat']
+
+      if attributes.has_key?(:'AdditionalCommonFontFamilies')
+        if (value = attributes[:'AdditionalCommonFontFamilies']).is_a?(Array)
+          self.additional_common_font_families = value
+        end
+      end
+
+      if attributes.has_key?(:'NotesPosition')
+        self.notes_position = attributes[:'NotesPosition']
+      end
+
+      if attributes.has_key?(:'CommentsPosition')
+        self.comments_position = attributes[:'CommentsPosition']
+      end
+
+      if attributes.has_key?(:'CommentsAreaWidth')
+        self.comments_area_width = attributes[:'CommentsAreaWidth']
+      end
+
+      if attributes.has_key?(:'CommentsAreaColor')
+        self.comments_area_color = attributes[:'CommentsAreaColor']
+      end
+
+      if attributes.has_key?(:'ShowCommentsByNoAuthor')
+        self.show_comments_by_no_author = attributes[:'ShowCommentsByNoAuthor']
+      end
+
+      if attributes.has_key?(:'ImageTransparentColor')
+        self.image_transparent_color = attributes[:'ImageTransparentColor']
+      end
+
+      if attributes.has_key?(:'ApplyImageTransparent')
+        self.apply_image_transparent = attributes[:'ApplyImageTransparent']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @text_compression.nil?
+        invalid_properties.push('invalid value for "text_compression", text_compression cannot be nil.')
+      end
+
+      if @embed_full_fonts.nil?
+        invalid_properties.push('invalid value for "embed_full_fonts", embed_full_fonts cannot be nil.')
+      end
+
+      if @compliance.nil?
+        invalid_properties.push('invalid value for "compliance", compliance cannot be nil.')
+      end
+
+      if @sufficient_resolution.nil?
+        invalid_properties.push('invalid value for "sufficient_resolution", sufficient_resolution cannot be nil.')
+      end
+
+      if @jpeg_quality.nil?
+        invalid_properties.push('invalid value for "jpeg_quality", jpeg_quality cannot be nil.')
+      end
+
+      if @draw_slides_frame.nil?
+        invalid_properties.push('invalid value for "draw_slides_frame", draw_slides_frame cannot be nil.')
+      end
+
+      if @show_hidden_slides.nil?
+        invalid_properties.push('invalid value for "show_hidden_slides", show_hidden_slides cannot be nil.')
+      end
+
+      if @save_metafiles_as_png.nil?
+        invalid_properties.push('invalid value for "save_metafiles_as_png", save_metafiles_as_png cannot be nil.')
       end
-      
+
+      if @embed_true_type_fonts_for_ascii.nil?
+        invalid_properties.push('invalid value for "embed_true_type_fonts_for_ascii", embed_true_type_fonts_for_ascii cannot be nil.')
+      end
+
+      if @notes_position.nil?
+        invalid_properties.push('invalid value for "notes_position", notes_position cannot be nil.')
+      end
+
+      if @comments_position.nil?
+        invalid_properties.push('invalid value for "comments_position", comments_position cannot be nil.')
+      end
+
+      if @comments_area_width.nil?
+        invalid_properties.push('invalid value for "comments_area_width", comments_area_width cannot be nil.')
+      end
+
+      if @show_comments_by_no_author.nil?
+        invalid_properties.push('invalid value for "show_comments_by_no_author", show_comments_by_no_author cannot be nil.')
+      end
+
+      if @apply_image_transparent.nil?
+        invalid_properties.push('invalid value for "apply_image_transparent", apply_image_transparent cannot be nil.')
+      end
+
+      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 false if @text_compression.nil?
+      text_compression_validator = EnumAttributeValidator.new('String', ['None', 'Flate'])
+      return false unless text_compression_validator.valid?(@text_compression)
+      return false if @embed_full_fonts.nil?
+      return false if @compliance.nil?
+      compliance_validator = EnumAttributeValidator.new('String', ['Pdf15', 'PdfA1b'])
+      return false unless compliance_validator.valid?(@compliance)
+      return false if @sufficient_resolution.nil?
+      return false if @jpeg_quality.nil?
+      return false if @draw_slides_frame.nil?
+      return false if @show_hidden_slides.nil?
+      return false if @save_metafiles_as_png.nil?
+      return false if @embed_true_type_fonts_for_ascii.nil?
+      return false if @notes_position.nil?
+      notes_position_validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated'])
+      return false unless notes_position_validator.valid?(@notes_position)
+      return false if @comments_position.nil?
+      comments_position_validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right'])
+      return false unless comments_position_validator.valid?(@comments_position)
+      return false if @comments_area_width.nil?
+      return false if @show_comments_by_no_author.nil?
+      return false if @apply_image_transparent.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] text_compression Object to be assigned
     def text_compression=(text_compression)
-      allowed_values = ["None", "Flate"]
-      if text_compression && !allowed_values.include?(text_compression)
-        fail "invalid value for 'text_compression', must be one of #{allowed_values}"
+      validator = EnumAttributeValidator.new('String', ['None', 'Flate'])
+      unless validator.valid?(text_compression)
+        fail ArgumentError, 'invalid value for "text_compression", must be one of #{validator.allowable_values}.'
       end
       @text_compression = text_compression
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] compliance Object to be assigned
+    def compliance=(compliance)
+      validator = EnumAttributeValidator.new('String', ['Pdf15', 'PdfA1b'])
+      unless validator.valid?(compliance)
+        fail ArgumentError, 'invalid value for "compliance", must be one of #{validator.allowable_values}.'
+      end
+      @compliance = compliance
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] notes_position Object to be assigned
+    def notes_position=(notes_position)
+      validator = EnumAttributeValidator.new('String', ['None', 'BottomFull', 'BottomTruncated'])
+      unless validator.valid?(notes_position)
+        fail ArgumentError, 'invalid value for "notes_position", must be one of #{validator.allowable_values}.'
+      end
+      @notes_position = notes_position
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] comments_position Object to be assigned
+    def comments_position=(comments_position)
+      validator = EnumAttributeValidator.new('String', ['None', 'Bottom', 'Right'])
+      unless validator.valid?(comments_position)
+        fail ArgumentError, 'invalid value for "comments_position", must be one of #{validator.allowable_values}.'
+      end
+      @comments_position = comments_position
+    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 &&
+          format == o.format &&
+          text_compression == o.text_compression &&
+          embed_full_fonts == o.embed_full_fonts &&
+          compliance == o.compliance &&
+          sufficient_resolution == o.sufficient_resolution &&
+          jpeg_quality == o.jpeg_quality &&
+          draw_slides_frame == o.draw_slides_frame &&
+          show_hidden_slides == o.show_hidden_slides &&
+          save_metafiles_as_png == o.save_metafiles_as_png &&
+          password == o.password &&
+          embed_true_type_fonts_for_ascii == o.embed_true_type_fonts_for_ascii &&
+          additional_common_font_families == o.additional_common_font_families &&
+          notes_position == o.notes_position &&
+          comments_position == o.comments_position &&
+          comments_area_width == o.comments_area_width &&
+          comments_area_color == o.comments_area_color &&
+          show_comments_by_no_author == o.show_comments_by_no_author &&
+          image_transparent_color == o.image_transparent_color &&
+          apply_image_transparent == o.apply_image_transparent
+    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
+      [format, text_compression, embed_full_fonts, compliance, sufficient_resolution, jpeg_quality, draw_slides_frame, show_hidden_slides, save_metafiles_as_png, password, embed_true_type_fonts_for_ascii, additional_common_font_families, notes_position, comments_position, comments_area_width, comments_area_color, show_comments_by_no_author, image_transparent_color, apply_image_transparent].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 = AsposeSlidesCloud.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