sketchup-api-stubs 0.7.9 → 0.7.11

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

@@ -0,0 +1,113 @@
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to {Sketchup::Environment} 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
+#   {Sketchup::Environment} object.
+#
+# @example
+#   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+#     def onEnvironmentChange(environments, environment)
+#        puts "onEnvironmentChange: #{environment}"
+#     end
+#   end
+#
+#   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+#
+# @see Sketchup::Environments#add_observer
+#
+# @version SketchUp 2025.0
+class Sketchup::EnvironmentsObserver
+
+  # Instance Methods
+
+  # The {#onEnvironmentAdd} method is called whenever an environment is added to the
+  # {Sketchup::Environments}.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentAdd(environments, environment)
+  #       puts "onEnvironmentAdd: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentAdd(environments, environment)
+  end
+
+  # The {#onEnvironmentChange} method is called whenever the environment properties
+  # are changed.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentChange(environments, environment)
+  #       puts "onEnvironmentChange: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentChange(environments, environment)
+  end
+
+  # The {#onEnvironmentRemove} method is called whenever an environment is removed from the
+  # {Sketchup::Environments}.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentRemove(environments, environment)
+  #       puts "onEnvironmentRemove: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentRemove(environments, environment)
+  end
+
+  # The {#onEnvironmentSetCurrent} method is called whenever the current environment is changed.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentSetCurrent(environments, environment)
+  #       puts "onEnvironmentSetCurrent: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentSetCurrent(environments, environment)
+  end
+
+end

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

@@ -1,125 +1,122 @@
-# Copyright:: Copyright 2023 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
-  #
-  # @yieldparam [SketchupExtension] extension
-  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 2026 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)
+  #     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 0.
+  #
+  # @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
+  #
+  # @yieldparam [SketchupExtension] extension
+  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
+  #
+  # @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