sketchup-api-stubs 0.7.10 → 0.7.11

data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Toolbar class contains methods to create and manipulate SketchUp
@@ -113,12 +113,29 @@ class UI::Toolbar
   # The get_last_state method is used to determine if the toolbar was hidden or
   # visible in the previous session of SketchUp.
   #
-  # Valid states are 1 for visible, 0 for hidden, -1 for before never shown.
+  # Valid states are {TB_VISIBLE} (1) for visible, {TB_HIDDEN} (0) for hidden,
+  # {TB_NEVER_SHOWN} (-1) for before never shown.
   #
   # @example
   #   state = toolbar.get_last_state
+  #   case state
+  #   when TB_VISIBLE
+  #     puts "Toolbar was visible in the last session."
+  #   when TB_HIDDEN
+  #     puts "Toolbar was hidden in the last session."
+  #   when TB_NEVER_SHOWN
+  #     puts "Toolbar was never shown in the last session."
+  #   else
+  #     puts "Unknown toolbar state: #{state}"
+  #   end
   #
-  # @return [Boolean] the last state of the toolbar (see comments)
+  # @return [Integer] the last state of the toolbar (see constants above)
+  #
+  # @see TB_VISIBLE
+  #
+  # @see TB_HIDDEN
+  #
+  # @see TB_NEVER_SHOWN
   #
   # @version SketchUp 6.0
   def get_last_state

data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Ruby WebDialog class allows you to create and interact with DHTML dialog
@@ -9,7 +9,7 @@
 # than inside a dialog in SketchUp.
 #
 # See this blog post for a detailed, step-by-step example:
-# http://sketchupapi.blogspot.com/2008/02/sharing-data-between-sketchup-ruby-and.html
+# https://sketchupapi.blogspot.com/2008/02/sharing-data-between-sketchup-ruby-and.html
 #
 # Under Windows the IE render mode is different in webdialogs than from what
 # you see in the normal browser. It will by default pick an older render mode
@@ -29,7 +29,7 @@
 # would like to direct the user to install that extension.
 #
 # For example, to launch an extension's page whose URL is:
-# http://extensions.sketchup.com/en/content/advanced-camera-tools
+# https://extensions.sketchup.com/en/content/advanced-camera-tools
 # The link would be:
 #
 # @deprecated Please use {UI::HtmlDialog} that was introduced in
@@ -180,7 +180,7 @@ class UI::WebDialog
   # @example
   #   dlg = UI::WebDialog.new("Show sketchup.com", true,
   #     "ShowSketchupDotCom", 739, 641, 150, 150, true);
-  #   dlg.set_url "http://www.sketchup.com"
+  #   dlg.set_url "https://www.sketchup.com"
   #   dlg.show
   #
   # @note Since SU2017 the position and size of the dialog is DPI aware - it will
@@ -385,7 +385,7 @@ class UI::WebDialog
   # method.
   #
   # @example
-  #   data = dialog.post_url("http://www.mydomain.com/formchecker.cgi",data)
+  #   data = dialog.post_url("https://www.mydomain.com/formchecker.cgi",data)
   #
   # @param [String] url
   #   The url to send the data.
@@ -482,6 +482,9 @@ class UI::WebDialog
   # @example
   #   dialog.set_on_close{ UI.messagebox("Closing the webDialog") }
   #
+  # @note {UI::WebDialog#close} method should not be called from the {UI::WebDialog#set_on_close}
+  #   callback. That would make it trigger itself recursively.
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0
@@ -535,7 +538,7 @@ class UI::WebDialog
   # specific URL. This method allows you to load web sites in a webdialog.
   #
   # @example
-  #   dialog.set_url "http://www.sketchup.com"
+  #   dialog.set_url "https://www.sketchup.com"
   #
   # @param [String] url
   #   The URL for a specific web site.

data/lib/sketchup-api-stubs/stubs/UI.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UI module contains a number of methods for creating simple UI elements
@@ -56,11 +56,12 @@ module UI
   # the specified location. This must be called from within a custom
   # tool. See the {Sketchup::Tool} documentation for a complete example.
   #
-  # The size of the cursor images should be 32x32 pixels.
+  # The size of the cursor images should be 32x32 pixels. Any size different
+  # from that will be scaled using the shrink-to-fit policy.
   #
-  # The coordinates for the cursor's hotspot is based from it's top left corner.
+  # The coordinates for the cursor's hotspot are based from it's top left corner, starting at (0, 0).
   # For example, a value of (hot_x, hot_y) = (5, 10) would identify the hotpoint
-  # of the cursor at 6 pixels from the left edge of your cursor image and 11
+  # of the cursor at 5 pixels from the left edge of your cursor image and 10
   # pixels from the top edge of your cursor image.
   #
   # @bug On macOS raster cursors are always displayed at 24x24.
@@ -94,12 +95,15 @@ module UI
   #   File path to an image.
   #
   # @param [Integer] hot_x
-  #   An x coordinate that is the "hotpoint" for the cursor
-  #   computed from the left edge of your cursor image.
+  #   The x-coordinate of the "hotpoint" of the cursor, computed from the left edge of your cursor
+  #   image.
   #
   # @param [Integer] hot_y
-  #   A y coordinate that is the "hotpoint" for the cursor
-  #   computed from the top edge of the of your cursor image.
+  #   The y-coordinate of the "hotpoint" of the cursor, computed from the top edge of your cursor
+  #   image.
+  #
+  # @raise [RangeError] if @param hot_x or @param hot_y are negative or larger than the max value of
+  #   an Integer.
   #
   # @return [Integer] Id associated with the cursor.
   #   Use this with {UI.set_cursor} in {Sketchup::Tool#onSetCursor}.
@@ -144,6 +148,10 @@ module UI
   #   list = ["", "", "Male|Female"]
   #   input = UI.inputbox(prompts, defaults, list, "Tell me about yourself.")
   #
+  # @note The method intelligently handles various types for default values and lists, automatically
+  #   attempting to convert provided inputs to match the type of the default value. This ensures
+  #   consistency in data types throughout the operation.
+  #
   # @overload inputbox(prompts, defaults, title)
   #
   #   @param [Array<String>] prompts
@@ -252,7 +260,7 @@ module UI
   # @example
   #   result = UI.messagebox('Do you like cheese?', MB_YESNO)
   #   if result == IDYES
-  #     UI.messagebox('SketchUp likes cheese too!')
+  #     puts 'SketchUp likes cheese too!'
   #   end
   #
   # @param [String] message
@@ -291,8 +299,16 @@ module UI
   #   not perform URL encoding and the API user is expected to provide a valid
   #   URL.
   #
-  # @example
-  #   status = UI.openURL("http://www.sketchup.com")
+  # @example Open plain(non-encoded) URL
+  #   status = UI.openURL("https://www.sketchup.com")
+  #
+  # @example Open encoded URL
+  #   status = UI.openURL("https://example.com/api?query=test&test=test")
+  #
+  # @example Open a local URL
+  #   # To open a local file one must add file:/// in front of the path of the file to make it an
+  #   # URL.
+  #   status = UI.openURL("file:///path/to/the/file/file.skp")
   #
   # @param [String] url
   #
@@ -450,7 +466,20 @@ module UI
   # Returns the scaling factor SketchUp uses on high DPI monitors. Useful for
   # things like {Sketchup::View#draw2d}.
   #
-  # @example
+  # @example Per Monitor DPI
+  #   # Scale a set of points representing 2d screen points to account for high
+  #   # DPI monitors.
+  #   points2d = [
+  #     Geom::Point3d.new(0, 0, 0),
+  #     Geom::Point3d.new(8, 0, 0),
+  #     Geom::Point3d.new(8, 4, 0),
+  #     Geom::Point3d.new(0, 4, 0),
+  #   ]
+  #   scale = UI.scale_factor(Sketchup.active_model.active_view)
+  #   tr = Geom::Transformation.scaling(UI.scale_factor)
+  #   points2d.each { |point| point.transform!(tr) }
+  #
+  # @example Deprecated legacy API
   #   # Scale a set of points representing 2d screen points to account for high
   #   # DPI monitors.
   #   points2d = [
@@ -460,15 +489,28 @@ module UI
   #     Geom::Point3d.new(0, 4, 0)
   #   ]
   #   tr = Geom::Transformation.scaling(UI.scale_factor)
-  #   points2d.each { |point| point.transform!(tr)
+  #   points2d.each { |point| point.transform!(tr) }
   #
   # @note SU2017M0 will automatically scale up line width and text size, but will
   #   not scale up the points provided to {Sketchup::View#draw2d}.
   #
+  # @overload scale_factor
+  #
+  #   @version SketchUp 2017
+  #   @deprecated Use the overload that takes a {Sketchup::View} instead.
+  #   This returns a scale factor determined when SketchUp starts from the
+  #   monitor it started on. It does not change for the duration of the
+  #   application session.
+  #
+  # @overload scale_factor(view)
+  #
+  #   @version SketchUp 2025.0
+  #   @param [Sketchup::View] view
+  #
   # @return [Float]
   #
   # @version SketchUp 2017
-  def self.scale_factor
+  def self.scale_factor(*args)
   end
 
   # The {.select_directory} method is used to display the OS dialog for selecting
@@ -579,6 +621,27 @@ module UI
   def self.show_extension_manager
   end
 
+  # Show the Extension Warehouse dialog inside SketchUp. If an extension UUID is provided
+  # the dialog navigates directly to that extension's page. If no UUID is provided it opens
+  # the Extension Warehouse home page.
+  #
+  # @example
+  #   # Open EW home
+  #   UI.show_extension_warehouse
+  #
+  # @example
+  #   # Open a specific extension by UUID (taken from the EW URL)
+  #   UI.show_extension_warehouse("a97d22f8-5968-4f43-bcf9-4f322fa7a8cb")
+  #
+  # @param [String, nil] extension_id
+  #   Optional Extension Warehouse UUID. If nil or omitted the EW home page is shown.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2026.1
+  def self.show_extension_warehouse(extension_id = nil)
+  end
+
   # The {.show_inspector} method is used to display the inspector with the given
   # name. You can get the list of valid inspectors with UI.inspector_names.
   #

data/lib/sketchup-api-stubs/stubs/_top_level.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 
@@ -146,6 +146,7 @@
   PAGE_NO_CAMERA = nil # Stub value.
   PAGE_USE_ALL = nil # Stub value.
   PAGE_USE_CAMERA = nil # Stub value.
+  PAGE_USE_ENVIRONMENT = nil # Stub value.
   PAGE_USE_HIDDEN = nil # Stub value.
   PAGE_USE_HIDDEN_GEOMETRY = nil # Stub value.
   PAGE_USE_HIDDEN_OBJECTS = nil # Stub value.
@@ -178,24 +179,23 @@
   TextVerticalAlignCapHeight = nil # Stub value.
   TextVerticalAlignCenter = nil # Stub value.
 
+  VK_ALT = nil # Stub value.
+  VK_COMMAND = nil # Stub value.
+  VK_CONTROL = nil # Stub value.
   VK_DELETE = nil # Stub value.
   VK_DOWN = nil # Stub value.
   VK_END = nil # Stub value.
   VK_HOME = nil # Stub value.
   VK_INSERT = nil # Stub value.
   VK_LEFT = nil # Stub value.
+  VK_MENU = nil # Stub value.
   VK_NEXT = nil # Stub value.
   VK_PRIOR = nil # Stub value.
   VK_RIGHT = nil # Stub value.
+  VK_SHIFT = nil # Stub value.
   VK_SPACE = nil # Stub value.
   VK_UP = nil # Stub value.
 
-  VK_ALT = nil # Stub value.
-  VK_COMMAND = nil # Stub value.
-  VK_CONTROL = nil # Stub value.
-  VK_MENU = nil # Stub value.
-  VK_SHIFT = nil # Stub value.
-
   X_AXIS_2D = nil # Stub value.
   Y_AXIS_2D = nil # Stub value.
 

metadata

@@ -1,35 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.7.10
+  version: 0.7.11
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.15.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2026-02-05 00:00:00.000000000 Z
+dependencies: []
 description: Stubs for the SketchUp Ruby API intended to assist IDEs.
 email:
 executables: []
@@ -59,6 +39,7 @@ files:
 - lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb
 - lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb
 - lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb
+- lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb
 - lib/sketchup-api-stubs/stubs/Layout/Document.rb
 - lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb
 - lib/sketchup-api-stubs/stubs/Layout/Entities.rb
@@ -121,6 +102,9 @@ files:
 - lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Face.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb
@@ -142,6 +126,7 @@ files:
 - lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Material.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb
@@ -168,6 +153,7 @@ files:
 - lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Style.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Text.rb
@@ -209,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: SketchUp Ruby API stubs.