sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,115 +1,115 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to selection 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 objects of
-# interests.
-#
-# @example
-#   # This is an example of an observer that watches the selection for
-#   # changes.
-#   class MySelectionObserver < Sketchup::SelectionObserver
-#     def onSelectionBulkChange(selection)
-#       puts "onSelectionBulkChange: #{selection}"
-#     end
-#   end
-#
-#   # Attach the observer.
-#   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
-#
-# @version SketchUp 6.0
-class Sketchup::SelectionObserver
-
-  # Instance Methods
-
-  #
-  # @example
-  #   def onSelectionAdded(selection, entity)
-  #     puts "onSelectionAdded: #{entity}"
-  #   end
-  #
-  # @note This event might not trigger even if a single element is selected. For
-  #   instance the Selection tool will trigger #onSelectionBulkChange regardless.
-  #
-  # @param [Sketchup::Selection] selection
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [nil]
-  #
-  # @see onSelectionBulkChange
-  #
-  # @version SketchUp 6.0
-  def onSelectionAdded(selection, entity)
-  end
-
-  # The {#onSelectionBulkChange} method is called whenever items are added or
-  # removed from the selection set.
-  #
-  # The {#onSelectionBulkChange} callback will not trigger if the selection
-  # is cleared by clicking on empty model space. Use the {#onSelectionCleared}
-  # method to catch this case.
-  #
-  # @example
-  #   def onSelectionBulkChange(selection)
-  #     puts "onSelectionRemoved: #{selection}"
-  #   end
-  #
-  # @param [Sketchup::Selection] selection
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onSelectionBulkChange(selection)
-  end
-
-  # The {#onSelectionCleared} method is called when the selection is completely
-  # emptied.
-  #
-  # @example
-  #   def onSelectionCleared(selection)
-  #     puts "onSelectionCleared: #{selection}"
-  #   end
-  #
-  # @param [Sketchup::Selection] selection
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onSelectionCleared(selection)
-  end
-
-  #
-  # @example
-  #   class MySelectionObserver < Sketchup::SelectionObserver
-  #     # Note that there is a bug that prevent this from being called. Instead
-  #     # listen to onSelectedRemoved until the bug is fixed.
-  #     def onSelectionRemoved(selection, entity)
-  #       puts "onSelectionRemoved: #{entity}"
-  #     end
-  #     # To work around this you must catch this event instead until the bug is
-  #     # fixed:
-  #     def onSelectedRemoved(selection, entity)
-  #       # You can forward it to the correct event to be future compatible.
-  #       onSelectionRemoved(selection, entity)
-  #     end
-  #   end
-  #
-  #   # Attach the observer.
-  #   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
-  #
-  # @note Due to a bug in SketchUp this event doesn't trigger. Instead
-  #   +onSelectedRemoved+ is called.
-  #
-  # @param [Sketchup::Selection] selection
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onSelectionRemoved(selection, entity)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to selection 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 objects of
+#   interests.
+#
+# @example
+#   # This is an example of an observer that watches the selection for
+#   # changes.
+#   class MySelectionObserver < Sketchup::SelectionObserver
+#     def onSelectionBulkChange(selection)
+#       puts "onSelectionBulkChange: #{selection}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::SelectionObserver
+
+  # Instance Methods
+
+  #
+  # @example
+  #   def onSelectionAdded(selection, entity)
+  #     puts "onSelectionAdded: #{entity}"
+  #   end
+  #
+  # @note This event might not trigger even if a single element is selected. For
+  #   instance the Selection tool will trigger {#onSelectionBulkChange} regardless.
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [nil]
+  #
+  # @see onSelectionBulkChange
+  #
+  # @version SketchUp 6.0
+  def onSelectionAdded(selection, entity)
+  end
+
+  # The {#onSelectionBulkChange} method is called whenever items are added or
+  # removed from the selection set.
+  #
+  # The {#onSelectionBulkChange} callback will not trigger if the selection
+  # is cleared by clicking on empty model space. Use the {#onSelectionCleared}
+  # method to catch this case.
+  #
+  # @example
+  #   def onSelectionBulkChange(selection)
+  #     puts "onSelectionBulkChange: #{selection}"
+  #   end
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionBulkChange(selection)
+  end
+
+  # The {#onSelectionCleared} method is called when the selection is completely
+  # emptied.
+  #
+  # @example
+  #   def onSelectionCleared(selection)
+  #     puts "onSelectionCleared: #{selection}"
+  #   end
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionCleared(selection)
+  end
+
+  #
+  # @bug Due to a bug in SketchUp this event doesn't trigger. Instead
+  #   +onSelectedRemoved+ is called.
+  #
+  # @example
+  #   class MySelectionObserver < Sketchup::SelectionObserver
+  #    def onSelectionRemoved(selection, entity)
+  #      puts "onSelectionRemoved: #{entity}"
+  #    end
+  #
+  #    # Due to a SketchUp bug, this method is called by the wrong name.
+  #    alias_method :onSelectedRemoved, :onSelectionRemoved
+  #   end
+  #
+  #   # Attach the observer.
+  #   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
+  #
+  # @note This event might not trigger even if a single element is deselected.
+  #   For instance the Selection tool will trigger {#onSelectionBulkChange}
+  #   regardless.
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionRemoved(selection, entity)
+  end
+
+end

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

@@ -1,212 +1,212 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The set class represents a collection of unique objects. This class is useful
-# for keeping track of a group of related entities, kind of like a selection
-# set that stays around for as long as you need it to.
-#
-# To make a set of your own, create an empty one using Sketchup::Set.new, and
-# then add items to it.
-#
-# @deprecated In SketchUp 2014 this class was changed from +Set+
-#   to +Sketchup::Set+ in order to avoid conflict with the Ruby Standard
-#   Library. The +Sketchup::Set+ class is deprecated and new extensions should
-#   make use of Ruby's +Set+ class unless they need backward compatibility.
-#
-# @example
-#   set = Sketchup::Set.new
-#   set.insert(1)
-#   set.insert(2)
-#
-# @example Compatibility Shim
-#   module Example
-#
-#     # Shim for the Set class which was moved in SketchUp 2014
-#     if defined?(Sketchup::Set)
-#       # Warning! Do NOT do this in the global namespace!
-#       Set = Sketchup::Set
-#     end
-#
-#     def self.test_set_shim
-#       set = Set.new
-#       set.insert('Hello')
-#       set.insert('World')
-#       puts set.to_a
-#     end
-#
-#   end
-#
-# @version SketchUp 6.0
-class Sketchup::Set
-
-  # Instance Methods
-
-  # The clear method is used to clear all objects out of the set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   set.clear
-  #
-  # @return set - an empty Set object
-  #
-  # @version SketchUp 6.0
-  def clear
-  end
-
-  # The {#contains?} method is an alias for {#include?}.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   p set.contains?(2)
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [Boolean]
-  #
-  # @see #include?
-  #
-  # @version SketchUp 6.0
-  def contains?(entity)
-  end
-
-  # The delete object is used to delete or remove an object from the set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.delete(1)
-  #
-  # @param object
-  #   The object to be deleted.
-  #
-  # @return object - the object that was deleted.
-  #
-  # @version SketchUp 6.0
-  def delete(object)
-  end
-
-  # The each method is used to iterate through all of the objects in the set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   set.each { | item | puts item }
-  #
-  # @version SketchUp 6.0
-  #
-  # @yield [item]
-  def each
-  end
-
-  # The empty? method is used to determine whether the set is empty.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   puts set.empty?
-  #
-  # @return [Boolean] status - true if the set is empty, false if it is not
-  #   empty.
-  #
-  # @version SketchUp 6.0
-  def empty?
-  end
-
-  # The {#include?} method is used to determine if the set includes a particular
-  # object.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   p set.include?(2)
-  #
-  # @param [Sketchup::Entity] entity
-  #
-  # @return [Boolean]
-  #
-  # @see #contains?
-  #
-  # @version SketchUp 6.0
-  def include?(entity)
-  end
-
-  # The insert method is used to insert an object into the set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #
-  # @param object
-  #   The object to be inserted into the set.
-  #
-  # @return size - the number of objects in the set
-  #
-  # @version SketchUp 6.0
-  def insert(object)
-  end
-
-  # The {#length} method is an alias for {#size}.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   puts set.length
-  #
-  # @return [Integer]
-  #
-  # @see #size
-  #
-  # @version SketchUp 6.0
-  def length
-  end
-
-  # The {#size} method is used to determine the number of objects in the set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert(1)
-  #   set.insert(2)
-  #   set.insert(3)
-  #   puts set.size
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 6.0
-  def size
-  end
-
-  # The to_a method is used to get an Array of the entities in your Set.
-  #
-  # @example
-  #   set = Sketchup::Set.new
-  #   set.insert('Hello')
-  #   set.insert('World')
-  #   my_array = set.to_a
-  #   UI.messagebox my_array
-  #
-  # @return array - The Array of the entities in the Set.
-  #
-  # @version SketchUp 6.0
-  def to_a
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The set class represents a collection of unique objects. This class is useful
+# for keeping track of a group of related entities, kind of like a selection
+# set that stays around for as long as you need it to.
+#
+# To make a set of your own, create an empty one using Sketchup::Set.new, and
+# then add items to it.
+#
+# @deprecated In SketchUp 2014 this class was changed from +Set+
+#   to +Sketchup::Set+ in order to avoid conflict with the Ruby Standard
+#   Library. The +Sketchup::Set+ class is deprecated and new extensions should
+#   make use of Ruby's +Set+ class unless they need backward compatibility.
+#
+# @example
+#   set = Sketchup::Set.new
+#   set.insert(1)
+#   set.insert(2)
+#
+# @example Compatibility Shim
+#   module Example
+#
+#     # Shim for the Set class which was moved in SketchUp 2014
+#     if defined?(Sketchup::Set)
+#       # Warning! Do NOT do this in the global namespace!
+#       Set = Sketchup::Set
+#     end
+#
+#     def self.test_set_shim
+#       set = Set.new
+#       set.insert('Hello')
+#       set.insert('World')
+#       puts set.to_a
+#     end
+#
+#   end
+#
+# @version SketchUp 6.0
+class Sketchup::Set
+
+  # Instance Methods
+
+  # The clear method is used to clear all objects out of the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   set.clear
+  #
+  # @return set - an empty Set object
+  #
+  # @version SketchUp 6.0
+  def clear
+  end
+
+  # The {#contains?} method is an alias for {#include?}.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   p set.contains?(2)
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [Boolean]
+  #
+  # @see #include?
+  #
+  # @version SketchUp 6.0
+  def contains?(entity)
+  end
+
+  # The delete object is used to delete or remove an object from the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.delete(1)
+  #
+  # @param object
+  #   The object to be deleted.
+  #
+  # @return object - the object that was deleted.
+  #
+  # @version SketchUp 6.0
+  def delete(object)
+  end
+
+  # The each method is used to iterate through all of the objects in the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   set.each { | item | puts item }
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [item]
+  def each
+  end
+
+  # The empty? method is used to determine whether the set is empty.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.empty?
+  #
+  # @return [Boolean] status - true if the set is empty, false if it is not
+  #   empty.
+  #
+  # @version SketchUp 6.0
+  def empty?
+  end
+
+  # The {#include?} method is used to determine if the set includes a particular
+  # object.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   p set.include?(2)
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [Boolean]
+  #
+  # @see #contains?
+  #
+  # @version SketchUp 6.0
+  def include?(entity)
+  end
+
+  # The insert method is used to insert an object into the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #
+  # @param object
+  #   The object to be inserted into the set.
+  #
+  # @return size - the number of objects in the set
+  #
+  # @version SketchUp 6.0
+  def insert(object)
+  end
+
+  # The {#length} method is an alias for {#size}.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.length
+  #
+  # @return [Integer]
+  #
+  # @see #size
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # The {#size} method is used to determine the number of objects in the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert(1)
+  #   set.insert(2)
+  #   set.insert(3)
+  #   puts set.size
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The to_a method is used to get an Array of the entities in your Set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert('Hello')
+  #   set.insert('World')
+  #   my_array = set.to_a
+  #   UI.messagebox my_array
+  #
+  # @return array - The Array of the entities in the Set.
+  #
+  # @version SketchUp 6.0
+  def to_a
+  end
+
+end