sketchup-api-stubs 0.7.9 → 0.7.11

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

@@ -1,48 +1,55 @@
-# Copyright:: Copyright 2023 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
-# {Licensing Example}[https://github.com/SketchUp/sketchup-ruby-api-tutorials/tree/main/examples/99_license]
-#
-# @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 [Sketchup::Licensing::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 2026 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
+# {Licensing Example}[https://github.com/SketchUp/sketchup-ruby-api-tutorials/tree/main/examples/99_license]
+#
+# @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
+
+  # Gets a license for a given extension.
+  #
+  # Starting in SketchUp 2025.0, this method automatically tries to fetch a license from Extension
+  # Warehouse if the extension doesn't have a license on the current device. This only works if the
+  # user is signed in. In earlier SketchUp versions, the user has to go to Extension Manager, expand
+  # the extension in question and press Update License if the license is missing.
+  # (For performance reasons this automatic fetching is skipped during SU startup. Make sure to do a
+  # license check when the user interacts with the 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 [Sketchup::Licensing::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/LineStyle.rb

@@ -1,24 +1,24 @@
-# Copyright:: Copyright 2023 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This provides a way for SketchUp to customize a line style and be set on a
-# layer.
-#
-# @version SketchUp 2019
-class Sketchup::LineStyle < Sketchup::Entity
-
-  # Instance Methods
-
-  # The {#name} method retrieves the name of the line style object.
-  #
-  # @example
-  #   line_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style.name # returns "Solid Basic"
-  #
-  # @return [String] The name of the line style.
-  #
-  # @version SketchUp 2019
-  def name
-  end
-
-end
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This provides a way for SketchUp to customize a line style and be set on a
+# layer.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyle < Sketchup::Entity
+
+  # Instance Methods
+
+  # The {#name} method retrieves the name of the line style object.
+  #
+  # @example
+  #   line_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style.name # returns "Solid Basic"
+  #
+  # @return [String] The name of the line style.
+  #
+  # @version SketchUp 2019
+  def name
+  end
+
+end

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

@@ -1,114 +1,114 @@
-# Copyright:: Copyright 2023 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# Provides access to the different line style objects in the model.
-#
-# @version SketchUp 2019
-class Sketchup::LineStyles < Sketchup::Entity
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # The {#[]} method lets you retrieve a line style by name or index.
-  #
-  # The {#at} method is an alias of {#[]}.
-  #
-  # @example
-  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style = Sketchup.active_model.line_styles[1]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name The name of the line style to retrieve.
-  #
-  # @overload [](index)
-  #
-  #   @param [Integer] index The index of the line style to retrieve.
-  #
-  #   @raise [IndexError] If index is out of bounds.
-  #
-  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
-  #   couldn't be retrieved.
-  #
-  # @version SketchUp 2019
-  def [](arg)
-  end
-
-  # The {#[]} method lets you retrieve a line style by name or index.
-  #
-  # The {#at} method is an alias of {#[]}.
-  #
-  # @example
-  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style = Sketchup.active_model.line_styles[1]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name The name of the line style to retrieve.
-  #
-  # @overload [](index)
-  #
-  #   @param [Integer] index The index of the line style to retrieve.
-  #
-  #   @raise [IndexError] If index is out of bounds.
-  #
-  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
-  #   couldn't be retrieved.
-  #
-  # @version SketchUp 2019
-  def at(arg)
-  end
-
-  # The {#each} method is used to iterate through all the line styles.
-  #
-  # @example
-  #   line_styles = Sketchup.active_model.line_styles
-  #   line_styles.each{ |line_style| p line_style.name }
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2019
-  #
-  # @yieldparam [Sketchup::LineStyle] linestyle
-  def each
-  end
-
-  # The {#names} method return the support line styles as strings.
-  #
-  # @example
-  #   Sketchup.active_model.line_styles.names
-  #
-  # @return [Array<String>]
-  #
-  # @version SketchUp 2019
-  def names
-  end
-
-  # The {#size} method returns the number of line styles that SketchUp supports.
-  #
-  # @example
-  #   line_styles = Sketchup.active_model.line_styles
-  #   line_styles.size
-  #
-  # @return [Integer] The count of line styles.
-  #
-  # @version SketchUp 2019
-  def size
-  end
-  alias_method :length, :size
-
-  # The {#to_a} method returns an array of all the line styles.
-  #
-  # @example
-  #   line_styles = Sketchup.active_active_model.line_styles.to_a
-  #
-  # @return [Array] Containing all the line style objects.
-  #
-  # @version SketchUp 2019
-  def to_a
-  end
-
-end
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Provides access to the different line style objects in the model.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyles < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
+  #   couldn't be retrieved.
+  #
+  # @version SketchUp 2019
+  def [](arg)
+  end
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
+  #   couldn't be retrieved.
+  #
+  # @version SketchUp 2019
+  def at(arg)
+  end
+
+  # The {#each} method is used to iterate through all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.each{ |line_style| p line_style.name }
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2019
+  #
+  # @yieldparam [Sketchup::LineStyle] linestyle
+  def each
+  end
+
+  # The {#names} method return the support line styles as strings.
+  #
+  # @example
+  #   Sketchup.active_model.line_styles.names
+  #
+  # @return [Array<String>]
+  #
+  # @version SketchUp 2019
+  def names
+  end
+
+  # The {#size} method returns the number of line styles that SketchUp supports.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.size
+  #
+  # @return [Integer] The count of line styles.
+  #
+  # @version SketchUp 2019
+  def size
+  end
+  alias_method :length, :size
+
+  # The {#to_a} method returns an array of all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_active_model.line_styles.to_a
+  #
+  # @return [Array] Containing all the line style objects.
+  #
+  # @version SketchUp 2019
+  def to_a
+  end
+
+end

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

@@ -0,0 +1,70 @@
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The main purpose of the +LoadHandler+ interface is to be used as an optional second parameter of
+# the {Sketchup::DefinitionList#load_from_url} method.
+#
+# Its methods that require implementation handle the process of downloading and managing the
+# state of the load operation, including progress updates and error handling.
+#
+# @abstract Implement the methods described in this class to create a tool.
+#   You can not sub-class this class because it is not defined by the API.
+#
+# @version SketchUp 6.0
+class Sketchup::LoadHandler
+
+  # Instance Methods
+
+  # This method is called when the download is canceled by the user.
+  #
+  # @example
+  #   def cancelled?
+  #     # You could, for example, show a messagebox after X seconds asking if the
+  #     # user wants to cancel the download. If this method returns true, then
+  #     # the download cancels.
+  #     return false
+  #   end
+  #
+  # @return [Boolean]
+  def cancelled?
+  end
+
+  # This method is called when the download unsuccessfully completes
+  #
+  # @example
+  #   def onFailure(message)
+  #     self.error = message
+  #     Sketchup::set_status_text('')
+  #   end
+  #
+  # @param [String] message
+  #
+  # @return [Boolean]
+  def onFailure(message)
+  end
+
+  # This method is triggered whenever the percent value updates.
+  #
+  # @example
+  #   def onPercentChange(percent)
+  #     Sketchup::set_status_text("loading: #{percent.round}%")
+  #   end
+  #
+  # @param [Float] percent
+  #
+  # @return [nil]
+  def onPercentChange(percent)
+  end
+
+  # This method is called when the download successfully completes
+  #
+  # @example
+  #   def onSuccess
+  #     Sketchup::set_status_text('')
+  #   end
+  #
+  # @return [nil]
+  def onSuccess
+  end
+
+end