Class: AsposeSlidesCloud::ViewProperties

Inherits:
ResourceBase show all
Defined in:
lib/aspose_slides_cloud/models/view_properties.rb

Overview

Slides document properties.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ResourceBase

#alternate_links, #self_uri

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ViewProperties

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 109

def initialize(attributes = {})
  super

  if attributes.has_key?(:'LastView')
    self.last_view = attributes[:'LastView']
  end

  if attributes.has_key?(:'HorizontalBarState')
    self.horizontal_bar_state = attributes[:'HorizontalBarState']
  end

  if attributes.has_key?(:'VerticalBarState')
    self.vertical_bar_state = attributes[:'VerticalBarState']
  end

  if attributes.has_key?(:'PreferSingleView')
    self.prefer_single_view = attributes[:'PreferSingleView']
  end

  if attributes.has_key?(:'RestoredLeft')
    self.restored_left = attributes[:'RestoredLeft']
  end

  if attributes.has_key?(:'RestoredTop')
    self.restored_top = attributes[:'RestoredTop']
  end

  if attributes.has_key?(:'SlideViewProperties')
    self.slide_view_properties = attributes[:'SlideViewProperties']
  end

  if attributes.has_key?(:'NotesViewProperties')
    self.notes_view_properties = attributes[:'NotesViewProperties']
  end

  if attributes.has_key?(:'ShowComments')
    self.show_comments = attributes[:'ShowComments']
  end
end

Instance Attribute Details

#horizontal_bar_state ⇒ Object

Horizontal bar state.



32
33
34
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 32

def horizontal_bar_state
  @horizontal_bar_state
end

#last_view ⇒ Object

Last used view mode.



29
30
31
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 29

def last_view
  @last_view
end

#notes_view_properties ⇒ Object

Notes view mode properties.



50
51
52
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 50

def notes_view_properties
  @notes_view_properties
end

#prefer_single_view ⇒ Object

True to prefer single view.



38
39
40
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 38

def prefer_single_view
  @prefer_single_view
end

#restored_left ⇒ Object

The sizing of the side content region of the normal view, when the region is of a variable restored size.



41
42
43
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 41

def restored_left
  @restored_left
end

#restored_top ⇒ Object

The sizing of the top slide region of the normal view, when the region is of a variable restored size.



44
45
46
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 44

def restored_top
  @restored_top
end

#show_comments ⇒ Object

True if the comments should be shown.



53
54
55
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 53

def show_comments
  @show_comments
end

#slide_view_properties ⇒ Object

Slide view mode properties.



47
48
49
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 47

def slide_view_properties
  @slide_view_properties
end

#vertical_bar_state ⇒ Object

Vertical bar state.



35
36
37
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 35

def vertical_bar_state
  @vertical_bar_state
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 78

def self.attribute_map
  super.merge({
    :'last_view' => :'LastView',
    :'horizontal_bar_state' => :'HorizontalBarState',
    :'vertical_bar_state' => :'VerticalBarState',
    :'prefer_single_view' => :'PreferSingleView',
    :'restored_left' => :'RestoredLeft',
    :'restored_top' => :'RestoredTop',
    :'slide_view_properties' => :'SlideViewProperties',
    :'notes_view_properties' => :'NotesViewProperties',
    :'show_comments' => :'ShowComments',
  })
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 93

def self.swagger_types
  super.merge({
    :'last_view' => :'String',
    :'horizontal_bar_state' => :'String',
    :'vertical_bar_state' => :'String',
    :'prefer_single_view' => :'BOOLEAN',
    :'restored_left' => :'NormalViewRestoredProperties',
    :'restored_top' => :'NormalViewRestoredProperties',
    :'slide_view_properties' => :'CommonSlideViewProperties',
    :'notes_view_properties' => :'CommonSlideViewProperties',
    :'show_comments' => :'String',
  })
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 213

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      self_uri == o.self_uri &&
      alternate_links == o.alternate_links &&
      last_view == o.last_view &&
      horizontal_bar_state == o.horizontal_bar_state &&
      vertical_bar_state == o.vertical_bar_state &&
      prefer_single_view == o.prefer_single_view &&
      restored_left == o.restored_left &&
      restored_top == o.restored_top &&
      slide_view_properties == o.slide_view_properties &&
      notes_view_properties == o.notes_view_properties &&
      show_comments == o.show_comments
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 277

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 343

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 244

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    mapKey = self.class.attribute_map[key]
    if !mapKey.nil?
      val = attributes[mapKey]
      if val.nil?
        mapKeyString = mapKey.to_s
        mapKeyString[0] = mapKeyString[0].downcase
        mapKey = mapKeyString.to_sym
        val = attributes[mapKey]
      end
      if !val.nil?
        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 val.is_a?(Array)
            self.send("#{key}=", val.map { |v| _deserialize($1, v) })
          end
        else
          self.send("#{key}=", _deserialize(type, val))
        end
      end
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


231
232
233
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 237

def hash
  [self_uri, alternate_links, last_view, horizontal_bar_state, vertical_bar_state, prefer_single_view, restored_left, restored_top, slide_view_properties, notes_view_properties, show_comments].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



151
152
153
154
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 151

def list_invalid_properties
  invalid_properties = super
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



323
324
325
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 323

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



329
330
331
332
333
334
335
336
337
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 329

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



317
318
319
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 317

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/aspose_slides_cloud/models/view_properties.rb', line 158

def valid?
  return false if !super
  last_view_validator = EnumAttributeValidator.new('String', ['NotDefined', 'SlideView', 'SlideMasterView', 'NotesView', 'HandoutView', 'NotesMasterView', 'OutlineView', 'SlideSorterView', 'SlideThumbnailView'])
  return false unless last_view_validator.valid?(@last_view)
  horizontal_bar_state_validator = EnumAttributeValidator.new('String', ['Minimized', 'Restored', 'Maximized'])
  return false unless horizontal_bar_state_validator.valid?(@horizontal_bar_state)
  vertical_bar_state_validator = EnumAttributeValidator.new('String', ['Minimized', 'Restored', 'Maximized'])
  return false unless vertical_bar_state_validator.valid?(@vertical_bar_state)
  show_comments_validator = EnumAttributeValidator.new('String', ['False', 'True', 'NotDefined'])
  return false unless show_comments_validator.valid?(@show_comments)
  true
end