sketchup-api-stubs 0.7.6 → 0.7.7

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layers collection allows you to see and manage all of the layers in a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to layers events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The +Sketchup::Licensing+ module contains methods for
@@ -10,7 +10,7 @@
 # than their Ruby API counterparts.
 #
 # For more details, see:
-# {Developer Center Licensing Tutorial}[https://extensions.sketchup.com/en/developer_center/tutorial_licensing]
+# {Licensing Example}[https://github.com/SketchUp/sketchup-ruby-api-tutorials/tree/master/examples/99_license]
 #
 # @version SketchUp 2015
 module Sketchup::Licensing

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Sketchup::Licensing::ExtensionLicense class is used to store extension

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This provides a way for SketchUp to customize a line style and be set on a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Provides access to the different line style objects in the model.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Loop is a low level topology class that will not need to be used often. A

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Material class represents a texture or color that can be applied to

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A collection of Materials objects. Each model contains a Materials collection
@@ -191,7 +191,7 @@ class Sketchup::Materials < Sketchup::Entity
 
   # The {#load} method is used to load a material from file into the model.
   #
-  # If a matching material exist in the model that will be returned instead.
+  # If a matching material exist in the model it will be returned instead.
   #
   # @example
   #   # Load a material from the shipped SketchUp library. (SketchUp 2016)

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to materials events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An interface to a menu.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a SketchUp model. The model is the 3D drawing that
@@ -853,6 +853,9 @@ class Sketchup::Model
   # The import method is used to load a file by recognizing the file extension
   # and calling appropriate importer.
   #
+  # See {Sketchup::DefinitionList#import} for importing a 3d model file as a
+  # component definition, without activating the UI for placing an instance.
+  #
   # See the {file:pages/importer_options.md Importer Options} file for information
   # on creating a valid hash for the various importers.
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to model events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The OptionsManager class manages various kinds of OptionsProviders on a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An +OptionsProvider+ class provides various kinds of options on a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to operations provider

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Page class contains methods to extract information and modify the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class contains methods for manipulating a collection of Pages

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to pages events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::PickHelper} class is used to pick entities that reside under

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::RegionalSettings} module contains methods getting information about the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The RenderingOptions class contains method to extract the rendering

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to rendering options events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SectionPlane class represents a section plane in a SketchUp model. Note

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A set of the currently selected entities. Use the Model.selection method

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to selection events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The set class represents a collection of unique objects. This class is useful

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ShadowInfo class contains method to extract the shadow information for a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes to the shadow

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Skp} module is used to read metadata from external SketchUp

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Style class contains methods for modifying information about a specific

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Styles class contains methods for manipulating a collection of styles in

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Text class contains method to manipulate a Text entity object.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Texture class contains methods for obtaining information about textures

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The TextureWriter class is used primarily for writing the textures used in a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Tool is the interface that you implement to create a SketchUp tool.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Tools class contains methods to manipulate a collection of SketchUp

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to tool events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UV Helper class contains methods allowing you to determine the location

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A Vertex. A Vertex represents the end of an Edge or a point inside a Face.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This class contains methods to manipulate the current point of view of the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to view events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Command class is the preferred class for adding tools to the menus and

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Ruby HtmlDialog class allows you to create and interact with HTML dialog
@@ -17,11 +17,26 @@
 # For usage examples, including how to migrate from the old WebDialog class,
 # see https://github.com/SketchUp/htmldialog-examples.
 #
+# HtmlDialog uses the following versions of CEF (Chromium Embedded Framework):
+#
+# [SketchUp 2021.1]
+#   CEF 88
+# [SketchUp 2019.0]
+#   CEF 64
+# [SketchUp 2018.0]
+#   CEF 56
+# [SketchUp 2017.0]
+#   CEF 52
+#
 # @version SketchUp 2017
 class UI::HtmlDialog
 
   # Constants
 
+  CEF_VERSION = nil # Stub value.
+
+  CHROME_VERSION = nil # Stub value.
+
   STYLE_DIALOG = nil # Stub value.
   STYLE_UTILITY = nil # Stub value.
   STYLE_WINDOW = nil # Stub value.
@@ -81,11 +96,16 @@ class UI::HtmlDialog
   # The {#bring_to_front} method is used to bring the window to the front,
   # putting it on top of other windows even if its minimized.
   #
+  # @bug Prior to SketchUp 2021.1, on Mac, the focus the was not being set
+  #   on the {UI::HtmlDialog}.
+  #
   # @example
   #   dialog.bring_to_front
   #
   # @return [nil]
   #
+  # @see Sketchup.focus
+  #
   # @version SketchUp 2017
   def bring_to_front
   end
@@ -97,7 +117,7 @@ class UI::HtmlDialog
   # @example
   #   dialog.center
   #
-  # @return [true]
+  # @return [true] This always return true, never false.
   #
   # @version SketchUp 2017
   def center
@@ -130,8 +150,54 @@ class UI::HtmlDialog
   def execute_script(script)
   end
 
+  # The {#get_content_size} method is used to get the content size of the HtmlDialog, in logical pixels.
+  #
+  # @example
+  #   width, height = dialog.get_content_size
+  #
+  # @return [Array(Integer, Integer), nil] Content width and height of the HtmlDialog.
+  #   A nil value is returned if the HtmlDialog
+  #   is not visible.
+  #
+  # @version SketchUp 2021.1
+  def get_content_size
+  end
+
+  # The {#get_position} method is used to get the position of the HtmlDialog
+  # relative to the screen, in logical pixels.
+  #
+  # @example
+  #   left, top = dialog.get_position
+  #
+  # @return [Array(Integer, Integer), nil] Left and top position of the dialog.
+  #   A nil value is returned if the HtmlDialog
+  #   is not visible.
+  #
+  # @version SketchUp 2021.1
+  def get_position
+  end
+
+  # The {#get_size} method is used to get the outer frame size of the HtmlDialog, in logical pixels.
+  #
+  # @example
+  #   width, height = dialog.get_size
+  #
+  # @return [Array(Integer, Integer), nil] Outer frame width and height of the HtmlDialog.
+  #   A nil value is returned if the HtmlDialog
+  #   is not visible.
+  #
+  # @version SketchUp 2021.1
+  def get_size
+  end
+
   # The new method is used to create a new HtmlDialog.
   #
+  # When +use_content_size+ is set to +true+, +width+, +height+, +min_width+,
+  # +max width+, +min_height+, +max_height+ will represent the size of the
+  # content area of the window. This excludes the titlebar and the window frame.
+  # When +use_content_size+ is set to +false+ (the default value),
+  # the size dimensions will represent the outer frame size.
+  #
   # The +properties+ hash accepts an optional key +style+ where the value is
   # one of:
   #
@@ -204,6 +270,8 @@ class UI::HtmlDialog
   #
   # @option properties [Boolean] :resizable (true)
   #
+  # @option properties [Boolean] :use_content_size (false)
+  #
   # @option properties [Integer] :width (250)
   #
   # @option properties [Integer] :height (250)
@@ -248,6 +316,23 @@ class UI::HtmlDialog
   def set_can_close
   end
 
+  # The {#set_content_size} method is used to set the content size of the HtmlDialog, in logical pixels.
+  #
+  # @example
+  #   dialog.set_content_size(600, 400)
+  #
+  # @param [Integer] width
+  #   Content width of the HtmlDialog.
+  #
+  # @param [Integer] height
+  #   Content height of the HtmlDialog.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.1
+  def set_content_size(width, height)
+  end
+
   # The {#set_file} method is used to identify a local HTML file to display in the
   # HtmlDialog.
   #
@@ -296,6 +381,9 @@ class UI::HtmlDialog
   # The {#set_position} method is used to set the position of the HtmlDialog
   # relative to the screen, in pixels.
   #
+  # @bug Prior to SketchUp 2021.1, on Windows, calling this method incorrectly
+  #   set the focus on the {UI::HtmlDialog}.
+  #
   # @example
   #   dialog.set_position(100, 50)
   #
@@ -305,24 +393,27 @@ class UI::HtmlDialog
   # @param [Integer] top
   #   The number of pixels from the top of the screen.
   #
-  # @return [true]
+  # @return [true] This always return true, never false.
   #
   # @version SketchUp 2017
   def set_position(left, top)
   end
 
-  # The {#set_size} method is used to set the size of the HtmlDialog, in pixels.
+  # The {#set_size} method is used to set the outer frame size of the HtmlDialog, in pixels.
+  #
+  # @bug Prior to SketchUp 2021.1, on Windows, calling this method incorrectly
+  #   set the focus on the {UI::HtmlDialog}.
   #
   # @example
   #   dialog.set_size(320, 240)
   #
   # @param [Integer] width
-  #   Width of the HtmlDialog.
+  #   Outer frame width of the HtmlDialog.
   #
   # @param [Integer] height
-  #   Height of the HtmlDialog.
+  #   Outer frame height of the HtmlDialog.
   #
-  # @return [true]
+  # @return [true] This always return true, never false.
   #
   # @version SketchUp 2017
   def set_size(width, height)