sketchup-api-stubs 0.7.9 → 0.7.10

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

@@ -1,249 +1,249 @@
-# Copyright:: Copyright 2023 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to layers 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
-#   class MyLayersObserver < Sketchup::LayersObserver
-#     def onLayerAdded(layers, layer)
-#       puts "onLayerAdded: #{layer.name}"
-#     end
-#   end
-#
-#   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-#   Sketchup.active_model.layers.add("Hello World")
-#
-# @version SketchUp 6.0
-class Sketchup::LayersObserver
-
-  # Instance Methods
-
-  # The {#onCurrentLayerChanged} method is called when the user selects a
-  # different active layer.
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onCurrentLayerChanged(layers, layer)
-  #       puts "onCurrentLayerChanged: #{layer.name}"
-  #     end
-  #   end
-  #
-  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-  #   layer = Sketchup.active_model.layers.add("Hello World")
-  #   Sketchup.active_model.active_layer = layer
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::Layer] layer
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onCurrentLayerChanged(layers, layer)
-  end
-
-  # The {#onLayerAdded} method is called when a new layer is added to a model.
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onLayerAdded(layers, layer)
-  #       puts "onLayerAdded: #{layer.name}"
-  #     end
-  #   end
-  #
-  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-  #   Sketchup.active_model.layers.add("Hello World")
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::Layer] layer
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onLayerAdded(layers, layer)
-  end
-
-  # The {#onLayerChanged} method is called when a layer is changed.
-  #
-  # @example
-  #   def onLayerChanged(layers, layer)
-  #     puts "onLayerChanged: #{layer.name}"
-  #   end
-  #
-  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-  #   layer = Sketchup.active_model.layers.add("Hello World")
-  #   layer.name = "Hello Universe"
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::Layer] layer
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2014
-  def onLayerChanged(layers, layer)
-  end
-
-  # The {#onLayerFolderAdded} method is called when a layer folder is added
-  # to a model.
-  #
-  # @api TagFolder
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onLayerFolderAdded(layers, layer_folder)
-  #       puts "onLayerFolderAdded: #{layer_folder.name}"
-  #     end
-  #   end
-  #
-  #   model = Sketchup.active_model
-  #   model.layers.add_observer(MyLayersObserver.new)
-  #   folder = model.layers.add_folder("Hello World")
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::LayerFolder] layer_folder
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2021.0
-  def onLayerFolderAdded(layers, layer_folder)
-  end
-
-  # The {#onLayerFolderChanged} method is called when a layer folder changes
-  # one of its properties.
-  #
-  # @api TagFolder
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onLayerFolderChanged(layers, layer_folder)
-  #       puts "onLayerFolderChanged: #{layer_folder.name}"
-  #     end
-  #   end
-  #
-  #   model = Sketchup.active_model
-  #   model.layers.add_observer(MyLayersObserver.new)
-  #   folder = model.layers.add_folder("Hello World")
-  #   folder.name = "Hello Universe"
-  #   folder.visible = false
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::LayerFolder] layer_folder
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2021.0
-  def onLayerFolderChanged(layers, layer_folder)
-  end
-
-  # The {#onLayerFolderRemoved} method is called when a layer folder is removed
-  # from a model.
-  #
-  # @api TagFolder
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onLayerFolderRemoved(layers, layer_folder)
-  #       puts "onLayerRemoved: #{layer_folder.name}"
-  #     end
-  #   end
-  #
-  #   model = Sketchup.active_model
-  #   model.layers.add_observer(MyLayersObserver.new)
-  #   folder = model.layers.add_folder("Hello World")
-  #   model.layers.remove_folder(folder)
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::LayerFolder] layer_folder
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2021.0
-  def onLayerFolderRemoved(layers, layer_folder)
-  end
-
-  # The {#onLayerRemoved} method is called when a layer is removed from a model.
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onLayerRemoved(layers, layer)
-  #       puts "onLayerRemoved: #{layer.name}"
-  #     end
-  #   end
-  #
-  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-  #   layer = Sketchup.active_model.layers.add("Hello World")
-  #   Sketchup.active_model.layers.remove(layer)
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::Layer] layer
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onLayerRemoved(layers, layer)
-  end
-
-  # The {#onParentFolderChanged} method is called when a layer changes parent
-  # folder.
-  #
-  # @api TagFolder
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onParentFolderChanged(layers, layer)
-  #       puts "onParentFolderChange: #{layer.name}"
-  #     end
-  #   end
-  #
-  #   model = Sketchup.active_model
-  #   model.layers.add_observer(MyLayersObserver.new)
-  #   layer = model.layers.add_layer("World")
-  #   folder = model.layers.add_folder("Hello")
-  #   layer.folder = folder
-  #
-  # @note When a folder changes parent {#onLayerFolderRemoved} and
-  #   {#onLayerFolderAdded} triggers.
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @param [Sketchup::Layer] layer
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2021.0
-  def onParentFolderChanged(layers, layer)
-  end
-
-  # The {#onRemoveAllLayers} method is called when all layer are removed from a
-  # model.
-  #
-  # @example
-  #   class MyLayersObserver < Sketchup::LayersObserver
-  #     def onRemoveAllLayers(layers)
-  #       puts "onRemoveAllLayers: #{layers}"
-  #     end
-  #   end
-  #
-  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
-  #   layer = Sketchup.active_model.layers.add("Hello World")
-  #   Sketchup.active_model.layers.remove(layer)
-  #
-  # @param [Sketchup::Layers] layers
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onRemoveAllLayers(layers)
-  end
-
-end
+# Copyright:: Copyright 2024 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to layers 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
+#   class MyLayersObserver < Sketchup::LayersObserver
+#     def onLayerAdded(layers, layer)
+#       puts "onLayerAdded: #{layer.name}"
+#     end
+#   end
+#
+#   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+#   Sketchup.active_model.layers.add("Hello World")
+#
+# @version SketchUp 6.0
+class Sketchup::LayersObserver
+
+  # Instance Methods
+
+  # The {#onCurrentLayerChanged} method is called when the user selects a
+  # different active layer.
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onCurrentLayerChanged(layers, layer)
+  #       puts "onCurrentLayerChanged: #{layer.name}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+  #   layer = Sketchup.active_model.layers.add("Hello World")
+  #   Sketchup.active_model.active_layer = layer
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::Layer] layer
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onCurrentLayerChanged(layers, layer)
+  end
+
+  # The {#onLayerAdded} method is called when a new layer is added to a model.
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onLayerAdded(layers, layer)
+  #       puts "onLayerAdded: #{layer.name}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+  #   Sketchup.active_model.layers.add("Hello World")
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::Layer] layer
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onLayerAdded(layers, layer)
+  end
+
+  # The {#onLayerChanged} method is called when a layer is changed.
+  #
+  # @example
+  #   def onLayerChanged(layers, layer)
+  #     puts "onLayerChanged: #{layer.name}"
+  #   end
+  #
+  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+  #   layer = Sketchup.active_model.layers.add("Hello World")
+  #   layer.name = "Hello Universe"
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::Layer] layer
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2014
+  def onLayerChanged(layers, layer)
+  end
+
+  # The {#onLayerFolderAdded} method is called when a layer folder is added
+  # to a model.
+  #
+  # @api TagFolder
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onLayerFolderAdded(layers, layer_folder)
+  #       puts "onLayerFolderAdded: #{layer_folder.name}"
+  #     end
+  #   end
+  #
+  #   model = Sketchup.active_model
+  #   model.layers.add_observer(MyLayersObserver.new)
+  #   folder = model.layers.add_folder("Hello World")
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::LayerFolder] layer_folder
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.0
+  def onLayerFolderAdded(layers, layer_folder)
+  end
+
+  # The {#onLayerFolderChanged} method is called when a layer folder changes
+  # one of its properties.
+  #
+  # @api TagFolder
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onLayerFolderChanged(layers, layer_folder)
+  #       puts "onLayerFolderChanged: #{layer_folder.name}"
+  #     end
+  #   end
+  #
+  #   model = Sketchup.active_model
+  #   model.layers.add_observer(MyLayersObserver.new)
+  #   folder = model.layers.add_folder("Hello World")
+  #   folder.name = "Hello Universe"
+  #   folder.visible = false
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::LayerFolder] layer_folder
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.0
+  def onLayerFolderChanged(layers, layer_folder)
+  end
+
+  # The {#onLayerFolderRemoved} method is called when a layer folder is removed
+  # from a model.
+  #
+  # @api TagFolder
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onLayerFolderRemoved(layers, layer_folder)
+  #       puts "onLayerRemoved: #{layer_folder.name}"
+  #     end
+  #   end
+  #
+  #   model = Sketchup.active_model
+  #   model.layers.add_observer(MyLayersObserver.new)
+  #   folder = model.layers.add_folder("Hello World")
+  #   model.layers.remove_folder(folder)
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::LayerFolder] layer_folder
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.0
+  def onLayerFolderRemoved(layers, layer_folder)
+  end
+
+  # The {#onLayerRemoved} method is called when a layer is removed from a model.
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onLayerRemoved(layers, layer)
+  #       puts "onLayerRemoved: #{layer.name}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+  #   layer = Sketchup.active_model.layers.add("Hello World")
+  #   Sketchup.active_model.layers.remove(layer)
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::Layer] layer
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onLayerRemoved(layers, layer)
+  end
+
+  # The {#onParentFolderChanged} method is called when a layer changes parent
+  # folder.
+  #
+  # @api TagFolder
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onParentFolderChanged(layers, layer)
+  #       puts "onParentFolderChange: #{layer.name}"
+  #     end
+  #   end
+  #
+  #   model = Sketchup.active_model
+  #   model.layers.add_observer(MyLayersObserver.new)
+  #   layer = model.layers.add_layer("World")
+  #   folder = model.layers.add_folder("Hello")
+  #   layer.folder = folder
+  #
+  # @note When a folder changes parent {#onLayerFolderRemoved} and
+  #   {#onLayerFolderAdded} triggers.
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @param [Sketchup::Layer] layer
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.0
+  def onParentFolderChanged(layers, layer)
+  end
+
+  # The {#onRemoveAllLayers} method is called when all layer are removed from a
+  # model.
+  #
+  # @example
+  #   class MyLayersObserver < Sketchup::LayersObserver
+  #     def onRemoveAllLayers(layers)
+  #       puts "onRemoveAllLayers: #{layers}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.layers.add_observer(MyLayersObserver.new)
+  #   layer = Sketchup.active_model.layers.add("Hello World")
+  #   Sketchup.active_model.layers.remove(layer)
+  #
+  # @param [Sketchup::Layers] layers
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onRemoveAllLayers(layers)
+  end
+
+end

data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb

@@ -1,86 +1,86 @@
-# Copyright:: Copyright 2023 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The Sketchup::Licensing::ExtensionLicense class is used to store extension
-# license information. An instance of this class is returned by
-# Sketchup::Licensing.get_extension_license. Note that this is a temporary
-# object representing the extension licensing state for the moment it was
-# returned. It will not reflect any licensing state changes that may occur.
-#
-# @version SketchUp 2015
-class Sketchup::Licensing::ExtensionLicense
-
-  # Instance Methods
-
-  # The days_remaining method is used to get the number of days remaining until
-  # license expiration.
-  #
-  # @example
-  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
-  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
-  #   if ext_lic.days_remaining != 0
-  #      puts "The license will expire in #{ext_lic.days_remaining} days."
-  #   end
-  #
-  # @return Integer - Number of days until license expiration. Zero
-  #   if a permanent license or not licensed.
-  #
-  # @version SketchUp 2015
-  def days_remaining
-  end
-
-  # The error_description method is used to obtain error information in case of
-  # failure to acquire a license. This is meant to aid in debugging only.
-  # Extensions should not rely on any exact error description.
-  #
-  # @example
-  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
-  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
-  #   if !ext_lic.licensed?
-  #      puts ext_lic.error_description
-  #   end
-  #
-  # @return String - error description.
-  #
-  # @version SketchUp 2015
-  def error_description
-  end
-
-  # The licensed? method is used to decide whether the extension is licensed to
-  # run or not.
-  #
-  # @example
-  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
-  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
-  #   if ext_lic.licensed?
-  #      puts "Extension is licensed."
-  #   end
-  #
-  # @return [Boolean] Boolean - true if the extension is allowed to run, false
-  #   if it is not licensed and should quit.
-  #
-  # @version SketchUp 2015
-  def licensed?
-  end
-
-  # The state method returns a constant indicating the specific licensing state.
-  # These should be used for informational purposes only and not to decide if
-  # the extension is licensed to run. For that, please use the licensed? method.
-  #
-  # @example
-  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
-  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
-  #   if ext_lic.state == Sketchup::Licensing::TRIAL_EXPIRED
-  #      puts "Trial period has expired."
-  #   end
-  #
-  # @return Integer - One of Sketchup::Licensing::LICENSED,
-  #   Sketchup::Licensing::EXPIRED, Sketchup::Licensing::TRIAL,
-  #   Sketchup::Licensing::TRIAL_EXPIRED,
-  #   Sketchup::Licensing::NOT_LICENSED
-  #
-  # @version SketchUp 2015
-  def state
-  end
-
-end
+# Copyright:: Copyright 2024 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Sketchup::Licensing::ExtensionLicense class is used to store extension
+# license information. An instance of this class is returned by
+# Sketchup::Licensing.get_extension_license. Note that this is a temporary
+# object representing the extension licensing state for the moment it was
+# returned. It will not reflect any licensing state changes that may occur.
+#
+# @version SketchUp 2015
+class Sketchup::Licensing::ExtensionLicense
+
+  # Instance Methods
+
+  # The days_remaining method is used to get the number of days remaining until
+  # license expiration.
+  #
+  # @example
+  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
+  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
+  #   if ext_lic.days_remaining != 0
+  #      puts "The license will expire in #{ext_lic.days_remaining} days."
+  #   end
+  #
+  # @return Integer - Number of days until license expiration. Zero
+  #   if a permanent license or not licensed.
+  #
+  # @version SketchUp 2015
+  def days_remaining
+  end
+
+  # The error_description method is used to obtain error information in case of
+  # failure to acquire a license. This is meant to aid in debugging only.
+  # Extensions should not rely on any exact error description.
+  #
+  # @example
+  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
+  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
+  #   if !ext_lic.licensed?
+  #      puts ext_lic.error_description
+  #   end
+  #
+  # @return String - error description.
+  #
+  # @version SketchUp 2015
+  def error_description
+  end
+
+  # The licensed? method is used to decide whether the extension is licensed to
+  # run or not.
+  #
+  # @example
+  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
+  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
+  #   if ext_lic.licensed?
+  #      puts "Extension is licensed."
+  #   end
+  #
+  # @return [Boolean] Boolean - true if the extension is allowed to run, false
+  #   if it is not licensed and should quit.
+  #
+  # @version SketchUp 2015
+  def licensed?
+  end
+
+  # The state method returns a constant indicating the specific licensing state.
+  # These should be used for informational purposes only and not to decide if
+  # the extension is licensed to run. For that, please use the licensed? method.
+  #
+  # @example
+  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
+  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
+  #   if ext_lic.state == Sketchup::Licensing::TRIAL_EXPIRED
+  #      puts "Trial period has expired."
+  #   end
+  #
+  # @return Integer - One of Sketchup::Licensing::LICENSED,
+  #   Sketchup::Licensing::EXPIRED, Sketchup::Licensing::TRIAL,
+  #   Sketchup::Licensing::TRIAL_EXPIRED,
+  #   Sketchup::Licensing::NOT_LICENSED
+  #
+  # @version SketchUp 2015
+  def state
+  end
+
+end