sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,76 +1,77 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to pages 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 pages for new ones.
-#   class MyPagesObserver < Sketchup::PagesObserver
-#     def onElementAdded(pages, page)
-#       puts "onElementAdded: #{page}"
-#     end
-#   end
-#
-#   # Attach the observer.
-#   Sketchup.active_model.pages.add_observer(MyPagesObserver.new)
-#
-# @version SketchUp 6.0
-class Sketchup::PagesObserver < Sketchup::EntitiesObserver
-
-  # Instance Methods
-
-  # The {#onContentsModified} method is invoked whenever the pages change.
-  #
-  # @example
-  #   def onContentsModified(pages)
-  #     puts "onContentsModified: #{pages}"
-  #   end
-  #
-  # @param [Sketchup::Pages] pages
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onContentsModified(pages)
-  end
-
-  # The {#onElementAdded} method is invoked when an element is added to a
-  # {Sketchup::Pages} object.
-  #
-  # @example
-  #   def onElementAdded(pages, page)
-  #     puts "onElementAdded: #{page}"
-  #   end
-  #
-  # @param [Sketchup::Pages] pages
-  #
-  # @param [Sketchup::Page] page
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onElementAdded(pages, page)
-  end
-
-  # The {#onElementRemoved} method is invoked when an element is removed from a
-  # {Sketchup::Pages} object.
-  #
-  # @example
-  #   def onElementRemoved(pages, page)
-  #     puts "onElementRemoved: #{page}"
-  #   end
-  #
-  # @param [Sketchup::Pages] pages
-  #
-  # @param [Sketchup::Page] page
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onElementRemoved(pages, page)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to pages 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 pages for new ones.
+#   class MyPagesObserver < Sketchup::PagesObserver
+#     def onElementAdded(pages, page)
+#       puts "onElementAdded: #{page}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.pages.add_observer(MyPagesObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::PagesObserver < Sketchup::EntitiesObserver
+
+  # Instance Methods
+
+  # The {#onContentsModified} method is invoked whenever the pages change.
+  #
+  # @example
+  #   def onContentsModified(pages)
+  #     puts "onContentsModified: #{pages}"
+  #   end
+  #
+  # @param [Sketchup::Pages] pages
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onContentsModified(pages)
+  end
+
+  # The {#onElementAdded} method is invoked when an element is added to a
+  # {Sketchup::Pages} object.
+  #
+  # @example
+  #   def onElementAdded(pages, page)
+  #     puts "onElementAdded: #{page}"
+  #   end
+  #
+  # @param [Sketchup::Pages] pages
+  #
+  # @param [Sketchup::Page] page
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onElementAdded(pages, page)
+  end
+
+  # The {#onElementRemoved} method is invoked when an element is removed from a
+  # {Sketchup::Pages} object.
+  #
+  # @example
+  #   def onElementRemoved(pages, page)
+  #     puts "onElementRemoved: #{page}"
+  #   end
+  #
+  # @param [Sketchup::Pages] pages
+  #
+  # @param [Sketchup::Page] page
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onElementRemoved(pages, page)
+  end
+
+end