sketchup-api-stubs 0.7.9 → 0.7.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +157 -151
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +182 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +111 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +423 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +693 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +535 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +500 -476
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +267 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +133 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +547 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +678 -693
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +751 -747
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +683 -517
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +464 -353
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +614 -567
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +282 -183
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +458 -387
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +346 -344
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -82
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +714 -692
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1565 -1519
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +286 -278
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +196 -144
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +226 -209
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +145 -150
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +296 -302
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +473 -478
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -121
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +673 -659
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +600 -593
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +252 -257
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +443 -449
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +167 -165
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +403 -406
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -397
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1282 -1239
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -261
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +519 -545
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb +406 -0
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb +185 -0
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb +113 -0
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +122 -125
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +1006 -937
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -102
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +740 -750
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +289 -282
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +64 -62
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +405 -468
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +432 -406
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +307 -306
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +332 -326
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +380 -422
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +409 -427
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +241 -249
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +55 -48
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -114
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +1115 -414
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +330 -317
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1714 -1652
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +372 -357
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +133 -130
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -271
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +463 -490
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +104 -116
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +939 -797
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +388 -361
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +501 -478
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +385 -361
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +451 -458
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +211 -212
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +259 -255
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +88 -69
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +263 -217
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +283 -262
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +199 -217
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +924 -834
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +143 -142
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1566 -1311
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +71 -45
  149. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1429 -1377
  150. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
  151. data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
  152. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +399 -389
  153. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +580 -494
  154. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +280 -269
  155. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +258 -241
  156. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +636 -635
  157. data/lib/sketchup-api-stubs/stubs/UI.rb +791 -683
  158. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -303
  159. data/lib/sketchup-api-stubs.rb +1 -1
  160. metadata +10 -24
@@ -1,387 +1,458 @@
1
- # Copyright:: Copyright 2023 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This is the interface to a {Layout::Document}'s paper space information. The
5
- # paper size and margins, display resolution, and colors can all be accessed
6
- # and set through this class.
7
- #
8
- # @example
9
- # doc = Layout::Document.open("C:/path/to/document.layout")
10
- # page_info = doc.page_info
11
- # # Get the paper height and width and set the output resolution
12
- # width = page_info.width
13
- # height = page_info.height
14
- # page_info.output_resolution = Layout::PageInfo::RESOLUTION_HIGH
15
- #
16
- # @version LayOut 2018
17
- class Layout::PageInfo
18
-
19
- # Constants
20
-
21
- RESOLUTION_HIGH = nil # Stub value.
22
- RESOLUTION_LOW = nil # Stub value.
23
- RESOLUTION_MEDIUM = nil # Stub value.
24
-
25
- # Instance Methods
26
-
27
- # The {bottom_margin} method returns the paper's bottom margin in document
28
- # units.
29
- #
30
- # @example
31
- # doc = Layout::Document.open("C:/path/to/document.layout")
32
- # bottom_margin = doc.page_info.bottom_margin
33
- #
34
- # @return [Numeric]
35
- #
36
- # @version LayOut 2018
37
- def bottom_margin
38
- end
39
-
40
- # The {#bottom_margin=} method sets the paper's bottom margin in document units.
41
- #
42
- # @example
43
- # doc = Layout::Document.open("C:/path/to/document.layout")
44
- # doc.page_info.bottom_margin = 0.40
45
- #
46
- # @param [Numeric] margin
47
- #
48
- # @raise [ArgumentError] if margin is less than 0 or greater than the page
49
- # height
50
- #
51
- # @version LayOut 2018
52
- def bottom_margin=(margin)
53
- end
54
-
55
- # The {#color} method returns the paper's color.
56
- #
57
- # @example
58
- # doc = Layout::Document.open("C:/path/to/document.layout")
59
- # paper_color = Layout.page_info.color
60
- #
61
- # @return [Sketchup::Color]
62
- #
63
- # @version LayOut 2018
64
- def color
65
- end
66
-
67
- # The {#color=} method sets the paper's color.
68
- #
69
- # @example
70
- # doc = Layout::Document.open("C:/path/to/document.layout")
71
- # doc.page_info.color = Sketchup::Color.new(45, 45, 75, 255)
72
- #
73
- # @param [Sketchup::Color] new_color
74
- #
75
- # @version LayOut 2018
76
- def color=(new_color)
77
- end
78
-
79
- # The {#display_resolution} method returns the on screen rendering resolution
80
- # quality.
81
- #
82
- # The resolution can be one of the following values:
83
- # [+Layout::PageInfo::RESOLUTION_LOW+]
84
- # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
85
- # [+Layout::PageInfo::RESOLUTION_HIGH+]
86
- #
87
- # @example
88
- # doc = Layout::Document.open("C:/path/to/document.layout")
89
- # display_resolution = doc.page_info.display_resolution
90
- #
91
- # @return [Integer]
92
- #
93
- # @version LayOut 2018
94
- def display_resolution
95
- end
96
-
97
- # The {#display_resolution=} method sets the on screen rendering resolution
98
- # quality.
99
- #
100
- # The resolution can be one of the following values:
101
- # [+Layout::PageInfo::RESOLUTION_LOW+]
102
- # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
103
- # [+Layout::PageInfo::RESOLUTION_HIGH+]
104
- #
105
- # @example
106
- # doc = Layout::Document.open("C:/path/to/document.layout")
107
- # doc.page_info.display_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
108
- #
109
- # @param [Integer] resolution
110
- #
111
- # @raise [ArgumentError] if resolution is not a valid resolution value
112
- #
113
- # @version LayOut 2018
114
- def display_resolution=(resolution)
115
- end
116
-
117
- # The {#height} method returns the paper height in document units.
118
- #
119
- # @example
120
- # doc = Layout::Document.open("C:/path/to/document.layout")
121
- # height = doc.page_info.height
122
- #
123
- # @return [Numeric]
124
- #
125
- # @version LayOut 2018
126
- def height
127
- end
128
-
129
- # The {#height=} method sets the paper height in document units.
130
- #
131
- # @example
132
- # doc = Layout::Document.open("C:/path/to/document.layout")
133
- # doc.page_info.height = 8.5
134
- #
135
- # @param [Numeric] height
136
- #
137
- # @raise [ArgumentError] if height is less than 1 or greater than 200
138
- #
139
- # @version LayOut 2018
140
- def height=(height)
141
- end
142
-
143
- # The {#left_margin} method returns the paper's left margin in document units.
144
- #
145
- # @example
146
- # doc = Layout::Document.open("C:/path/to/document.layout")
147
- # left_margin = doc.page_info.left_margin
148
- #
149
- # @return [Numeric]
150
- #
151
- # @version LayOut 2018
152
- def left_margin
153
- end
154
-
155
- # The {#left_margin=} method sets the paper's left margin in document units.
156
- #
157
- # @example
158
- # doc = Layout::Document.open("C:/path/to/document.layout")
159
- # doc.page_info.left_margin = 0.40
160
- #
161
- # @param [Numeric] margin
162
- #
163
- # @raise [ArgumentError] if margin is less than 0 or greater than the page
164
- # width
165
- #
166
- # @version LayOut 2018
167
- def left_margin=(margin)
168
- end
169
-
170
- # The {#margin_color} method returns the color of the paper's margin.
171
- #
172
- # @example
173
- # doc = Layout::Document.open("C:/path/to/document.layout")
174
- # margin_color = doc.page_info.margin_color
175
- #
176
- # @return [Sketchup::Color]
177
- #
178
- # @version LayOut 2018
179
- def margin_color
180
- end
181
-
182
- # The {#margin_color=} sets the color of paper's margin.
183
- #
184
- # @example
185
- # doc = Layout::Document.open("C:/path/to/document.layout")
186
- # new_color = Sketchup::Color("Red")
187
- # doc.page_info.margin_color = new_color
188
- #
189
- # @param [Sketchup::Color] color
190
- #
191
- # @version LayOut 2018
192
- def margin_color=(color)
193
- end
194
-
195
- # The {#output_resolution} method returns the output rendering resolution
196
- # quality.
197
- #
198
- # The resolution can be one of the following values:
199
- # [+Layout::PageInfo::RESOLUTION_LOW+]
200
- # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
201
- # [+Layout::PageInfo::RESOLUTION_HIGH+]
202
- #
203
- # @example
204
- # doc = Layout::Document.open("C:/path/to/document.layout")
205
- # output_resolution = doc.page_info.output_resolution
206
- #
207
- # @return [Integer]
208
- #
209
- # @version LayOut 2018
210
- def output_resolution
211
- end
212
-
213
- # The {#output_resolution=} method sets the output rendering resolution
214
- # quality.
215
- #
216
- # The resolution can be one of the following values:
217
- # [+Layout::PageInfo::RESOLUTION_LOW+]
218
- # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
219
- # [+Layout::PageInfo::RESOLUTION_HIGH+]
220
- #
221
- # @example
222
- # doc = Layout::Document.open("C:/path/to/document.layout")
223
- # doc.page_info.output_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
224
- #
225
- # @param [Integer] resolution
226
- #
227
- # @raise [ArgumentError] if resolution is not a valid resolution value
228
- #
229
- # @version LayOut 2018
230
- def output_resolution=(resolution)
231
- end
232
-
233
- # The {#print_margins=} method sets whether to print the paper's margins.
234
- #
235
- # @example
236
- # doc = Layout::Document.open("C:/path/to/document.layout")
237
- # doc.page_info.print_margins=true
238
- #
239
- # @param [Boolean] print
240
- #
241
- # @version LayOut 2018
242
- def print_margins=(print)
243
- end
244
-
245
- # The {#print_margins?} method returns whether to print the paper's margins.
246
- #
247
- # @example
248
- # doc = Layout::Document.open("C:/path/to/document.layout")
249
- # margins_printed = doc.page_info.print_margins?
250
- #
251
- # @return [Boolean]
252
- #
253
- # @version LayOut 2018
254
- def print_margins?
255
- end
256
-
257
- # The {#print_paper_color=} method sets whether or not the page color should be
258
- # printed.
259
- #
260
- # @example
261
- # doc = Layout::Document.open("C:/path/to/document.layout")
262
- # doc.page_info.print_color = true
263
- #
264
- # @param [Boolean] print_paper_color
265
- #
266
- # @version LayOut 2018
267
- def print_paper_color=(print_paper_color)
268
- end
269
-
270
- # The {#print_paper_color?} method returns whether or not the page color should
271
- # be printed.
272
- #
273
- # @example
274
- # doc = Layout::Document.open("C:/path/to/document.layout")
275
- # paper_color = doc.page_info.print_paper_color?
276
- #
277
- # @return [Boolean]
278
- #
279
- # @version LayOut 2018
280
- def print_paper_color?
281
- end
282
-
283
- # The {#right_margin} method returns the paper's right margin in document units.
284
- #
285
- # @example
286
- # doc = Layout::Document.open("C:/path/to/document.layout")
287
- # right_margin = doc.page_info.right_margin
288
- #
289
- # @return [Numeric]
290
- #
291
- # @version LayOut 2018
292
- def right_margin
293
- end
294
-
295
- # The {#right_margin=} sets the paper's right margin in document units.
296
- #
297
- # @example
298
- # doc = Layout::Document.open("C:/path/to/document.layout")
299
- # doc.page_info.right_margin = 0.40
300
- #
301
- # @param [Numeric] margin
302
- #
303
- # @raise [ArgumentError] if margin is less than 0 or greater than the page
304
- # width
305
- #
306
- # @version LayOut 2018
307
- def right_margin=(margin)
308
- end
309
-
310
- # The {#show_margins=} method sets whether the paper's margins are visible.
311
- #
312
- # @example
313
- # doc = Layout::Document.open("C:/path/to/document.layout")
314
- # doc.page_info.show_margins = false
315
- #
316
- # @param [Boolean] margins_visible
317
- #
318
- # @version LayOut 2018
319
- def show_margins=(margins_visible)
320
- end
321
-
322
- # The {#show_margins?} method returns whether the paper's margins are visible.
323
- #
324
- # @example
325
- # doc = Layout::Document.open("C:/path/to/document.layout")
326
- # show_margins = doc.page_info.show_margins?
327
- #
328
- # @return [Boolean]
329
- #
330
- # @version LayOut 2018
331
- def show_margins?
332
- end
333
-
334
- # The {#top_margin} method returns the paper's top margin in document units.
335
- #
336
- # @example
337
- # doc = Layout::Document.open("C:/path/to/document.layout")
338
- # top_margin = doc.page_info.top_margin
339
- #
340
- # @return [Numeric]
341
- #
342
- # @version LayOut 2018
343
- def top_margin
344
- end
345
-
346
- # The {#top_margin} method sets the paper's top margin in document units.
347
- #
348
- # @example
349
- # doc = Layout::Document.open("C:/path/to/document.layout")
350
- # doc.page_info.top_margin = 0.40
351
- #
352
- # @param [Numeric] margin
353
- #
354
- # @raise [ArgumentError] if margin is less than 0 or greater than the page
355
- # height
356
- #
357
- # @version LayOut 2018
358
- def top_margin=(margin)
359
- end
360
-
361
- # The {#width} method returns the paper width in document units.
362
- #
363
- # @example
364
- # doc = Layout::Document.open("C:/path/to/document.layout")
365
- # width = doc.page_info.width
366
- #
367
- # @return [Numeric]
368
- #
369
- # @version LayOut 2018
370
- def width
371
- end
372
-
373
- # The {#width=} method sets the paper width in document units.
374
- #
375
- # @example
376
- # doc = Layout::Document.open("C:/path/to/document.layout")
377
- # doc.page_info.width = 8.5
378
- #
379
- # @param [Numeric] width
380
- #
381
- # @raise [ArgumentError] if width is less than 1 or greater than 200
382
- #
383
- # @version LayOut 2018
384
- def width=(width)
385
- end
386
-
387
- end
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This is the interface to a {Layout::Document}'s paper space information. The
5
+ # paper size and margins, display resolution, and colors can all be accessed
6
+ # and set through this class.
7
+ #
8
+ # @example
9
+ # doc = Layout::Document.open("C:/path/to/document.layout")
10
+ # page_info = doc.page_info
11
+ # # Get the paper height and width and set the output resolution
12
+ # width = page_info.width
13
+ # height = page_info.height
14
+ # page_info.output_resolution = Layout::PageInfo::RESOLUTION_HIGH
15
+ #
16
+ # @version LayOut 2018
17
+ class Layout::PageInfo
18
+
19
+ # Constants
20
+
21
+ RESOLUTION_HIGH = nil # Stub value.
22
+ RESOLUTION_LOW = nil # Stub value.
23
+ RESOLUTION_MEDIUM = nil # Stub value.
24
+
25
+ # Instance Methods
26
+
27
+ # The {bottom_margin} method returns the paper's bottom margin in inches.
28
+ #
29
+ # @example
30
+ # doc = Layout::Document.open("C:/path/to/document.layout")
31
+ # bottom_margin = doc.page_info.bottom_margin
32
+ #
33
+ # @return [Numeric]
34
+ #
35
+ # @version LayOut 2018
36
+ def bottom_margin
37
+ end
38
+
39
+ # The {#bottom_margin=} method sets the paper's bottom margin in inches.
40
+ #
41
+ # @example
42
+ # doc = Layout::Document.open("C:/path/to/document.layout")
43
+ # doc.page_info.bottom_margin = 0.40
44
+ #
45
+ # @param [Numeric] margin
46
+ #
47
+ # @raise [ArgumentError] if margin is less than 0 or greater than the page
48
+ # height
49
+ #
50
+ # @version LayOut 2018
51
+ def bottom_margin=(margin)
52
+ end
53
+
54
+ # The {#color} method returns the paper's color.
55
+ #
56
+ # @example
57
+ # doc = Layout::Document.open("C:/path/to/document.layout")
58
+ # paper_color = Layout.page_info.color
59
+ #
60
+ # @return [Sketchup::Color]
61
+ #
62
+ # @version LayOut 2018
63
+ def color
64
+ end
65
+
66
+ # The {#color=} method sets the paper's color.
67
+ #
68
+ # @example
69
+ # doc = Layout::Document.open("C:/path/to/document.layout")
70
+ # doc.page_info.color = Sketchup::Color.new(45, 45, 75, 255)
71
+ #
72
+ # @param [Sketchup::Color] new_color
73
+ #
74
+ # @version LayOut 2018
75
+ def color=(new_color)
76
+ end
77
+
78
+ # The {#display_resolution} method returns the on screen rendering resolution
79
+ # quality.
80
+ #
81
+ # The resolution can be one of the following values:
82
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
83
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
84
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
85
+ #
86
+ # @example
87
+ # doc = Layout::Document.open("C:/path/to/document.layout")
88
+ # display_resolution = doc.page_info.display_resolution
89
+ #
90
+ # @return [Integer]
91
+ #
92
+ # @version LayOut 2018
93
+ def display_resolution
94
+ end
95
+
96
+ # The {#display_resolution=} method sets the on screen rendering resolution
97
+ # quality.
98
+ #
99
+ # The resolution can be one of the following values:
100
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
101
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
102
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
103
+ #
104
+ # @example
105
+ # doc = Layout::Document.open("C:/path/to/document.layout")
106
+ # doc.page_info.display_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
107
+ #
108
+ # @param [Integer] resolution
109
+ #
110
+ # @raise [ArgumentError] if resolution is not a valid resolution value
111
+ #
112
+ # @version LayOut 2018
113
+ def display_resolution=(resolution)
114
+ end
115
+
116
+ # The {#height} method returns the paper height in inches.
117
+ #
118
+ # @example
119
+ # doc = Layout::Document.open("C:/path/to/document.layout")
120
+ # height = doc.page_info.height
121
+ #
122
+ # @return [Numeric]
123
+ #
124
+ # @version LayOut 2018
125
+ def height
126
+ end
127
+
128
+ # The {#height=} method sets the paper height in inches.
129
+ #
130
+ # @example
131
+ # doc = Layout::Document.open("C:/path/to/document.layout")
132
+ # doc.page_info.height = 8.5
133
+ #
134
+ # @param [Numeric] height
135
+ #
136
+ # @raise [ArgumentError] if height is less than 1 or greater than 200
137
+ #
138
+ # @version LayOut 2018
139
+ def height=(height)
140
+ end
141
+
142
+ # The {#image_display_resolution} method returns the on screen image quality.
143
+ #
144
+ # The resolution can be one of the following values:
145
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
146
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
147
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
148
+ #
149
+ # @example
150
+ # doc = Layout::Document.open("C:/path/to/document.layout")
151
+ # image_quality = doc.page_info.image_display_resolution
152
+ #
153
+ # @return [Integer]
154
+ #
155
+ # @version LayOut 2023.1
156
+ def image_display_resolution
157
+ end
158
+
159
+ # The {#image_display_resolution=} method sets the on screen image quality.
160
+ #
161
+ # The resolution can be one of the following values:
162
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
163
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
164
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
165
+ #
166
+ # @example
167
+ # doc = Layout::Document.open("C:/path/to/document.layout")
168
+ # doc.page_info.image_display_resolution = Layout::PageInfo::RESOLUTION_LOW
169
+ #
170
+ # @param [Integer] resolution
171
+ #
172
+ # @raise [ArgumentError] if resolution is not a valid resolution value
173
+ #
174
+ # @version LayOut 2023.1
175
+ def image_display_resolution=(resolution)
176
+ end
177
+
178
+ # The {#image_output_resolution} method returns the output image quality.
179
+ #
180
+ # The resolution can be one of the following values:
181
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
182
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
183
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
184
+ #
185
+ # @example
186
+ # doc = Layout::Document.open("C:/path/to/document.layout")
187
+ # image_quality = doc.page_info.image_output_resolution
188
+ #
189
+ # @return [Integer]
190
+ #
191
+ # @version LayOut 2023.1
192
+ def image_output_resolution
193
+ end
194
+
195
+ # The {#image_output_resolution=} method sets the output image quality.
196
+ #
197
+ # The resolution can be one of the following values:
198
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
199
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
200
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
201
+ #
202
+ # @example
203
+ # doc = Layout::Document.open("C:/path/to/document.layout")
204
+ # doc.page_info.image_output_resolution = Layout::PageInfo::RESOLUTION_HIGH
205
+ #
206
+ # @param [Integer] resolution
207
+ #
208
+ # @raise [ArgumentError] if resolution is not a valid resolution value
209
+ #
210
+ # @version LayOut 2023.1
211
+ def image_output_resolution=(resolution)
212
+ end
213
+
214
+ # The {#left_margin} method returns the paper's left margin in inches.
215
+ #
216
+ # @example
217
+ # doc = Layout::Document.open("C:/path/to/document.layout")
218
+ # left_margin = doc.page_info.left_margin
219
+ #
220
+ # @return [Numeric]
221
+ #
222
+ # @version LayOut 2018
223
+ def left_margin
224
+ end
225
+
226
+ # The {#left_margin=} method sets the paper's left margin in inches.
227
+ #
228
+ # @example
229
+ # doc = Layout::Document.open("C:/path/to/document.layout")
230
+ # doc.page_info.left_margin = 0.40
231
+ #
232
+ # @param [Numeric] margin
233
+ #
234
+ # @raise [ArgumentError] if margin is less than 0 or greater than the page
235
+ # width
236
+ #
237
+ # @version LayOut 2018
238
+ def left_margin=(margin)
239
+ end
240
+
241
+ # The {#margin_color} method returns the color of the paper's margin.
242
+ #
243
+ # @example
244
+ # doc = Layout::Document.open("C:/path/to/document.layout")
245
+ # margin_color = doc.page_info.margin_color
246
+ #
247
+ # @return [Sketchup::Color]
248
+ #
249
+ # @version LayOut 2018
250
+ def margin_color
251
+ end
252
+
253
+ # The {#margin_color=} sets the color of paper's margin.
254
+ #
255
+ # @example
256
+ # doc = Layout::Document.open("C:/path/to/document.layout")
257
+ # new_color = Sketchup::Color("Red")
258
+ # doc.page_info.margin_color = new_color
259
+ #
260
+ # @param [Sketchup::Color] color
261
+ #
262
+ # @version LayOut 2018
263
+ def margin_color=(color)
264
+ end
265
+
266
+ # The {#output_resolution} method returns the output rendering resolution
267
+ # quality.
268
+ #
269
+ # The resolution can be one of the following values:
270
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
271
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
272
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
273
+ #
274
+ # @example
275
+ # doc = Layout::Document.open("C:/path/to/document.layout")
276
+ # output_resolution = doc.page_info.output_resolution
277
+ #
278
+ # @return [Integer]
279
+ #
280
+ # @version LayOut 2018
281
+ def output_resolution
282
+ end
283
+
284
+ # The {#output_resolution=} method sets the output rendering resolution
285
+ # quality.
286
+ #
287
+ # The resolution can be one of the following values:
288
+ # [+Layout::PageInfo::RESOLUTION_LOW+]
289
+ # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
290
+ # [+Layout::PageInfo::RESOLUTION_HIGH+]
291
+ #
292
+ # @example
293
+ # doc = Layout::Document.open("C:/path/to/document.layout")
294
+ # doc.page_info.output_resolution = Layout::PageInfo::RESOLUTION_MEDIUM
295
+ #
296
+ # @param [Integer] resolution
297
+ #
298
+ # @raise [ArgumentError] if resolution is not a valid resolution value
299
+ #
300
+ # @version LayOut 2018
301
+ def output_resolution=(resolution)
302
+ end
303
+
304
+ # The {#print_margins=} method sets whether to print the paper's margins.
305
+ #
306
+ # @example
307
+ # doc = Layout::Document.open("C:/path/to/document.layout")
308
+ # doc.page_info.print_margins=true
309
+ #
310
+ # @param [Boolean] print
311
+ #
312
+ # @version LayOut 2018
313
+ def print_margins=(print)
314
+ end
315
+
316
+ # The {#print_margins?} method returns whether to print the paper's margins.
317
+ #
318
+ # @example
319
+ # doc = Layout::Document.open("C:/path/to/document.layout")
320
+ # margins_printed = doc.page_info.print_margins?
321
+ #
322
+ # @return [Boolean]
323
+ #
324
+ # @version LayOut 2018
325
+ def print_margins?
326
+ end
327
+
328
+ # The {#print_paper_color=} method sets whether or not the page color should be
329
+ # printed.
330
+ #
331
+ # @example
332
+ # doc = Layout::Document.open("C:/path/to/document.layout")
333
+ # doc.page_info.print_color = true
334
+ #
335
+ # @param [Boolean] print_paper_color
336
+ #
337
+ # @version LayOut 2018
338
+ def print_paper_color=(print_paper_color)
339
+ end
340
+
341
+ # The {#print_paper_color?} method returns whether or not the page color should
342
+ # be printed.
343
+ #
344
+ # @example
345
+ # doc = Layout::Document.open("C:/path/to/document.layout")
346
+ # paper_color = doc.page_info.print_paper_color?
347
+ #
348
+ # @return [Boolean]
349
+ #
350
+ # @version LayOut 2018
351
+ def print_paper_color?
352
+ end
353
+
354
+ # The {#right_margin} method returns the paper's right margin in inches.
355
+ #
356
+ # @example
357
+ # doc = Layout::Document.open("C:/path/to/document.layout")
358
+ # right_margin = doc.page_info.right_margin
359
+ #
360
+ # @return [Numeric]
361
+ #
362
+ # @version LayOut 2018
363
+ def right_margin
364
+ end
365
+
366
+ # The {#right_margin=} sets the paper's right margin in inches.
367
+ #
368
+ # @example
369
+ # doc = Layout::Document.open("C:/path/to/document.layout")
370
+ # doc.page_info.right_margin = 0.40
371
+ #
372
+ # @param [Numeric] margin
373
+ #
374
+ # @raise [ArgumentError] if margin is less than 0 or greater than the page
375
+ # width
376
+ #
377
+ # @version LayOut 2018
378
+ def right_margin=(margin)
379
+ end
380
+
381
+ # The {#show_margins=} method sets whether the paper's margins are visible.
382
+ #
383
+ # @example
384
+ # doc = Layout::Document.open("C:/path/to/document.layout")
385
+ # doc.page_info.show_margins = false
386
+ #
387
+ # @param [Boolean] margins_visible
388
+ #
389
+ # @version LayOut 2018
390
+ def show_margins=(margins_visible)
391
+ end
392
+
393
+ # The {#show_margins?} method returns whether the paper's margins are visible.
394
+ #
395
+ # @example
396
+ # doc = Layout::Document.open("C:/path/to/document.layout")
397
+ # show_margins = doc.page_info.show_margins?
398
+ #
399
+ # @return [Boolean]
400
+ #
401
+ # @version LayOut 2018
402
+ def show_margins?
403
+ end
404
+
405
+ # The {#top_margin} method returns the paper's top margin in inches.
406
+ #
407
+ # @example
408
+ # doc = Layout::Document.open("C:/path/to/document.layout")
409
+ # top_margin = doc.page_info.top_margin
410
+ #
411
+ # @return [Numeric]
412
+ #
413
+ # @version LayOut 2018
414
+ def top_margin
415
+ end
416
+
417
+ # The {#top_margin} method sets the paper's top margin in inches.
418
+ #
419
+ # @example
420
+ # doc = Layout::Document.open("C:/path/to/document.layout")
421
+ # doc.page_info.top_margin = 0.40
422
+ #
423
+ # @param [Numeric] margin
424
+ #
425
+ # @raise [ArgumentError] if margin is less than 0 or greater than the page
426
+ # height
427
+ #
428
+ # @version LayOut 2018
429
+ def top_margin=(margin)
430
+ end
431
+
432
+ # The {#width} method returns the paper width in inches.
433
+ #
434
+ # @example
435
+ # doc = Layout::Document.open("C:/path/to/document.layout")
436
+ # width = doc.page_info.width
437
+ #
438
+ # @return [Numeric]
439
+ #
440
+ # @version LayOut 2018
441
+ def width
442
+ end
443
+
444
+ # The {#width=} method sets the paper width in inches.
445
+ #
446
+ # @example
447
+ # doc = Layout::Document.open("C:/path/to/document.layout")
448
+ # doc.page_info.width = 8.5
449
+ #
450
+ # @param [Numeric] width
451
+ #
452
+ # @raise [ArgumentError] if width is less than 1 or greater than 200
453
+ #
454
+ # @version LayOut 2018
455
+ def width=(width)
456
+ end
457
+
458
+ end