sketchup-api-stubs 0.7.7 → 0.7.9

data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb

@@ -1,152 +1,150 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The AttributeDictionaries class is a collection of all of the
-# AttributeDictionary objects that are attached to a given Entity object.
-#
-# The Entity class is a popular parent class in SketchUp, meaning you can
-# attach AttributeDictionaries to almost anything, from geometric items
-# like edges and faces and components to more conceptual things like pages
-# or materials.
-#
-# You access this class not by performing an AttributeDictionaries.new but
-# by grabbing a handle from an existing entity.
-#
-# @example
-#   # Grab the first entity from the model.
-#   my_layer = Sketchup.active_model.entities[0]
-#
-#   # Grab a handle to its attribute dictionaries.
-#   attrdicts = my_layer.attribute_dictionaries
-#
-# @version SketchUp 6.0
-class Sketchup::AttributeDictionaries < Sketchup::Entity
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # Get an AttributeDictionary by name. Returns nil if there is none with the
-  # given name.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   attrdicts = model.attribute_dictionaries
-  #   # Iterates through all dictionaries and prints to screen.
-  #   dict = attrdicts['my_dictionary']
-  #   if dict
-  #     UI.messagebox("Found: " + dict.to_s)
-  #   else
-  #     UI.messagebox("No dictionary found.")
-  #   end
-  #
-  # @param [String] key
-  #   The name of the attribute dictionary.
-  #
-  # @return [Sketchup::AttributeDictionary] the dictionary
-  #
-  # @version SketchUp 6.0
-  def [](key)
-  end
-
-  # The count method is inherited from the Enumerable mix-in module.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   model.set_attribute('Example', 'Hello', 'World')
-  #   dictionaries = model.attribute_dictionaries
-  #   number = dictionaries.count
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 2014
-  def count
-  end
-
-  # The delete method destroys a given AttributeDictionary. This
-  # AttributeDictionary can be passed directly or identified by its
-  # string name.
-  #
-  # In SketchUp 2018, special attribute dictionaries have been added. The name of
-  # these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet". The
-  # dictionaries cannot be deleted via ruby and an ArgumentError will be raised.
-  # The key/value pairs in the dictionary can be deleted safely.
-  #
-  # object
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   attrdicts = model.attribute_dictionaries
-  #   # Deletes a dictionary called 'my_dictionary'
-  #   attrdicts.delete 'my_dictionary'
-  #
-  # @param [String, Sketchup::AttributeDictionary] key_or_dict
-  #   The name of the attribute dictionary to delete, or
-  #   the dictionary object itself.
-  #
-  # @raise ArgumentError if an advanced attribute dictionary is being deleted.
-  #
-  # @return [Sketchup::AttributeDictionaries] the modified AttributeDictionaries
-  #
-  # @version SketchUp 6.0
-  def delete(key_or_dict)
-  end
-
-  # The each method is used to iterate through all of the attributes
-  # dictionaries.
-  #
-  # Throws an exception if there are no keys.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   dictionaries = model.attribute_dictionaries
-  #   # Iterates through all dictionaries and prints to screen.
-  #   dictionaries.each { |dictionary| puts dictionary.name }
-  #
-  # @return nil
-  #
-  # @version SketchUp 6.0
-  #
-  # @yield [dict] Each AttributeDictionary as it is found.
-  def each
-  end
-
-  # The {#length} method returns the number of attribute dictionary objects in
-  # the collection.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   model.set_attribute('Example', 'Hello', 'World')
-  #   dictionaries = model.attribute_dictionaries
-  #   number = dictionaries.length
-  #
-  # @return [Integer] the number of attribute dictionary objects in the
-  #   collection.
-  #
-  # @see #size
-  #
-  # @version SketchUp 2014
-  def length
-  end
-
-  # The {#size} method is an alias of {#length}.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   model.set_attribute('Example', 'Hello', 'World')
-  #   dictionaries = model.attribute_dictionaries
-  #   number = dictionaries.size
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 2014
-  def size
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The AttributeDictionaries class is a collection of all of the
+# AttributeDictionary objects that are attached to a given Entity object.
+#
+# The Entity class is a popular parent class in SketchUp, meaning you can
+# attach AttributeDictionaries to almost anything, from geometric items
+# like edges and faces and components to more conceptual things like pages
+# or materials.
+#
+# You access this class not by performing an AttributeDictionaries.new but
+# by grabbing a handle from an existing entity.
+#
+# @example
+#   # Grab the first entity from the model.
+#   my_layer = Sketchup.active_model.entities[0]
+#
+#   # Grab a handle to its attribute dictionaries.
+#   attrdicts = my_layer.attribute_dictionaries
+#
+# @version SketchUp 6.0
+class Sketchup::AttributeDictionaries < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # Get an AttributeDictionary by name. Returns nil if there is none with the
+  # given name.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   attrdicts = model.attribute_dictionaries
+  #   # Iterates through all dictionaries and prints to screen.
+  #   dict = attrdicts['my_dictionary']
+  #   if dict
+  #     UI.messagebox("Found: " + dict.to_s)
+  #   else
+  #     UI.messagebox("No dictionary found.")
+  #   end
+  #
+  # @param [String] key
+  #   The name of the attribute dictionary.
+  #
+  # @return [Sketchup::AttributeDictionary] the dictionary
+  #
+  # @version SketchUp 6.0
+  def [](key)
+  end
+
+  # The count method is inherited from the Enumerable mix-in module.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.count
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # The delete method destroys a given AttributeDictionary. This
+  # AttributeDictionary can be passed directly or identified by its
+  # string name.
+  #
+  # In SketchUp 2018, special attribute dictionaries have been added. The name of
+  # these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet". The
+  # dictionaries cannot be deleted via ruby and an ArgumentError will be raised.
+  # The key/value pairs in the dictionary can be deleted safely.
+  #
+  # object
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   attrdicts = model.attribute_dictionaries
+  #   # Deletes a dictionary called 'my_dictionary'
+  #   attrdicts.delete 'my_dictionary'
+  #
+  # @param [String, Sketchup::AttributeDictionary] key_or_dict
+  #   The name of the attribute dictionary to delete, or
+  #   the dictionary object itself.
+  #
+  # @raise ArgumentError if an advanced attribute dictionary is being deleted.
+  #
+  # @return [Sketchup::AttributeDictionaries] the modified AttributeDictionaries
+  #
+  # @version SketchUp 6.0
+  def delete(key_or_dict)
+  end
+
+  # The {#each} method is used to iterate through all of the attributes
+  # dictionaries.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   dictionaries = model.attribute_dictionaries
+  #   # Iterates through all dictionaries and prints to screen.
+  #   dictionaries.each { |dictionary| puts dictionary.name }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yieldparam [Sketchup::AttributeDictionary] dictionary
+  def each
+  end
+
+  # The {#length} method returns the number of attribute dictionary objects in
+  # the collection.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.length
+  #
+  # @return [Integer] the number of attribute dictionary objects in the
+  #   collection.
+  #
+  # @see #size
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The {#size} method is an alias of {#length}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   model.set_attribute('Example', 'Hello', 'World')
+  #   dictionaries = model.attribute_dictionaries
+  #   number = dictionaries.size
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 2014
+  def size
+  end
+
+end