sketchup-api-stubs 0.7.4 → 0.7.8

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

@@ -1,141 +1,142 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to materials 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 MyMaterialsObserver < Sketchup::MaterialsObserver
-#     def onMaterialAdd(materials, material)
-#       puts "onMaterialAdd: #{material}"
-#     end
-#   end
-#
-#   Sketchup.active_model.materials.add_observer(MyMaterialsObserver.new)
-#
-# @note The callback +onMaterialRemoveAll+ has been deprecated, we recommend using
-#   {#onMaterialRemove} instead.
-#
-# @version SketchUp 6.0
-class Sketchup::MaterialsObserver
-
-  # Instance Methods
-
-  # The {#onMaterialAdd} method is invoked whenever a new material is added.
-  #
-  # @example
-  #   def onMaterialAdd(materials, material)
-  #     puts "onMaterialAdd: #{material}"
-  #   end
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialAdd(materials, material)
-  end
-
-  # The {#onMaterialChange} method is invoked whenever a material's texture image
-  # is altered.
-  #
-  # @example
-  #   def onMaterialChange(materials, material)
-  #     puts "onMaterialChange: #{material}"
-  #   end
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialChange(materials, material)
-  end
-
-  # The {#onMaterialRefChange} method is invoked whenever the number of entities
-  # that a material is painted on changes. This could be due to the user
-  # manually painting something, but it could also be when faces are split,
-  # pasted, push-pulled, deleted, etc.
-  #
-  # @example
-  #   def onMaterialRefChange(materials, material)
-  #     puts "onMaterialRefChange: #{material}"
-  #   end
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialRefChange(materials, material)
-  end
-
-  # The {#onMaterialRemove} method is invoked whenever a material is deleted.
-  #
-  # @example
-  #   def onMaterialRemove(materials, material)
-  #     puts "onMaterialRemove: #{material}"
-  #   end
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialRemove(materials, material)
-  end
-
-  # The {#onMaterialSetCurrent} method is invoked whenever a different material
-  # is selected in the Materials dialog.
-  #
-  # The materials parameter might be Nil when the material is picked from the
-  # materials libraries and not yet added to the model.
-  #
-  # @example
-  #   def onMaterialSetCurrent(materials, material)
-  #     puts "onMaterialSetCurrent: #{material}"
-  #   end
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialSetCurrent(materials, material)
-  end
-
-  # The {#onMaterialUndoRedo} method is invoked whenever a material is altered
-  # and then those changes are undone or redone.
-  #
-  # @example
-  #   def onMaterialUndoRedo(materials, material)
-  #     puts "onMaterialUndoRedo: #{material}"
-  #   end
-  #
-  # @note Due to a bug, this callback does not fire in SU6 or SU7. You can use
-  #   the {Sketchup::ModelObserver#onTransactionStart} to capture all undo
-  #   events.
-  #
-  # @param [Sketchup::Materials] materials
-  #
-  # @param [Sketchup::Material] material
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onMaterialUndoRedo(materials, material)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to materials 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 objects of
+#   interests.
+#
+# @example
+#   class MyMaterialsObserver < Sketchup::MaterialsObserver
+#     def onMaterialAdd(materials, material)
+#       puts "onMaterialAdd: #{material}"
+#     end
+#   end
+#
+#   Sketchup.active_model.materials.add_observer(MyMaterialsObserver.new)
+#
+# @note The callback +onMaterialRemoveAll+ has been deprecated, we recommend using
+#   {#onMaterialRemove} instead.
+#
+# @version SketchUp 6.0
+class Sketchup::MaterialsObserver
+
+  # Instance Methods
+
+  # The {#onMaterialAdd} method is invoked whenever a new material is added.
+  #
+  # @example
+  #   def onMaterialAdd(materials, material)
+  #     puts "onMaterialAdd: #{material}"
+  #   end
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialAdd(materials, material)
+  end
+
+  # The {#onMaterialChange} method is invoked whenever a material's texture image
+  # is altered.
+  #
+  # @example
+  #   def onMaterialChange(materials, material)
+  #     puts "onMaterialChange: #{material}"
+  #   end
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialChange(materials, material)
+  end
+
+  # The {#onMaterialRefChange} method is invoked whenever the number of entities
+  # that a material is painted on changes. This could be due to the user
+  # manually painting something, but it could also be when faces are split,
+  # pasted, push-pulled, deleted, etc.
+  #
+  # @example
+  #   def onMaterialRefChange(materials, material)
+  #     puts "onMaterialRefChange: #{material}"
+  #   end
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialRefChange(materials, material)
+  end
+
+  # The {#onMaterialRemove} method is invoked whenever a material is deleted.
+  #
+  # @example
+  #   def onMaterialRemove(materials, material)
+  #     puts "onMaterialRemove: #{material}"
+  #   end
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialRemove(materials, material)
+  end
+
+  # The {#onMaterialSetCurrent} method is invoked whenever a different material
+  # is selected in the Materials dialog.
+  #
+  # The materials parameter might be Nil when the material is picked from the
+  # materials libraries and not yet added to the model.
+  #
+  # @example
+  #   def onMaterialSetCurrent(materials, material)
+  #     puts "onMaterialSetCurrent: #{material}"
+  #   end
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialSetCurrent(materials, material)
+  end
+
+  # The {#onMaterialUndoRedo} method is invoked whenever a material is altered
+  # and then those changes are undone or redone.
+  #
+  # @example
+  #   def onMaterialUndoRedo(materials, material)
+  #     puts "onMaterialUndoRedo: #{material}"
+  #   end
+  #
+  # @note Due to a bug, this callback does not fire in SU6 or SU7. You can use
+  #   the {Sketchup::ModelObserver#onTransactionStart} to capture all undo
+  #   events.
+  #
+  # @param [Sketchup::Materials] materials
+  #
+  # @param [Sketchup::Material] material
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onMaterialUndoRedo(materials, material)
+  end
+
+end

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

@@ -1,95 +1,93 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# An interface to a menu.
-#
-# @version SketchUp 6.0
-class Sketchup::Menu
-
-  # Instance Methods
-
-  # The {#add_item} method is used to add a menu item to the specified menu.
-  #
-  # This method takes a block that defines the action to perform when the menu
-  # item is selected.
-  #
-  # The item id that is returned can be used when adding an optional
-  # validation procedure for the menu item.
-  #
-  # @example
-  #   menu = UI.menu('Plugins')
-  #   menu.add_item("Test") { puts 'Hello World' }
-  #
-  # @overload add_item(menu, &block)
-  #
-  #   @param [String] menu The name of the menu to add.
-  #   @yield  A block that will be invoked when the menu item is selected.
-  #   @return [Integer] A unique integer id for the added menu item.
-  #
-  # @overload add_item(command)
-  #
-  #   @param [UI::Command] command
-  #   @return [Integer] A unique integer id for the added menu item.
-  #
-  # @version SketchUp 6.0
-  def add_item(*args)
-  end
-
-  # The add_separator method is used to add a menu separator to a menu.
-  #
-  # @example
-  #   plugins_menu = UI.menu("Plugins")
-  #   plugins_menu.add_separator
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def add_separator
-  end
-
-  # The add_submenu method is used to add a sub-menu to a menu.
-  #
-  # @example
-  #   plugins_menu = UI.menu("Plugins")
-  #   submenu = plugins_menu.add_submenu("Test")
-  #   submenu.add_item("Hello World") {
-  #     UI.messagebox("Hi there!")
-  #   }
-  #
-  # @param [String] title
-  #   The title of the sub menu.
-  #
-  # @return [Sketchup::Menu] a Menu object
-  #
-  # @version SketchUp 6.0
-  def add_submenu(title)
-  end
-
-  # The set_validation_proc method is used to identify the menu validation
-  # procedure. Your procedure should return either MF_ENABLED, MF_DISABLED,
-  # MF_CHECKED, MF_UNCHECKED, or MF_GRAYED.
-  #
-  # @example
-  #   plugins_menu = UI.menu("Plugins")
-  #   item = plugins_menu.add_item("Test") { UI.messagebox "My Test Item"}
-  #   status = plugins_menu.set_validation_proc(item)  {
-  #     if Sketchup.is_pro?
-  #       MF_ENABLED
-  #     else
-  #       MF_GRAYED
-  #     end
-  #   }
-  #
-  # @param [String] menu
-  #   A string name of the menu to add.
-  #
-  # @return [Integer] a unique numerical item id for the menu
-  #
-  # @version SketchUp 6.0
-  #
-  # @yield A method that will be invoked when the menu item is
-  #   selected.
-  def set_validation_proc(menu, &block)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# An interface to a menu.
+#
+# @version SketchUp 6.0
+class Sketchup::Menu
+
+  # Instance Methods
+
+  # The {#add_item} method is used to add a menu item to the specified menu.
+  #
+  # This method takes a block that defines the action to perform when the menu
+  # item is selected.
+  #
+  # The item id that is returned can be used when adding an optional
+  # validation procedure for the menu item.
+  #
+  # @example
+  #   menu = UI.menu('Plugins')
+  #   menu.add_item("Test") { puts 'Hello World' }
+  #
+  # @overload add_item(title, &block)
+  #
+  #   @param [String] title
+  #   @yield  A block that will be invoked when the menu item is selected.
+  #   @return [Integer] A unique integer id for the added menu item.
+  #
+  # @overload add_item(command)
+  #
+  #   @param [UI::Command] command
+  #   @return [Integer] A unique integer id for the added menu item.
+  #
+  # @version SketchUp 6.0
+  def add_item(*args)
+  end
+
+  # The {#add_separator} method is used to add a menu separator to a menu.
+  #
+  # @example
+  #   plugins_menu = UI.menu("Plugins")
+  #   plugins_menu.add_separator
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def add_separator
+  end
+
+  # The {#add_submenu} method is used to add a sub-menu to a menu.
+  #
+  # @example
+  #   plugins_menu = UI.menu("Plugins")
+  #   submenu = plugins_menu.add_submenu("Test")
+  #   submenu.add_item("Hello World") {
+  #     UI.messagebox("Hi there!")
+  #   }
+  #
+  # @param [String] title
+  #   The title of the sub menu.
+  #
+  # @return [Sketchup::Menu] a Menu object
+  #
+  # @version SketchUp 6.0
+  def add_submenu(title)
+  end
+
+  # The {#set_validation_proc} method is used to specify the menu validation
+  # procedure. Your procedure should return either MF_ENABLED, MF_DISABLED,
+  # MF_CHECKED, MF_UNCHECKED, or MF_GRAYED.
+  #
+  # @example
+  #   plugins_menu = UI.menu("Plugins")
+  #   item = plugins_menu.add_item("Test") { UI.messagebox "My Test Item"}
+  #   status = plugins_menu.set_validation_proc(item)  {
+  #     if Sketchup.is_pro?
+  #       MF_ENABLED
+  #     else
+  #       MF_GRAYED
+  #     end
+  #   }
+  #
+  # @param [Integer] item
+  #   The numerical identifier for the menu item.
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield A method that will be invoked when the menu item is
+  #   selected.
+  def set_validation_proc(item, &block)
+  end
+
+end