sketchup-api-stubs 0.7.7 → 0.7.8

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

@@ -1,8 +1,8 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# References an auto text definition. Some auto text definitions are mandatory.
-# Mandatory auto text definitions may not be removed, added, or modified.
+# References an auto-text definition. Some auto-text definitions are mandatory.
+# Mandatory auto-text definitions may not be removed, added, or modified.
 #
 # A mandatory {Layout::AutoTextDefinition} is one of the following types:
 # [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
@@ -15,6 +15,11 @@
 # [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
 # [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
 # [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
+# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
+# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
+# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
+# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
+# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
 #
 # @example
 #   doc = Layout::Document.open("C:/path/to/document.layout")
@@ -52,9 +57,17 @@ class Layout::AutoTextDefinition
   TYPE_MODEL_EDGE_LENGTH = nil # Stub value.
   TYPE_MODEL_FACE_AREA = nil # Stub value.
   TYPE_MODEL_GROUP_NAME = nil # Stub value.
+  TYPE_MODEL_RATIO = nil # Stub value.
+  TYPE_MODEL_SCALE = nil # Stub value.
+  TYPE_MODEL_SCENE_DESCRIPTION = nil # Stub value.
+  TYPE_MODEL_SCENE_NAME = nil # Stub value.
+  TYPE_MODEL_SECTION_NAME = nil # Stub value.
+  TYPE_MODEL_SECTION_SYMBOL = nil # Stub value.
   TYPE_MODEL_VOLUME = nil # Stub value.
+  TYPE_PAGE_COUNT = nil # Stub value.
   TYPE_PAGE_NAME = nil # Stub value.
   TYPE_PAGE_NUMBER = nil # Stub value.
+  TYPE_SEQUENCE = nil # Stub value.
 
   # Instance Methods
 
@@ -105,6 +118,8 @@ class Layout::AutoTextDefinition
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
   #   +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+
   #
+  # @raise [TypeError] if +custom_text+ is not a String or convertable to a String.
+  #
   # @version LayOut 2018
   def custom_text=(custom_text)
   end
@@ -139,6 +154,8 @@ class Layout::AutoTextDefinition
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
   #   +Layout::AutoTextDefinition::TYPE_DATE_*+.
   #
+  # @raise [TypeError] if date_format is not a String or convertable to a String.
+  #
   # @version LayOut 2018
   def date_format=(date_format)
   end
@@ -215,6 +232,82 @@ class Layout::AutoTextDefinition
   def display_full_path?
   end
 
+  # The {#end_page} method returns the end page for the
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   page_count_def =
+  #       doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
+  #   # Default end_page value is nil, meaning count to the end of the document
+  #   page = page_count_def.end_page
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
+  #
+  # @return [Layout::Page, nil]
+  #
+  # @version LayOut 2022.0
+  def end_page
+  end
+
+  # The {#end_page=} method sets the end page for the
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   definitions = doc.auto_text_definitions
+  #   page_count_def =
+  #       doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
+  #   # Stop the PageCount auto-text at this newly created page instead of at the end of the document
+  #   page_count_def.end_page = doc.pages.add("new page")
+  #
+  # @param [Layout::Page, nil] page
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
+  #
+  # @version LayOut 2022.0
+  def end_page=(page)
+  end
+
+  # The {#increment} method returns the increment value for
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def =
+  #       doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   # Default sequence increment value is 1
+  #   increment = sequence_def.increment
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2022.0
+  def increment
+  end
+
+  # The {#increment=} method sets the increment value for
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def =
+  #       doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   sequence_def.increment = 10
+  #
+  # @param [Integer] increment
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @version LayOut 2022.0
+  def increment=(increment)
+  end
+
   # The {#mandatory?} method returns whether the {Layout::AutoTextDefinition} is
   # mandatory or not.
   #
@@ -229,6 +322,11 @@ class Layout::AutoTextDefinition
   # [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
   # [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
   # [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
@@ -272,14 +370,18 @@ class Layout::AutoTextDefinition
   #
   # @raise [ArgumentError] if name is an empty string
   #
+  # @raise [TypeError] if name is not a String or convertable to a String.
+  #
   # @version LayOut 2018
   def name=(name)
   end
 
-  # The {#page_number_style} method returns the numbering style for the
-  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}.
+  # The {#number_style} method returns the numbering style for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
   #
-  # The page numbering style can be one of the following values:
+  # The numbering style can be one of the following values:
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
@@ -289,8 +391,70 @@ class Layout::AutoTextDefinition
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   definitions = doc.auto_text_definitions
-  #   number_style = definitions.last.page_number_style
+  #   sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   number_style = sequence_def.number_style
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2022.0
+  def number_style
+  end
+
+  # The {#number_style=} method sets the numbering style for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
+  # The numbering style can be one of the following values:
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   sequence_def.number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
+  #
+  # @param [Integer] number_style
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @raise [ArgumentError] if number_style is not a valid page numbering style
+  #
+  # @version LayOut 2022.0
+  def number_style=(number_style)
+  end
+
+  # The {#page_number_style} method returns the numbering style for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
+  #
+  # The numbering style can be one of the following values:
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
+  # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
+  #
+  # @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style}
+  #   method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
+  #   +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
+  #     Layout::AutoTextDefinition::TYPE_PAGE_NUMBER) number_style = page_number_def.number_style
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
   #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
@@ -301,10 +465,10 @@ class Layout::AutoTextDefinition
   def page_number_style
   end
 
-  # The {#page_number_style=} method sets the numbering style for the
-  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}.
+  # The {#page_number_style=} method sets the numbering style for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
   #
-  # The page numbering style can be one of the following values:
+  # The numbering style can be one of the following values:
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
@@ -312,32 +476,97 @@ class Layout::AutoTextDefinition
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
   #
+  # @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style=}
+  #   method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
+  #   +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   definitions = doc.auto_text_definitions
-  #   definitions.last.page_number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
+  #   page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
+  #     Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
+  #   page_number_def.page_number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
   #
   # @param [Integer] number_style
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
   #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
   #
-  # @raise [ArgumentError] if number_style is not a valid page numbering style
+  # @raise [ArgumentError] if +number_style+ is not a valid page numbering style
   #
   # @version LayOut 2018
   def page_number_style=(number_style)
   end
 
-  # The {#start_index} method returns the start index for the
-  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}.
+  # The {#renumber} method iterates through all uses of the
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition} and eliminates gaps and
+  # duplicates in the sequence.
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   definitions = doc.auto_text_definitions
-  #   start_index = definitions.first.start_index
+  #   sequence_def =
+  #       doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   sequence_def.renumber
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
-  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @version LayOut 2022.0
+  def renumber
+  end
+
+  # The {#sequence_format} method returns the sequence format of a
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def =
+  #       doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   # Default sequence format is ###, meaning entirely replace the string with the sequence number
+  #   sequence = sequence_def.sequence
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @return [String]
+  #
+  # @version LayOut 2022.0
+  def sequence_format
+  end
+
+  # The {#sequence_format=} method sets the sequence format of a
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def =
+  #       doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   sequence_def.sequence = "Figure ###"
+  #
+  # @param [String] sequence_format
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
+  #
+  # @raise [TypeError] if +sequence_format+ is not a String or convertable to a String.
+  #
+  # @version LayOut 2022.0
+  def sequence_format=(sequence_format)
+  end
+
+  # The {#start_index} method returns the start index for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   start_index = sequence_def.start_index
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
   #
   # @return [Integer]
   #
@@ -345,23 +574,74 @@ class Layout::AutoTextDefinition
   def start_index
   end
 
-  # The {#start_index} method returns the start index for the
-  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}.
+  # The {#start_index=} method sets the start index for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
+  # +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   definitions = doc.auto_text_definitions
-  #   definitions.first.start_index = 3
+  #   sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
+  #   sequence_def.start_index = 10
   #
   # @param [Integer] index
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
-  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
   #
   # @version LayOut 2018
   def start_index=(index)
   end
 
+  # The {#start_page} method returns the start page for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   page_number_def =
+  #       doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
+  #   # Default start page is the first page of the document. However we continue to start at that
+  #   # page even if that page is moved.
+  #   page = page_number_def.start_page
+  #   p page == doc.pages[0]
+  #   doc.pages.add('new page')
+  #   doc.pages.reorder(doc.pages[0], 1)
+  #   p page == doc.pages[1]
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
+  #
+  # @return [Layout::Page]
+  #
+  # @version LayOut 2022.0
+  def start_page
+  end
+
+  # The {#start_page=} method sets the start page for
+  # +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
+  # +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   page_number_def =
+  #       doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
+  #   # Start the PageCount auto-text on the new page
+  #   page_number_def.start_page = doc.pages.add('new page')
+  #
+  # @param [Layout::Page] page
+  #
+  # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
+  #
+  # @version LayOut 2022.0
+  def start_page=(page)
+  end
+
   # The {#tag} method returns the tag string of the {Layout::AutoTextDefinition}.
   #
   # @example
@@ -396,6 +676,13 @@ class Layout::AutoTextDefinition
   # [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
   # [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
   # [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_COUNT+]
+  # [+Layout::AutoTextDefinition::TYPE_SEQUENCE+]
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")

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

@@ -1,15 +1,15 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AutoTextDefinitions class is a container class for all
 # {Layout::AutoTextDefinition}s in a {Layout::Document}.
 #
 # @example
-#   # Grab a handle to an existing LayOut document's auto text definitions.
+#   # Grab a handle to an existing LayOut document's auto-text definitions.
 #   doc = Layout::Document.open("C:/path/to/document.layout")
 #   auto_texts = doc.auto_text_definitions
 #
-#   # From here, we can add auto text definitions to or remove them from the
+#   # From here, we can add auto-text definitions to or remove them from the
 #   # document.
 #   auto_texts.add("PageNum", Layout::AutoTextDefinition::TYPE_PAGE_NUM)
 #   auto_texts.remove("PageNum")
@@ -61,6 +61,8 @@ class Layout::AutoTextDefinitions
   # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
   # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
   # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_COUNT+]
+  # [+Layout::AutoTextDefinition::TYPE_SEQUENCE+]
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
@@ -71,7 +73,7 @@ class Layout::AutoTextDefinitions
   #
   # @param [Integer] type
   #
-  # @raise [ArgumentError] if type is not a valid auto text type, or is mandatory.
+  # @raise [ArgumentError] if type is not a valid auto-text type, or is mandatory.
   #
   # @return [Layout::AutoTextDefinition]
   #
@@ -148,6 +150,8 @@ class Layout::AutoTextDefinitions
   # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
   # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
   # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_COUNT+]
+  # [+Layout::AutoTextDefinition::TYPE_SEQUENCE+]
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Connection Point. A

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -47,6 +47,7 @@ class Layout::Document
   VERSION_2019 = nil # Stub value.
   VERSION_2020 = nil # Stub value.
   VERSION_2021 = nil # Stub value.
+  VERSION_2022 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_CURRENT = nil # Stub value.
 

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple elliptical shape entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Entities class is a container class for {Layout::Entity}s. A

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An entity is an object shown on a page of a LayOut document.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A formatted text entity.
@@ -37,9 +37,11 @@ class Layout::FormattedText < Layout::Entity
   # [+ANCHOR_TYPE_CENTER_CENTER+]
   # [+ANCHOR_TYPE_BOTTOM_CENTER+]
   #
+  # Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
+  #
   # @example
   #   anchor = Geom::Point2d.new(1, 1)
-  #   text = Layout::FormattedText.new("C:/Test.txt", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
+  #   text = Layout::FormattedText.new("C:/Test.txt", anchor,
   #
   # @overload new_from_file(path, bounds)
   #
@@ -130,17 +132,18 @@ class Layout::FormattedText < Layout::Entity
   # The {#display_text} method returns the display text representation of the
   # {Layout::FormattedText}.
   #
+  # Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT) doc.add_entity(text, doc.layers.first,
+  # doc.pages.first) text = text.display_text(doc.pages.first)
+  #
   # @example
   #   anchor = Geom::Point2d.new(1, 1)
-  #   text = Layout::FormattedText.new("<PageNumber>", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
-  #   doc.add_entity(text, doc.layers.first, doc.pages.first)
-  #   text = text.display_text(doc.pages.first)
+  #   text = Layout::FormattedText.new("<PageNumber>", anchor,
   #
-  # @note Passing an invalid {Layout::Page} will prevent an auto text tag from
+  # @note Passing an invalid {Layout::Page} will prevent an auto-text tag from
   #   being substituted with its display representation.
   #
   # @param [Layout::Page] page
-  #   The {Layout::Page} to use to convert an auto text
+  #   The {Layout::Page} to use to convert an auto-text
   #   tag to display text
   #
   # @raise [ArgumentError] if page is not in the same {Layout::Document} as
@@ -278,20 +281,20 @@ class Layout::FormattedText < Layout::Entity
   #   text = Layout::FormattedText.new("Test", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
   #   rtf_text = text.rtf
   #
-  # @note Passing an invalid {Layout::Page} will prevent an auto text tag from
+  # @note Passing an invalid {Layout::Page} will prevent an auto-text tag from
   #   being substituted with its display representation.
   #
   # @overload rtf
   #
   #   @return [String] The RTF text string. If the {Layout::FormattedText} is
-  #     auto text, this will be an auto text tag.
+  #     auto-text, this will be an auto-text tag.
   #
   # @overload rtf(page)
   #
   #   @param [Layout::Page] page The {Layout::Page} to use to convert an auto
   #     text tag to display text
   #   @return [String] The RTF text string. If the {Layout::FormattedText} is
-  #     auto text, this will be the display text.
+  #     auto-text, this will be the display text.
   #
   # @raise [ArgumentError] if page is not in the same {Layout::Document} as
   #   the {Layout::FormattedText}
@@ -303,10 +306,12 @@ class Layout::FormattedText < Layout::Entity
   # The {#rtf=} method sets the raw RTF representation of the
   # {Layout::FormattedText}.
   #
+  # text.\par}"
+  #
   # @example
   #   anchor = Geom::Point2d.new(1, 1)
   #   text = Layout::FormattedText.new("Test", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
-  #   text.rtf = "{\rtf1\ansi{\fonttbl\f0\fswiss Helvetica;}\f0\pard This is some {\b bold} text.\par}"
+  #   text.rtf = "{\rtf1\ansi{\fonttbl\f0\fswiss Helvetica;}\f0\pard This is some {\b bold}
   #
   # @param [String] rtf_text
   #

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A group is a special type of {Layout::Entity} that does not belong to a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A raster image entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is an interface to a label entity. A {Layout::Label} consists of a
@@ -173,7 +173,7 @@ class Layout::Label < Layout::Entity
   # @overload entities(page)
   #
   #   @param [Layout::Page] page The {Layout::Page} to use to convert an
-  #     auto text tag to display text
+  #     auto-text tag to display text
   #   @return [Layout::Entities]
   #
   # @raise [ArgumentError] if page does not belong to the same document as the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Layer Definition. A layer definition

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an instance of a {Layout::Layer}. A {Layout::LayerInstance}