sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Layout/Grid.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class that references a {Layout::Document}'s grid settings.

data/SketchUp/Layout/Group.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A group is a special type of {Layout::Entity} that does not belong to a
@@ -47,19 +47,19 @@ class Layout::Group < Layout::Entity
   #
   # @raise [ArgumentError] if entities is empty.
   #
-  # @raise [ArgumentError] if entities contains the same {Layout::Entity} more
-  #   than once
-  #
-  # @raise [ArgumentError] if entities contains {Layout::Entity}s on both shared
-  #   and non-shared {Layout::Layer}s, or on non-shared {Layout::Layer}s
-  #   belonging to different {Layout::Page}s
+  # @raise [ArgumentError] if entities contains {Layout::Entity}s that belong to
+  #   different {Layout::Document}s
   #
   # @raise [ArgumentError] if entities contains a mix of {Layout::Entity}s that
   #   belong to a {Layout::Document} and {Layout::Entity}s that don't belong to a
   #   {Layout::Document}
   #
-  # @raise [ArgumentError] if entities contains {Layout::Entity}s that belong to
-  #   different {Layout::Document}s
+  # @raise [ArgumentError] if entities contains {Layout::Entity}s on both shared
+  #   and non-shared {Layout::Layer}s, or on non-shared {Layout::Layer}s
+  #   belonging to different {Layout::Page}s
+  #
+  # @raise [ArgumentError] if entities contains the same {Layout::Entity} more
+  #   than once
   #
   # @return [Layout::Group]
   #
@@ -84,10 +84,10 @@ class Layout::Group < Layout::Entity
   #
   # @raise [ArgumentError] if the {Layout::Group} does not have a scale factor
   #
-  # @raise [Layout::LockedLayerError] if the {Layout::Group} is on a locked layer
-  #
   # @raise [Layout::LockedEntityError] if the {Layout::Group} is locked
   #
+  # @raise [Layout::LockedLayerError] if the {Layout::Group} is on a locked layer
+  #
   # @version LayOut 2018
   def remove_scale_factor(resize_behavior)
   end
@@ -187,11 +187,11 @@ class Layout::Group < Layout::Entity
   #
   # @raise [ArgumentError] if the {Layout::Group} does not have a scale factor
   #
-  # @raise [ArgumentError] if scale_units is not a valid value
+  # @raise [Layout::LockedEntityError] if the {Layout::Group} is locked
   #
   # @raise [Layout::LockedLayerError] if the {Layout::Group} is on a locked layer
   #
-  # @raise [Layout::LockedEntityError] if the {Layout::Group} is locked
+  # @raise [ArgumentError] if scale_units is not a valid value
   #
   # @version LayOut 2018
   def scale_units=(units_format)
@@ -219,24 +219,24 @@ class Layout::Group < Layout::Entity
   #   group = doc.shared_entities.first
   #   group.set_scale_factor(2.0, Layout::Group::RESIZE_BEHAVIOR_BOUNDS)
   #
-  # @param [Integer] units_format
-  #
   # @param [Float] scale_factor
   #
+  # @param [Integer] units_format
+  #
   # @param [Integer] resize_behavior
   #
   # @raise [LockedLayerError] if the {Layout::Group} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if a scale factor cannot be set for the
-  #   {Layout::Group}
+  # @raise [LockedEntityError] if the {Layout::Group} is locked
   #
   # @raise [ArgumentError] if scale_factor is an invalid value
   #
   # @raise [ArgumentError] if the {Layout::Group} cannot be assigned a scale
   #   factor because it is already inheriting a scale factor from its parent
   #
-  # @raise [LockedEntityError] if the {Layout::Group} is locked
+  # @raise [ArgumentError] if a scale factor cannot be set for the
+  #   {Layout::Group}
   #
   # @version LayOut 2018
   def set_scale_factor(scale_factor, units_format, resize_behavior)

data/SketchUp/Layout/Image.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A raster image entity.
@@ -48,12 +48,12 @@ class Layout::Image < Layout::Entity
   #
   # @raise [ArgumentError] if clip mask is already in a document
   #
-  # @raise [LockedEntityError] if the {Layout::Image} is locked
+  # @raise [ArgumentError] if clip mask is not a {Layout::Path},
+  #   {Layout::Rectangle}, or {Layout::Ellipse}
   #
   # @raise [LockedLayerError] if the {Layout::Image} is on a locked {Layout::Layer}
   #
-  # @raise [ArgumentError] if clip mask is not a {Layout::Path},
-  #   {Layout::Rectangle}, or {Layout::Ellipse}
+  # @raise [LockedEntityError] if the {Layout::Image} is locked
   #
   # @version LayOut 2018
   def clip_mask=(clip_mask)
@@ -72,11 +72,11 @@ class Layout::Image < Layout::Entity
   #
   # @raise [ArgumentError] if bounds are zero size
   #
-  # @raise [RuntimeError] if there was an error allocating memory for the image
-  #
   # @raise [ArgumentError] if there was an error reading the image file, such as
   #   the file name being invalid
   #
+  # @raise [RuntimeError] if there was an error allocating memory for the image
+  #
   # @return [Layout::Image]
   #
   # @version LayOut 2018

data/SketchUp/Layout/Label.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is an interface to a label entity. A {Layout::Label} consists of a
@@ -57,14 +57,14 @@ class Layout::Label < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::Label} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if both the {Layout::Label} and the
-  #   {Layout::ConnectionPoint} are on non-shared {Layout::Layers}, but are not
-  #   on the same {Layout::Page}.
+  # @raise [LockedEntityError] if the {Layout::Label} is locked
   #
   # @raise [ArgumentError] if the {Layout::Label} is not in the same
   #   {Layout::Document} as the {Layout::ConnectionPoint}
   #
-  # @raise [LockedEntityError] if the {Layout::Label} is locked
+  # @raise [ArgumentError] if both the {Layout::Label} and the
+  #   {Layout::ConnectionPoint} are on non-shared {Layout::Layers}, but are not
+  #   on the same {Layout::Page}.
   #
   # @version LayOut 2018
   def connect(connection_point)
@@ -127,11 +127,11 @@ class Layout::Label < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::Label} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Label} is locked
+  #
   # @raise [ArgumentError] if the connection_type is not a valid text connection
   #   type
   #
-  # @raise [LockedEntityError] if the {Layout::Label} is locked
-  #
   # @version LayOut 2018
   def connection_type=(connection_type)
   end
@@ -219,11 +219,11 @@ class Layout::Label < Layout::Entity
   #
   # @raise [ArgumentError] if anchor_type is not a valid anchor type
   #
-  # @raise [ArgumentError] if plain_text is an empty string
+  # @raise [ArgumentError] if leader_type is not a valid leader line type
   #
   # @raise [ArgumentError] if bounds is zero size
   #
-  # @raise [ArgumentError] if leader_type is not a valid leader line type
+  # @raise [ArgumentError] if plain_text is an empty string
   #
   # @version LayOut 2018
   def initialize(*args)
@@ -260,11 +260,11 @@ class Layout::Label < Layout::Entity
   #
   # @param [Layout::Path] leader_path
   #
-  # @raise [LockedEntityError] if the {Layout::Label} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Label} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Label} is locked
+  #
   # @version LayOut 2018
   def leader_line=(leader_path)
   end
@@ -316,11 +316,11 @@ class Layout::Label < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::Label} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Label} is locked
+  #
   # @raise [ArgumentError] if leader_type is
   #   +Layout::Label::LEADER_LINE_TYPE_UNKNOWN+ or not a valid leader line type
   #
-  # @raise [LockedEntityError] if the {Layout::Label} is locked
-  #
   # @version LayOut 2018
   def leader_line_type=(leader_type)
   end
@@ -359,11 +359,11 @@ class Layout::Label < Layout::Entity
   #
   # @param [Layout::FormattedText] new_text
   #
-  # @raise [LockedEntityError] if the {Layout::Label} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Label} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Label} is locked
+  #
   # @version LayOut 2018
   def text=(new_text)
   end

data/SketchUp/Layout/Layer.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Layer Definition. A layer definition
@@ -167,10 +167,10 @@ class Layout::Layer
   #   The share action that specifies what to do
   #   with {Layout::Entity}s after the {Layout::Layer} is non-shared.
   #
-  # @raise [ArgumentError] if unshare_action is not a valid value
-  #
   # @raise [LockedLayerError] if the {Layout::Layer} is locked
   #
+  # @raise [ArgumentError] if unshare_action is not a valid value
+  #
   # @version LayOut 2018
   def set_nonshared(page, unshare_action)
   end
@@ -196,10 +196,10 @@ class Layout::Layer
   #   The share action that specifies what to do with
   #   {Layout::Entity}s after the {Layout::Layer} is shared.
   #
-  # @raise [ArgumentError] if share_action is not a valid value
-  #
   # @raise [Layout::LockedLayerError] if the {Layout::Layer} is locked
   #
+  # @raise [ArgumentError] if share_action is not a valid value
+  #
   # @version LayOut 2018
   def set_shared(page, share_action)
   end

data/SketchUp/Layout/LayerInstance.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an instance of a {Layout::Layer}. A {Layout::LayerInstance}
@@ -117,10 +117,10 @@ class Layout::LayerInstance
   # @param [Integer] index
   #   The desired index of the {Layout::Entity}
   #
-  # @raise [IndexError] if index is out of range
-  #
   # @raise [ArgumentError] if entity is not on the {Layout::LayerInstance}
   #
+  # @raise [IndexError] if index is out of range
+  #
   # @version LayOut 2018
   def reorder_entity(entity, index)
   end

data/SketchUp/Layout/Layers.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layers class is a container class for all layers in a {Layout::Document}.

data/SketchUp/Layout/LinearDimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References a linear dimension entity. A {Layout::LinearDimension} is composed
@@ -41,11 +41,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Boolean] uses_auto_scale
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def auto_scale=(uses_auto_scale)
   end
@@ -89,11 +89,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Layout::ConnectionPoint] end_connection
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def connect(start_connection, end_connection)
   end
@@ -112,11 +112,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Boolean] uses_custom_text
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def custom_text=(uses_custom_text)
   end
@@ -188,11 +188,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Geom::Point2d] end_point
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def end_connection_point=(end_point)
   end
@@ -226,11 +226,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Geom::Point2d] end_extent
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def end_extent_point=(end_extent)
   end
@@ -249,11 +249,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Numeric] offset_length
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def end_offset_length=(offset_length)
   end
@@ -359,11 +359,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @raise [ArgumentError] if leader_line_type is not a valid leader line type
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def leader_line_type=(type)
   end
@@ -399,10 +399,10 @@ class Layout::LinearDimension < Layout::Entity
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [ArgumentError] if scale is negative, or greater than 1.0
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def scale=(scale)
   end
@@ -435,11 +435,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Geom::Point2d] start_point
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def start_connection_point=(start_point)
   end
@@ -473,11 +473,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Geom::Point2d] start_extent
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def start_extent_point=(start_extent)
   end
@@ -496,11 +496,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Numeric] offset_length
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def start_offset_length=(offset_length)
   end
@@ -551,11 +551,11 @@ class Layout::LinearDimension < Layout::Entity
   #
   # @param [Layout::FormattedText] formatted_text
   #
-  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::LinearDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::LinearDimension} is locked
+  #
   # @version LayOut 2018
   def text=(formatted_text)
   end