sketchup-api-stubs 0.7.7 → 0.7.9

data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb

@@ -1,149 +1,149 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# A {Layout::TableCell} is a single cell from a table that contains data.
-#
-# @example
-#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-#   rows = 4
-#   columns = 4
-#   table = Layout::Table.new(bounds, rows, columns)
-#   table.each { |cell|
-#     puts cell.data.plain_text
-#   }
-#
-# @version LayOut 2018
-class Layout::TableCell
-
-  # Constants
-
-  ROTATION_0 = nil # Stub value.
-  ROTATION_180 = nil # Stub value.
-  ROTATION_270 = nil # Stub value.
-  ROTATION_90 = nil # Stub value.
-
-  # Instance Methods
-
-  # The {#data} method creates a copy of the {Layout::FormattedText} for the
-  # {Layout::TableCell}.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   cell_entity = table[1, 2].data
-  #
-  # @raise [ArgumentError] if the cell {Layout::Entity} is not a
-  #   {Layout::FormattedText}
-  #
-  # @version LayOut 2018
-  def data
-  end
-
-  # The {#data=} method sets the {Layout::Entity} of a {Layout::TableCell}.
-  # The text content and fill {Layout::Style} settings will be kept. The bounds
-  # and other {Layout::Style} settings are controlled by the {Layout::Table}. If
-  # the specified row and column is within a merged cell, then the merged cell
-  # itself will be affected.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   anchor = Geom::Point2d.new(1, 1)
-  #   text_anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
-  #   text = Layout::FormattedText.new("Test", anchor, text_anchor_type)
-  #   table[1, 2].data = text
-  #
-  # @note At the moment, this only works for {Layout::Entity}s that are
-  #   {Layout::FormattedText}s. However, future versions of LayOut may support
-  #   other types of {Layout::Entity}s for {Layout::TableCell}s, so this method
-  #   cannot be assumed to always fail with inputs of other {Layout::Entity}
-  #   types.
-  #
-  # @param [Layout::Entity] entity
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def data=(entity)
-  end
-
-  # The {#rotation} method returns the rotation of a {Layout::TableCell}.
-  #
-  # The rotation type can be one of the following values:
-  # [+Layout::TableCell::ROTATION_0+]
-  # [+Layout::TableCell::ROTATION_90+]
-  # [+Layout::TableCell::ROTATION_180+]
-  # [+Layout::TableCell::ROTATION_270+]
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   rotation = table[1, 1].rotation
-  #
-  # @raise [ArgumentError] if the cell is invalid due to residing within a
-  #   merged cell
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def rotation
-  end
-
-  # The {#rotation=} method sets the rotation of a {Layout::TableCell}.
-  #
-  # The rotation type can be one of the following values:
-  # [+Layout::TableCell::ROTATION_0+]
-  # [+Layout::TableCell::ROTATION_90+]
-  # [+Layout::TableCell::ROTATION_180+]
-  # [+Layout::TableCell::ROTATION_270+]
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   table[1, 1].rotation = Layout::TableCell::ROTATION_180
-  #
-  # @param [Integer] cell_rotation
-  #
-  # @raise [ArgumentError] if the cell is invalid due to residing within a
-  #   merged cell
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def rotation=(cell_rotation)
-  end
-
-  # The {#span} method returns the row and column span of a {Layout::TableCell}.
-  # If the values returned are both 1, then it is a normal, non-merged cell. If
-  # either of the values are greater than 1, then it is a merged cell. If the
-  # values are both 0, then it is an unused cell that resides within the inner
-  # portion of another merged cell.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   row_span, column_span = table[1, 1].span
-  #
-  # @return [Array(Integer, Integer)] Row span and column span.
-  #
-  # @version LayOut 2018
-  def span
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A {Layout::TableCell} is a single cell from a table that contains data.
+#
+# @example
+#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+#   rows = 4
+#   columns = 4
+#   table = Layout::Table.new(bounds, rows, columns)
+#   table.each { |cell|
+#     puts cell.data.plain_text
+#   }
+#
+# @version LayOut 2018
+class Layout::TableCell
+
+  # Constants
+
+  ROTATION_0 = nil # Stub value.
+  ROTATION_180 = nil # Stub value.
+  ROTATION_270 = nil # Stub value.
+  ROTATION_90 = nil # Stub value.
+
+  # Instance Methods
+
+  # The {#data} method creates a copy of the {Layout::FormattedText} for the
+  # {Layout::TableCell}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   cell_entity = table[1, 2].data
+  #
+  # @raise [ArgumentError] if the cell {Layout::Entity} is not a
+  #   {Layout::FormattedText}
+  #
+  # @version LayOut 2018
+  def data
+  end
+
+  # The {#data=} method sets the {Layout::Entity} of a {Layout::TableCell}.
+  # The text content and fill {Layout::Style} settings will be kept. The bounds
+  # and other {Layout::Style} settings are controlled by the {Layout::Table}. If
+  # the specified row and column is within a merged cell, then the merged cell
+  # itself will be affected.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   anchor = Geom::Point2d.new(1, 1)
+  #   text_anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
+  #   text = Layout::FormattedText.new("Test", anchor, text_anchor_type)
+  #   table[1, 2].data = text
+  #
+  # @note At the moment, this only works for {Layout::Entity}s that are
+  #   {Layout::FormattedText}s. However, future versions of LayOut may support
+  #   other types of {Layout::Entity}s for {Layout::TableCell}s, so this method
+  #   cannot be assumed to always fail with inputs of other {Layout::Entity}
+  #   types.
+  #
+  # @param [Layout::Entity] entity
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def data=(entity)
+  end
+
+  # The {#rotation} method returns the rotation of a {Layout::TableCell}.
+  #
+  # The rotation type can be one of the following values:
+  # [+Layout::TableCell::ROTATION_0+]
+  # [+Layout::TableCell::ROTATION_90+]
+  # [+Layout::TableCell::ROTATION_180+]
+  # [+Layout::TableCell::ROTATION_270+]
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   rotation = table[1, 1].rotation
+  #
+  # @raise [ArgumentError] if the cell is invalid due to residing within a
+  #   merged cell
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2018
+  def rotation
+  end
+
+  # The {#rotation=} method sets the rotation of a {Layout::TableCell}.
+  #
+  # The rotation type can be one of the following values:
+  # [+Layout::TableCell::ROTATION_0+]
+  # [+Layout::TableCell::ROTATION_90+]
+  # [+Layout::TableCell::ROTATION_180+]
+  # [+Layout::TableCell::ROTATION_270+]
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   table[1, 1].rotation = Layout::TableCell::ROTATION_180
+  #
+  # @param [Integer] cell_rotation
+  #
+  # @raise [ArgumentError] if the cell is invalid due to residing within a
+  #   merged cell
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def rotation=(cell_rotation)
+  end
+
+  # The {#span} method returns the row and column span of a {Layout::TableCell}.
+  # If the values returned are both 1, then it is a normal, non-merged cell. If
+  # either of the values are greater than 1, then it is a merged cell. If the
+  # values are both 0, then it is an unused cell that resides within the inner
+  # portion of another merged cell.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   row_span, column_span = table[1, 1].span
+  #
+  # @return [Array(Integer, Integer)] Row span and column span.
+  #
+  # @version LayOut 2018
+  def span
+  end
+
+end

data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb

@@ -1,139 +1,139 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# A {Layout::TableColumn} is a single column from a table.
-#
-# @example
-#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-#   rows = 4
-#   columns = 4
-#   table = Layout::Table.new(bounds, rows, columns)
-#   columns.times { |index|
-#     column = table.column(index)
-#   }
-#
-# @version LayOut 2018
-class Layout::TableColumn
-
-  # Instance Methods
-
-  # The {#left_edge_style} method returns the {Layout::Style} of a
-  # {Layout::TableColumn}'s left edge. If this is the first column of the table,
-  # this method will return the style of the table border.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = table.get_column(1).edge_style
-  #
-  # @return [Layout::Style]
-  #
-  # @version LayOut 2018
-  def left_edge_style
-  end
-
-  # The {#left_edge_style=} method sets the {Layout::Style} of a
-  # {Layout::TableColumn}'s left edge. If this is the first column of the table,
-  # this method will set the style for the table border.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = Layout::Style.new
-  #   style.stroke_width = 2.0
-  #   table.get_column(1).edge_style = style
-  #
-  # @param [Layout::Style] style
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def left_edge_style=(style)
-  end
-
-  # The {#right_edge_style} method returns the {Layout::Style} of a
-  # {Layout::TableColumn}'s right edge. If this is the last column of the table,
-  # this method will return the style of the table border.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = table.get_column(1).edge_style
-  #
-  # @return [Layout::Style]
-  #
-  # @version LayOut 2018
-  def right_edge_style
-  end
-
-  # The {#right_edge_style=} method sets the {Layout::Style} of a
-  # {Layout::TableColumn}'s right edge. If this is the last column of the table,
-  # this method will set the style for the table border.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = Layout::Style.new
-  #   style.stroke_width = 2.0
-  #   table.get_column(1).edge_style = style
-  #
-  # @param [Layout::Style] style
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def right_edge_style=(style)
-  end
-
-  # The {#width} method returns the width of the {Layout::TableColumn}.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   width = table.get_column(1).width
-  #
-  # @return [Float]
-  #
-  # @version LayOut 2018
-  def width
-  end
-
-  # The {#width=} method sets the width of the {Layout::TableColumn}.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   table.get_column(1).width = 6.0
-  #
-  # @param [Float] width
-  #
-  # @raise [ArgumentError] if width is not a valid width
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def width=(width)
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A {Layout::TableColumn} is a single column from a table.
+#
+# @example
+#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+#   rows = 4
+#   columns = 4
+#   table = Layout::Table.new(bounds, rows, columns)
+#   columns.times { |index|
+#     column = table.column(index)
+#   }
+#
+# @version LayOut 2018
+class Layout::TableColumn
+
+  # Instance Methods
+
+  # The {#left_edge_style} method returns the {Layout::Style} of a
+  # {Layout::TableColumn}'s left edge. If this is the first column of the table,
+  # this method will return the style of the table border.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = table.get_column(1).edge_style
+  #
+  # @return [Layout::Style]
+  #
+  # @version LayOut 2018
+  def left_edge_style
+  end
+
+  # The {#left_edge_style=} method sets the {Layout::Style} of a
+  # {Layout::TableColumn}'s left edge. If this is the first column of the table,
+  # this method will set the style for the table border.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = Layout::Style.new
+  #   style.stroke_width = 2.0
+  #   table.get_column(1).edge_style = style
+  #
+  # @param [Layout::Style] style
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def left_edge_style=(style)
+  end
+
+  # The {#right_edge_style} method returns the {Layout::Style} of a
+  # {Layout::TableColumn}'s right edge. If this is the last column of the table,
+  # this method will return the style of the table border.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = table.get_column(1).edge_style
+  #
+  # @return [Layout::Style]
+  #
+  # @version LayOut 2018
+  def right_edge_style
+  end
+
+  # The {#right_edge_style=} method sets the {Layout::Style} of a
+  # {Layout::TableColumn}'s right edge. If this is the last column of the table,
+  # this method will set the style for the table border.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = Layout::Style.new
+  #   style.stroke_width = 2.0
+  #   table.get_column(1).edge_style = style
+  #
+  # @param [Layout::Style] style
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def right_edge_style=(style)
+  end
+
+  # The {#width} method returns the width of the {Layout::TableColumn}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   width = table.get_column(1).width
+  #
+  # @return [Float]
+  #
+  # @version LayOut 2018
+  def width
+  end
+
+  # The {#width=} method sets the width of the {Layout::TableColumn}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   table.get_column(1).width = 6.0
+  #
+  # @param [Float] width
+  #
+  # @raise [ArgumentError] if width is not a valid width
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def width=(width)
+  end
+
+end