sketchup-api-stubs 0.6.1 → 0.7.4

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

@@ -1,136 +1,136 @@
-# Copyright:: Copyright 2019 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to layers 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
-#   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 {#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 {#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 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to layers 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
+#   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 {#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 {#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.rb

@@ -1,48 +1,48 @@
-# Copyright:: Copyright 2019 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The +Sketchup::Licensing+ module contains methods for
-# extensions purchased from Extension Warehouse to check their licensing status.
-#
-# It is advised to place these calls inside encrypted Ruby (.rbe) files. This
-# API is also exposed via the SketchUp C API. Extensions that already use
-# native code should prefer using the native API, which should be more secure
-# than their Ruby API counterparts.
-#
-# For more details, see:
-# {Developer Center Licensing Tutorial}[https://extensions.sketchup.com/en/developer_center/tutorial_licensing]
-#
-# @version SketchUp 2015
-module Sketchup::Licensing
-
-  # Constants
-
-  EXPIRED = nil # Stub value.
-  LICENSED = nil # Stub value.
-  NOT_LICENSED = nil # Stub value.
-  TRIAL = nil # Stub value.
-  TRIAL_EXPIRED = nil # Stub value.
-
-  # Class Methods
-
-  # Acquires a license for a given extension.
-  #
-  # @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
-  #
-  # @param [String] extension_id
-  #   The Extension Warehouse UUID for the desired extension.
-  #
-  # @return [ExtensionLicense] An object representing
-  #   licensing state for the extension. Do not store this object, retrieve
-  #   it again when needed since licensing state may have changed.
-  #
-  # @version SketchUp 2015
-  def self.get_extension_license(extension_id)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The +Sketchup::Licensing+ module contains methods for
+# extensions purchased from Extension Warehouse to check their licensing status.
+#
+# It is advised to place these calls inside encrypted Ruby (.rbe) files. This
+# API is also exposed via the SketchUp C API. Extensions that already use
+# native code should prefer using the native API, which should be more secure
+# than their Ruby API counterparts.
+#
+# For more details, see:
+# {Developer Center Licensing Tutorial}[https://extensions.sketchup.com/en/developer_center/tutorial_licensing]
+#
+# @version SketchUp 2015
+module Sketchup::Licensing
+
+  # Constants
+
+  EXPIRED = nil # Stub value.
+  LICENSED = nil # Stub value.
+  NOT_LICENSED = nil # Stub value.
+  TRIAL = nil # Stub value.
+  TRIAL_EXPIRED = nil # Stub value.
+
+  # Class Methods
+
+  # Acquires a license for a given extension.
+  #
+  # @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
+  #
+  # @param [String] extension_id
+  #   The Extension Warehouse UUID for the desired extension.
+  #
+  # @return [ExtensionLicense] An object representing
+  #   licensing state for the extension. Do not store this object, retrieve
+  #   it again when needed since licensing state may have changed.
+  #
+  # @version SketchUp 2015
+  def self.get_extension_license(extension_id)
+  end
+
+end

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

@@ -1,86 +1,86 @@
-# Copyright:: Copyright 2019 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 2020 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