sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,59 +1,60 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to entity events. To
-# implement this observer, create a Ruby class of this type, override the
-# desired methods, and add an instance of the observer to the entity of
-# interests.
-#
-# @example
-#   class MyEntityObserver < Sketchup::EntityObserver
-#     def onEraseEntity(entity)
-#       puts "onEraseEntity: #{entity}"
-#     end
-#   end
-#
-#   # Attach the observer. (Assumes there is an entity in the model.)
-#   Sketchup.active_model.entities[0].add_observer(MyEntityObserver.new)
-#
-# @note The methods of this observer fire in such a way that making changes
-#   to the model while inside of them is dangerous. If you experience sudden
-#   crashes, it could be because of this observer. A potential workaround is to
-#   use a {Sketchup::ToolsObserver} to watch what the user is doing instead.
-#
-# @version SketchUp 6.0
-class Sketchup::EntityObserver
-
-  # Instance Methods
-
-  # The {#onChangeEntity} method is invoked when your entity is modified.
-  #
-  # @example
-  #   def onChangeEntity(entity)
-  #     puts "onChangeEntity: #{entity}"
-  #   end
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onChangeEntity(entity)
-  end
-
-  # The {#onEraseEntity} method is invoked when your entity is erased.
-  #
-  # @example
-  #   def onEraseEntity(entity)
-  #     puts "onEraseEntity: #{entity}"
-  #   end
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onEraseEntity(entity)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to entity events.
+#
+# @abstract To  implement this observer, create a Ruby class of this type, override the
+#   desired methods, and add an instance of the observer to the entity of
+#   interests.
+#
+# @example
+#   class MyEntityObserver < Sketchup::EntityObserver
+#     def onEraseEntity(entity)
+#       puts "onEraseEntity: #{entity}"
+#     end
+#   end
+#
+#   # Attach the observer. (Assumes there is an entity in the model.)
+#   Sketchup.active_model.entities[0].add_observer(MyEntityObserver.new)
+#
+# @note The methods of this observer fire in such a way that making changes
+#   to the model while inside of them is dangerous. If you experience sudden
+#   crashes, it could be because of this observer. A potential workaround is to
+#   use a {Sketchup::ToolsObserver} to watch what the user is doing instead.
+#
+# @version SketchUp 6.0
+class Sketchup::EntityObserver
+
+  # Instance Methods
+
+  # The {#onChangeEntity} method is invoked when your entity is modified.
+  #
+  # @example
+  #   def onChangeEntity(entity)
+  #     puts "onChangeEntity: #{entity}"
+  #   end
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onChangeEntity(entity)
+  end
+
+  # The {#onEraseEntity} method is invoked when your entity is erased.
+  #
+  # @example
+  #   def onEraseEntity(entity)
+  #     puts "onEraseEntity: #{entity}"
+  #   end
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onEraseEntity(entity)
+  end
+
+end

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

@@ -1,125 +1,126 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The ExtensionsManager class provides a way of accessing the
-# SketchupExtensions that have been registered via the
-# Sketchup.register_extension method.
-#
-# There is only one ExtensionsManager available. You access it via the
-# Sketchup.extensions method.
-#
-# @version SketchUp 8.0 M2
-class Sketchup::ExtensionsManager
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # The [] method is used to get an extension by name, index or ID.
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   extension = manager[0]
-  #   if (extension)
-  #     UI.messagebox extension.name
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
-  #
-  #   # You can also get extensions by name.
-  #   solarnorth = manager['Solar North Toolbar']
-  #
-  #   # You can also get extensions by ID.
-  #   my_extension = manager['2475A758-6503-46D5-AC5E-16AEA0A3162A']
-  #
-  # @param index_or_name
-  #   The index, name or ID of the SketchupExtension object.
-  #
-  # @return extension - an SketchupExtension object if
-  #   successful, otherwise nil.
-  #
-  # @version SketchUp 8.0 M2
-  def [](index_or_name)
-  end
-
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   number = manager.count
-  #
-  # @note Since SketchUp 2014 the count method is inherited from Ruby's
-  #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
-  #   for {#length}.
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 8.0 M2
-  def count
-  end
-
-  # The each method is used to iterate through extensions.
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   # Retrieves each extension
-  #   manager.each { |extension| UI.messagebox extension.name }
-  #
-  # @return nil
-  #
-  # @version SketchUp 8.0 M2
-  #
-  # @yield [extension] A variable that will hold each SketchupExtension object
-  #   as they are found.
-  def each
-  end
-
-  # The keys method is used to get a list of keys in the ExtensionsManager,
-  # which are the same as the names of the extensions.
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   keys = manager.keys
-  #   for key in keys
-  #     UI.messagebox('The next extension is named: ' + key)
-  #   end
-  #
-  # @return keys - Array of string keys
-  #
-  # @version SketchUp 8.0 M2
-  def keys
-  end
-
-  # The {#length} method returns the number of {SketchupExtension} objects inside
-  # this ExtensionsManager.
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   number = manager.length
-  #
-  # @return [Integer]
-  #
-  # @see #size
-  #
-  # @version SketchUp 8.0 M2
-  def length
-  end
-
-  # The {#size} method is an alias of {#length}.
-  #
-  # @example
-  #   manager = Sketchup.extensions
-  #   number = manager.size
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 8.0 M2
-  def size
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The ExtensionsManager class provides a way of accessing the
+# SketchupExtensions that have been registered via the
+# Sketchup.register_extension method.
+#
+# There is only one ExtensionsManager available. You access it via the
+# Sketchup.extensions method.
+#
+# @version SketchUp 8.0 M2
+class Sketchup::ExtensionsManager
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The [] method is used to get an extension by name, index or ID.
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   extension = manager[1]
+  #   if (extension)
+  #     puts extension.name
+  #   else
+  #     puts "No Extensions installed"
+  #   end
+  #
+  #   # You can also get extensions by name.
+  #   solarnorth = manager['Solar North Toolbar']
+  #
+  #   # You can also get extensions by ID.
+  #   my_extension = manager['2475A758-6503-46D5-AC5E-16AEA0A3162A']
+  #
+  # @note Index starts at 1.
+  #
+  # @param [Integer, String] index_or_name
+  #   The index, name or ID of the SketchupExtension object.
+  #
+  # @return [SketchupExtension, nil]
+  #
+  # @version SketchUp 8.0 M2
+  def [](index_or_name)
+  end
+
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   number = manager.count
+  #
+  # @note Since SketchUp 2014 the count method is inherited from Ruby's
+  #   +Enumerable+ mix-in module. Prior to that the {#count} method is an alias
+  #   for {#length}.
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 8.0 M2
+  def count
+  end
+
+  # The each method is used to iterate through extensions.
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   # Retrieves each extension
+  #   manager.each { |extension| puts extension.name }
+  #
+  # @return nil
+  #
+  # @version SketchUp 8.0 M2
+  #
+  # @yield [extension] A variable that will hold each SketchupExtension object
+  #   as they are found.
+  def each
+  end
+
+  # The keys method is used to get a list of keys in the ExtensionsManager,
+  # which are the same as the names of the extensions.
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   keys = manager.keys
+  #   for key in keys
+  #     UI.messagebox('The next extension is named: ' + key)
+  #   end
+  #
+  # @return keys - Array of string keys
+  #
+  # @version SketchUp 8.0 M2
+  def keys
+  end
+
+  # The {#length} method returns the number of {SketchupExtension} objects inside
+  # this ExtensionsManager.
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   number = manager.length
+  #
+  # @return [Integer]
+  #
+  # @see #size
+  #
+  # @version SketchUp 8.0 M2
+  def length
+  end
+
+  # The {#size} method is an alias of {#length}.
+  #
+  # @example
+  #   manager = Sketchup.extensions
+  #   number = manager.size
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 8.0 M2
+  def size
+  end
+
+end