sketchup-api-stubs 0.7.4 → 0.7.8
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.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +148 -145
- data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -318
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +523 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
- data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -348
- data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +698 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -371
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -220
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -204
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
- data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +260 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
- data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
- data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
- data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
- data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +15 -12
|
@@ -1,411 +1,698 @@
|
|
|
1
|
-
# Copyright:: Copyright
|
|
2
|
-
# License:: The MIT License (MIT)
|
|
3
|
-
|
|
4
|
-
# References an auto
|
|
5
|
-
# Mandatory auto
|
|
6
|
-
#
|
|
7
|
-
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
|
8
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
|
9
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
|
10
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
|
11
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
|
12
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
|
13
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
|
14
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
|
15
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
|
16
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
|
17
|
-
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
|
18
|
-
#
|
|
19
|
-
#
|
|
20
|
-
#
|
|
21
|
-
#
|
|
22
|
-
#
|
|
23
|
-
#
|
|
24
|
-
#
|
|
25
|
-
#
|
|
26
|
-
#
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
#
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
#
|
|
64
|
-
#
|
|
65
|
-
#
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
#
|
|
69
|
-
#
|
|
70
|
-
#
|
|
71
|
-
|
|
72
|
-
#
|
|
73
|
-
|
|
74
|
-
#
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
#
|
|
81
|
-
#
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
#
|
|
87
|
-
#
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
#
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
98
|
-
#
|
|
99
|
-
#
|
|
100
|
-
#
|
|
101
|
-
#
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
#
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
#
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
#
|
|
113
|
-
#
|
|
114
|
-
#
|
|
115
|
-
#
|
|
116
|
-
#
|
|
117
|
-
#
|
|
118
|
-
#
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
#
|
|
122
|
-
#
|
|
123
|
-
# @
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
#
|
|
130
|
-
#
|
|
131
|
-
#
|
|
132
|
-
#
|
|
133
|
-
#
|
|
134
|
-
#
|
|
135
|
-
#
|
|
136
|
-
#
|
|
137
|
-
#
|
|
138
|
-
#
|
|
139
|
-
#
|
|
140
|
-
#
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
#
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
#
|
|
150
|
-
#
|
|
151
|
-
#
|
|
152
|
-
#
|
|
153
|
-
#
|
|
154
|
-
#
|
|
155
|
-
#
|
|
156
|
-
#
|
|
157
|
-
# @raise [
|
|
158
|
-
#
|
|
159
|
-
#
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
#
|
|
165
|
-
#
|
|
166
|
-
#
|
|
167
|
-
#
|
|
168
|
-
#
|
|
169
|
-
#
|
|
170
|
-
# definitions =
|
|
171
|
-
#
|
|
172
|
-
#
|
|
173
|
-
#
|
|
174
|
-
#
|
|
175
|
-
#
|
|
176
|
-
#
|
|
177
|
-
#
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
#
|
|
183
|
-
#
|
|
184
|
-
#
|
|
185
|
-
#
|
|
186
|
-
#
|
|
187
|
-
#
|
|
188
|
-
#
|
|
189
|
-
#
|
|
190
|
-
#
|
|
191
|
-
#
|
|
192
|
-
#
|
|
193
|
-
# @
|
|
194
|
-
#
|
|
195
|
-
#
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
#
|
|
201
|
-
#
|
|
202
|
-
#
|
|
203
|
-
#
|
|
204
|
-
#
|
|
205
|
-
#
|
|
206
|
-
# definitions =
|
|
207
|
-
#
|
|
208
|
-
#
|
|
209
|
-
#
|
|
210
|
-
#
|
|
211
|
-
#
|
|
212
|
-
#
|
|
213
|
-
#
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
#
|
|
219
|
-
#
|
|
220
|
-
#
|
|
221
|
-
#
|
|
222
|
-
#
|
|
223
|
-
#
|
|
224
|
-
#
|
|
225
|
-
#
|
|
226
|
-
# [
|
|
227
|
-
#
|
|
228
|
-
#
|
|
229
|
-
# [
|
|
230
|
-
#
|
|
231
|
-
#
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
#
|
|
236
|
-
#
|
|
237
|
-
#
|
|
238
|
-
#
|
|
239
|
-
#
|
|
240
|
-
#
|
|
241
|
-
#
|
|
242
|
-
#
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
#
|
|
247
|
-
#
|
|
248
|
-
# @
|
|
249
|
-
#
|
|
250
|
-
#
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
#
|
|
255
|
-
#
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
#
|
|
260
|
-
#
|
|
261
|
-
#
|
|
262
|
-
#
|
|
263
|
-
#
|
|
264
|
-
#
|
|
265
|
-
#
|
|
266
|
-
#
|
|
267
|
-
#
|
|
268
|
-
#
|
|
269
|
-
#
|
|
270
|
-
# @
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
#
|
|
275
|
-
#
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
#
|
|
280
|
-
#
|
|
281
|
-
#
|
|
282
|
-
#
|
|
283
|
-
#
|
|
284
|
-
# [
|
|
285
|
-
#
|
|
286
|
-
#
|
|
287
|
-
# [
|
|
288
|
-
#
|
|
289
|
-
#
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
#
|
|
294
|
-
#
|
|
295
|
-
#
|
|
296
|
-
#
|
|
297
|
-
#
|
|
298
|
-
#
|
|
299
|
-
#
|
|
300
|
-
#
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
#
|
|
305
|
-
#
|
|
306
|
-
#
|
|
307
|
-
#
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
#
|
|
312
|
-
#
|
|
313
|
-
#
|
|
314
|
-
#
|
|
315
|
-
#
|
|
316
|
-
#
|
|
317
|
-
#
|
|
318
|
-
#
|
|
319
|
-
#
|
|
320
|
-
#
|
|
321
|
-
#
|
|
322
|
-
#
|
|
323
|
-
#
|
|
324
|
-
#
|
|
325
|
-
#
|
|
326
|
-
#
|
|
327
|
-
#
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
#
|
|
332
|
-
#
|
|
333
|
-
#
|
|
334
|
-
#
|
|
335
|
-
#
|
|
336
|
-
#
|
|
337
|
-
#
|
|
338
|
-
#
|
|
339
|
-
#
|
|
340
|
-
#
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
#
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
#
|
|
349
|
-
#
|
|
350
|
-
#
|
|
351
|
-
# @
|
|
352
|
-
#
|
|
353
|
-
#
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
#
|
|
358
|
-
#
|
|
359
|
-
#
|
|
360
|
-
#
|
|
361
|
-
#
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
#
|
|
366
|
-
#
|
|
367
|
-
#
|
|
368
|
-
#
|
|
369
|
-
#
|
|
370
|
-
#
|
|
371
|
-
#
|
|
372
|
-
#
|
|
373
|
-
#
|
|
374
|
-
#
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
#
|
|
380
|
-
#
|
|
381
|
-
#
|
|
382
|
-
#
|
|
383
|
-
#
|
|
384
|
-
#
|
|
385
|
-
# [+Layout::AutoTextDefinition::
|
|
386
|
-
# [+Layout::AutoTextDefinition::
|
|
387
|
-
# [+Layout::AutoTextDefinition::
|
|
388
|
-
# [+Layout::AutoTextDefinition::
|
|
389
|
-
# [+Layout::AutoTextDefinition::
|
|
390
|
-
# [+Layout::AutoTextDefinition::
|
|
391
|
-
#
|
|
392
|
-
#
|
|
393
|
-
#
|
|
394
|
-
#
|
|
395
|
-
#
|
|
396
|
-
#
|
|
397
|
-
# [
|
|
398
|
-
#
|
|
399
|
-
#
|
|
400
|
-
#
|
|
401
|
-
#
|
|
402
|
-
#
|
|
403
|
-
#
|
|
404
|
-
#
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
1
|
+
# Copyright:: Copyright 2022 Trimble Inc.
|
|
2
|
+
# License:: The MIT License (MIT)
|
|
3
|
+
|
|
4
|
+
# References an auto-text definition. Some auto-text definitions are mandatory.
|
|
5
|
+
# Mandatory auto-text definitions may not be removed, added, or modified.
|
|
6
|
+
#
|
|
7
|
+
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
|
8
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
|
9
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
|
10
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
|
11
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
|
12
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
|
13
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
|
14
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
|
15
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
|
16
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
|
17
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
|
18
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
|
19
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
|
20
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
|
21
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
|
22
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
|
23
|
+
#
|
|
24
|
+
# @example
|
|
25
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
26
|
+
# definitions = doc.auto_text_definitions
|
|
27
|
+
# definitions.each { |auto_text|
|
|
28
|
+
# definitions.remove(auto_text) unless auto_text.mandatory?
|
|
29
|
+
# }
|
|
30
|
+
#
|
|
31
|
+
# @version LayOut 2018
|
|
32
|
+
class Layout::AutoTextDefinition
|
|
33
|
+
|
|
34
|
+
# Constants
|
|
35
|
+
|
|
36
|
+
NUMBER_STYLE_ARABIC = nil # Stub value.
|
|
37
|
+
NUMBER_STYLE_ARABIC_PADDED = nil # Stub value.
|
|
38
|
+
NUMBER_STYLE_LC_ALPHA = nil # Stub value.
|
|
39
|
+
NUMBER_STYLE_LC_ROMAN = nil # Stub value.
|
|
40
|
+
NUMBER_STYLE_UC_ALPHA = nil # Stub value.
|
|
41
|
+
NUMBER_STYLE_UC_ROMAN = nil # Stub value.
|
|
42
|
+
|
|
43
|
+
TYPE_CUSTOM_TEXT = nil # Stub value.
|
|
44
|
+
TYPE_DATE_CREATED = nil # Stub value.
|
|
45
|
+
TYPE_DATE_CURRENT = nil # Stub value.
|
|
46
|
+
TYPE_DATE_MODIFIED = nil # Stub value.
|
|
47
|
+
TYPE_DATE_PUBLISHED = nil # Stub value.
|
|
48
|
+
TYPE_FILE = nil # Stub value.
|
|
49
|
+
TYPE_MODEL_CLASSIFIER_ATTRIBUTE = nil # Stub value.
|
|
50
|
+
TYPE_MODEL_COMPONENT_DEFINITION_ATTRIBUTE = nil # Stub value.
|
|
51
|
+
TYPE_MODEL_COMPONENT_DEFINITION_NAME = nil # Stub value.
|
|
52
|
+
TYPE_MODEL_COMPONENT_DESCRIPTION = nil # Stub value.
|
|
53
|
+
TYPE_MODEL_COMPONENT_INSTANCE_ATTRIBUTE = nil # Stub value.
|
|
54
|
+
TYPE_MODEL_COMPONENT_INSTANCE_NAME = nil # Stub value.
|
|
55
|
+
TYPE_MODEL_COORDINATES = nil # Stub value.
|
|
56
|
+
TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE = nil # Stub value.
|
|
57
|
+
TYPE_MODEL_EDGE_LENGTH = nil # Stub value.
|
|
58
|
+
TYPE_MODEL_FACE_AREA = nil # Stub value.
|
|
59
|
+
TYPE_MODEL_GROUP_NAME = nil # Stub value.
|
|
60
|
+
TYPE_MODEL_RATIO = nil # Stub value.
|
|
61
|
+
TYPE_MODEL_SCALE = nil # Stub value.
|
|
62
|
+
TYPE_MODEL_SCENE_DESCRIPTION = nil # Stub value.
|
|
63
|
+
TYPE_MODEL_SCENE_NAME = nil # Stub value.
|
|
64
|
+
TYPE_MODEL_SECTION_NAME = nil # Stub value.
|
|
65
|
+
TYPE_MODEL_SECTION_SYMBOL = nil # Stub value.
|
|
66
|
+
TYPE_MODEL_VOLUME = nil # Stub value.
|
|
67
|
+
TYPE_PAGE_COUNT = nil # Stub value.
|
|
68
|
+
TYPE_PAGE_NAME = nil # Stub value.
|
|
69
|
+
TYPE_PAGE_NUMBER = nil # Stub value.
|
|
70
|
+
TYPE_SEQUENCE = nil # Stub value.
|
|
71
|
+
|
|
72
|
+
# Instance Methods
|
|
73
|
+
|
|
74
|
+
# The {#==} method checks to see if the two {Layout::AutoTextDefinition}s are
|
|
75
|
+
# equal. This checks whether the Ruby Objects are pointing to the same internal
|
|
76
|
+
# object.
|
|
77
|
+
#
|
|
78
|
+
# @example
|
|
79
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
80
|
+
# definitions = doc.auto_text_definitions
|
|
81
|
+
# definitions.first == defs.last
|
|
82
|
+
#
|
|
83
|
+
# @param [Layout::AutoTextDefinition] other
|
|
84
|
+
#
|
|
85
|
+
# @return [Boolean]
|
|
86
|
+
#
|
|
87
|
+
# @version LayOut 2018
|
|
88
|
+
def ==(other)
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# The {#custom_text} method returns the custom text of the
|
|
92
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+ {Layout::AutoTextDefinition}.
|
|
93
|
+
#
|
|
94
|
+
# @example
|
|
95
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
96
|
+
# definitions = doc.auto_text_definitions
|
|
97
|
+
# text = definitions.last.custom_text
|
|
98
|
+
#
|
|
99
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
100
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+
|
|
101
|
+
#
|
|
102
|
+
# @return [String]
|
|
103
|
+
#
|
|
104
|
+
# @version LayOut 2018
|
|
105
|
+
def custom_text
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# The {#custom_text} method sets the custom text of the
|
|
109
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+ {Layout::AutoTextDefinition}.
|
|
110
|
+
#
|
|
111
|
+
# @example
|
|
112
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
113
|
+
# definitions = doc.auto_text_definitions
|
|
114
|
+
# definitions.last.custom_text = "Boop"
|
|
115
|
+
#
|
|
116
|
+
# @param [String] custom_text
|
|
117
|
+
#
|
|
118
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
119
|
+
# +Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+
|
|
120
|
+
#
|
|
121
|
+
# @raise [TypeError] if +custom_text+ is not a String or convertable to a String.
|
|
122
|
+
#
|
|
123
|
+
# @version LayOut 2018
|
|
124
|
+
def custom_text=(custom_text)
|
|
125
|
+
end
|
|
126
|
+
|
|
127
|
+
# The {#date_format} method returns the date format of a
|
|
128
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+ {Layout::AutoTextDefinition}.
|
|
129
|
+
#
|
|
130
|
+
# @example
|
|
131
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
132
|
+
# definitions = doc.auto_text_definitions
|
|
133
|
+
# date_format = definitions.last.date_format
|
|
134
|
+
#
|
|
135
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
136
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+.
|
|
137
|
+
#
|
|
138
|
+
# @return [String]
|
|
139
|
+
#
|
|
140
|
+
# @version LayOut 2018
|
|
141
|
+
def date_format
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# The {#date_format} method sets the date format of a
|
|
145
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+ {Layout::AutoTextDefinition}.
|
|
146
|
+
#
|
|
147
|
+
# @example
|
|
148
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
149
|
+
# definitions = doc.auto_text_definitions
|
|
150
|
+
# definitions.last.date_format = "mmddyyyy"
|
|
151
|
+
#
|
|
152
|
+
# @param [String] date_format
|
|
153
|
+
#
|
|
154
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
155
|
+
# +Layout::AutoTextDefinition::TYPE_DATE_*+.
|
|
156
|
+
#
|
|
157
|
+
# @raise [TypeError] if date_format is not a String or convertable to a String.
|
|
158
|
+
#
|
|
159
|
+
# @version LayOut 2018
|
|
160
|
+
def date_format=(date_format)
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
# The {#display_file_extension=} method sets whether the
|
|
164
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
|
165
|
+
# the file extension.
|
|
166
|
+
#
|
|
167
|
+
# @example
|
|
168
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
169
|
+
# definitions = doc.auto_text_definitions
|
|
170
|
+
# definitions.last.display_file_extension = false
|
|
171
|
+
#
|
|
172
|
+
# @param [Boolean] display_file_extension
|
|
173
|
+
#
|
|
174
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
175
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
|
176
|
+
#
|
|
177
|
+
# @version LayOut 2018
|
|
178
|
+
def display_file_extension=(display_file_extension)
|
|
179
|
+
end
|
|
180
|
+
|
|
181
|
+
# The {#display_file_extension?} method returns whether the
|
|
182
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
|
183
|
+
# the file extension.
|
|
184
|
+
#
|
|
185
|
+
# @example
|
|
186
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
187
|
+
# definitions = doc.auto_text_definitions
|
|
188
|
+
# show_file_extension = definitions.last.display_file_extension?
|
|
189
|
+
#
|
|
190
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
191
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
|
192
|
+
#
|
|
193
|
+
# @return [Boolean]
|
|
194
|
+
#
|
|
195
|
+
# @version LayOut 2018
|
|
196
|
+
def display_file_extension?
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
# The {#display_full_path=} method sets whether the
|
|
200
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
|
201
|
+
# the full path.
|
|
202
|
+
#
|
|
203
|
+
# @example
|
|
204
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
205
|
+
# definitions = doc.auto_text_definitions
|
|
206
|
+
# definitions.last.display_full_path = true
|
|
207
|
+
#
|
|
208
|
+
# @param [Boolean] display_full_path
|
|
209
|
+
#
|
|
210
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
211
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
|
212
|
+
#
|
|
213
|
+
# @version LayOut 2018
|
|
214
|
+
def display_full_path=(display_full_path)
|
|
215
|
+
end
|
|
216
|
+
|
|
217
|
+
# The {#display_full_path?} method returns whether the
|
|
218
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+ {Layout::AutoTextDefinition} displays
|
|
219
|
+
# the full path.
|
|
220
|
+
#
|
|
221
|
+
# @example
|
|
222
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
223
|
+
# definitions = doc.auto_text_definitions
|
|
224
|
+
# is_full_path = definitions.last.display_full_path?
|
|
225
|
+
#
|
|
226
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
227
|
+
# +Layout::AutoTextDefinition::TYPE_FILE+.
|
|
228
|
+
#
|
|
229
|
+
# @return [Boolean]
|
|
230
|
+
#
|
|
231
|
+
# @version LayOut 2018
|
|
232
|
+
def display_full_path?
|
|
233
|
+
end
|
|
234
|
+
|
|
235
|
+
# The {#end_page} method returns the end page for the
|
|
236
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
|
|
237
|
+
#
|
|
238
|
+
# @example
|
|
239
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
240
|
+
# page_count_def =
|
|
241
|
+
# doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
|
|
242
|
+
# # Default end_page value is nil, meaning count to the end of the document
|
|
243
|
+
# page = page_count_def.end_page
|
|
244
|
+
#
|
|
245
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
246
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
|
247
|
+
#
|
|
248
|
+
# @return [Layout::Page, nil]
|
|
249
|
+
#
|
|
250
|
+
# @version LayOut 2022.0
|
|
251
|
+
def end_page
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
# The {#end_page=} method sets the end page for the
|
|
255
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}.
|
|
256
|
+
#
|
|
257
|
+
# @example
|
|
258
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
259
|
+
# definitions = doc.auto_text_definitions
|
|
260
|
+
# page_count_def =
|
|
261
|
+
# doc.auto_text_definitions.add("PageCount", Layout::AutoTextDefinition::TYPE_PAGE_COUNT)
|
|
262
|
+
# # Stop the PageCount auto-text at this newly created page instead of at the end of the document
|
|
263
|
+
# page_count_def.end_page = doc.pages.add("new page")
|
|
264
|
+
#
|
|
265
|
+
# @param [Layout::Page, nil] page
|
|
266
|
+
#
|
|
267
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
268
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
|
269
|
+
#
|
|
270
|
+
# @version LayOut 2022.0
|
|
271
|
+
def end_page=(page)
|
|
272
|
+
end
|
|
273
|
+
|
|
274
|
+
# The {#increment} method returns the increment value for
|
|
275
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
276
|
+
#
|
|
277
|
+
# @example
|
|
278
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
279
|
+
# sequence_def =
|
|
280
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
281
|
+
# # Default sequence increment value is 1
|
|
282
|
+
# increment = sequence_def.increment
|
|
283
|
+
#
|
|
284
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
285
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
286
|
+
#
|
|
287
|
+
# @return [Integer]
|
|
288
|
+
#
|
|
289
|
+
# @version LayOut 2022.0
|
|
290
|
+
def increment
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
# The {#increment=} method sets the increment value for
|
|
294
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
295
|
+
#
|
|
296
|
+
# @example
|
|
297
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
298
|
+
# sequence_def =
|
|
299
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
300
|
+
# sequence_def.increment = 10
|
|
301
|
+
#
|
|
302
|
+
# @param [Integer] increment
|
|
303
|
+
#
|
|
304
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
305
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
306
|
+
#
|
|
307
|
+
# @version LayOut 2022.0
|
|
308
|
+
def increment=(increment)
|
|
309
|
+
end
|
|
310
|
+
|
|
311
|
+
# The {#mandatory?} method returns whether the {Layout::AutoTextDefinition} is
|
|
312
|
+
# mandatory or not.
|
|
313
|
+
#
|
|
314
|
+
# A mandatory {Layout::AutoTextDefinition} is one of the following types:
|
|
315
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
|
316
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
|
317
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
|
318
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
|
319
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
|
320
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
|
321
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
|
322
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
|
323
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
|
324
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
|
325
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
|
326
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
|
327
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
|
328
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
|
329
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
|
330
|
+
#
|
|
331
|
+
# @example
|
|
332
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
333
|
+
# definitions = doc.auto_text_definitions
|
|
334
|
+
# definitions.each { |auto_text|
|
|
335
|
+
# definitions.remove(auto_text) unless auto_text.mandatory?
|
|
336
|
+
# }
|
|
337
|
+
#
|
|
338
|
+
# @return [Boolean]
|
|
339
|
+
#
|
|
340
|
+
# @version LayOut 2018
|
|
341
|
+
def mandatory?
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
# The {#name} method returns the name of the {Layout::AutoTextDefinition}.
|
|
345
|
+
#
|
|
346
|
+
# @example
|
|
347
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
348
|
+
# definitions = doc.auto_text_definitions
|
|
349
|
+
# name = definitions.first.name
|
|
350
|
+
#
|
|
351
|
+
# @return [String]
|
|
352
|
+
#
|
|
353
|
+
# @version LayOut 2018
|
|
354
|
+
def name
|
|
355
|
+
end
|
|
356
|
+
|
|
357
|
+
# The {#name=} method sets the name of the {Layout::AutoTextDefinition}.
|
|
358
|
+
#
|
|
359
|
+
# @example
|
|
360
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
361
|
+
# definitions = doc.auto_text_definitions
|
|
362
|
+
# definitions.last.name = "New Name"
|
|
363
|
+
#
|
|
364
|
+
# @param [String] name
|
|
365
|
+
#
|
|
366
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition} is a mandatory type
|
|
367
|
+
#
|
|
368
|
+
# @raise [ArgumentError] if name matches an existing
|
|
369
|
+
# {Layout::AutoTextDefinition}
|
|
370
|
+
#
|
|
371
|
+
# @raise [ArgumentError] if name is an empty string
|
|
372
|
+
#
|
|
373
|
+
# @raise [TypeError] if name is not a String or convertable to a String.
|
|
374
|
+
#
|
|
375
|
+
# @version LayOut 2018
|
|
376
|
+
def name=(name)
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
# The {#number_style} method returns the numbering style for
|
|
380
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
381
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
|
382
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
383
|
+
#
|
|
384
|
+
# The numbering style can be one of the following values:
|
|
385
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
|
386
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
|
387
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
|
388
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
|
389
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
|
390
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
|
391
|
+
#
|
|
392
|
+
# @example
|
|
393
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
394
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
395
|
+
# number_style = sequence_def.number_style
|
|
396
|
+
#
|
|
397
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
398
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
399
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
|
400
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
401
|
+
#
|
|
402
|
+
# @return [Integer]
|
|
403
|
+
#
|
|
404
|
+
# @version LayOut 2022.0
|
|
405
|
+
def number_style
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
# The {#number_style=} method sets the numbering style for
|
|
409
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
410
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
|
411
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
412
|
+
#
|
|
413
|
+
# The numbering style can be one of the following values:
|
|
414
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
|
415
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
|
416
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
|
417
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
|
418
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
|
419
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
|
420
|
+
#
|
|
421
|
+
# @example
|
|
422
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
423
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
424
|
+
# sequence_def.number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
|
|
425
|
+
#
|
|
426
|
+
# @param [Integer] number_style
|
|
427
|
+
#
|
|
428
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
429
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
430
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
|
431
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
432
|
+
#
|
|
433
|
+
# @raise [ArgumentError] if number_style is not a valid page numbering style
|
|
434
|
+
#
|
|
435
|
+
# @version LayOut 2022.0
|
|
436
|
+
def number_style=(number_style)
|
|
437
|
+
end
|
|
438
|
+
|
|
439
|
+
# The {#page_number_style} method returns the numbering style for
|
|
440
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
|
|
441
|
+
#
|
|
442
|
+
# The numbering style can be one of the following values:
|
|
443
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
|
444
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
|
445
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
|
446
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
|
447
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
|
448
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
|
449
|
+
#
|
|
450
|
+
# @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style}
|
|
451
|
+
# method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
|
|
452
|
+
# +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
453
|
+
#
|
|
454
|
+
# @example
|
|
455
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
456
|
+
# page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
|
|
457
|
+
# Layout::AutoTextDefinition::TYPE_PAGE_NUMBER) number_style = page_number_def.number_style
|
|
458
|
+
#
|
|
459
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
460
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
|
|
461
|
+
#
|
|
462
|
+
# @return [Integer]
|
|
463
|
+
#
|
|
464
|
+
# @version LayOut 2018
|
|
465
|
+
def page_number_style
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
# The {#page_number_style=} method sets the numbering style for
|
|
469
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ {Layout::AutoTextDefinition}s.
|
|
470
|
+
#
|
|
471
|
+
# The numbering style can be one of the following values:
|
|
472
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC+]
|
|
473
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_ARABIC_PADDED+]
|
|
474
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ALPHA+]
|
|
475
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ALPHA+]
|
|
476
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN+]
|
|
477
|
+
# [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
|
|
478
|
+
#
|
|
479
|
+
# @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style=}
|
|
480
|
+
# method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
|
|
481
|
+
# +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
482
|
+
#
|
|
483
|
+
# @example
|
|
484
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
485
|
+
# page_number_def = doc.auto_text_definitions.add("RomanPageNumbers",
|
|
486
|
+
# Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
|
487
|
+
# page_number_def.page_number_style = Layout::AutoTextDefinition::NUMBER_STYLE_UC_ROMAN
|
|
488
|
+
#
|
|
489
|
+
# @param [Integer] number_style
|
|
490
|
+
#
|
|
491
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
492
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
|
|
493
|
+
#
|
|
494
|
+
# @raise [ArgumentError] if +number_style+ is not a valid page numbering style
|
|
495
|
+
#
|
|
496
|
+
# @version LayOut 2018
|
|
497
|
+
def page_number_style=(number_style)
|
|
498
|
+
end
|
|
499
|
+
|
|
500
|
+
# The {#renumber} method iterates through all uses of the
|
|
501
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition} and eliminates gaps and
|
|
502
|
+
# duplicates in the sequence.
|
|
503
|
+
#
|
|
504
|
+
# @example
|
|
505
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
506
|
+
# sequence_def =
|
|
507
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
508
|
+
# sequence_def.renumber
|
|
509
|
+
#
|
|
510
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
511
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
512
|
+
#
|
|
513
|
+
# @version LayOut 2022.0
|
|
514
|
+
def renumber
|
|
515
|
+
end
|
|
516
|
+
|
|
517
|
+
# The {#sequence_format} method returns the sequence format of a
|
|
518
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
|
|
519
|
+
#
|
|
520
|
+
# @example
|
|
521
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
522
|
+
# sequence_def =
|
|
523
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
524
|
+
# # Default sequence format is ###, meaning entirely replace the string with the sequence number
|
|
525
|
+
# sequence = sequence_def.sequence
|
|
526
|
+
#
|
|
527
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
528
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
529
|
+
#
|
|
530
|
+
# @return [String]
|
|
531
|
+
#
|
|
532
|
+
# @version LayOut 2022.0
|
|
533
|
+
def sequence_format
|
|
534
|
+
end
|
|
535
|
+
|
|
536
|
+
# The {#sequence_format=} method sets the sequence format of a
|
|
537
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}.
|
|
538
|
+
#
|
|
539
|
+
# @example
|
|
540
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
541
|
+
# sequence_def =
|
|
542
|
+
# doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
543
|
+
# sequence_def.sequence = "Figure ###"
|
|
544
|
+
#
|
|
545
|
+
# @param [String] sequence_format
|
|
546
|
+
#
|
|
547
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
548
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
549
|
+
#
|
|
550
|
+
# @raise [TypeError] if +sequence_format+ is not a String or convertable to a String.
|
|
551
|
+
#
|
|
552
|
+
# @version LayOut 2022.0
|
|
553
|
+
def sequence_format=(sequence_format)
|
|
554
|
+
end
|
|
555
|
+
|
|
556
|
+
# The {#start_index} method returns the start index for
|
|
557
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
558
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
|
559
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
560
|
+
#
|
|
561
|
+
# @example
|
|
562
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
563
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
564
|
+
# start_index = sequence_def.start_index
|
|
565
|
+
#
|
|
566
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
567
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
568
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
|
569
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
570
|
+
#
|
|
571
|
+
# @return [Integer]
|
|
572
|
+
#
|
|
573
|
+
# @version LayOut 2018
|
|
574
|
+
def start_index
|
|
575
|
+
end
|
|
576
|
+
|
|
577
|
+
# The {#start_index=} method sets the start index for
|
|
578
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
579
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, and
|
|
580
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
|
|
581
|
+
#
|
|
582
|
+
# @example
|
|
583
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
584
|
+
# sequence_def = doc.auto_text_definitions.add("Seq1", Layout::AutoTextDefinition::TYPE_SEQUENCE)
|
|
585
|
+
# sequence_def.start_index = 10
|
|
586
|
+
#
|
|
587
|
+
# @param [Integer] index
|
|
588
|
+
#
|
|
589
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
590
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
|
|
591
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
|
|
592
|
+
# +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
|
|
593
|
+
#
|
|
594
|
+
# @version LayOut 2018
|
|
595
|
+
def start_index=(index)
|
|
596
|
+
end
|
|
597
|
+
|
|
598
|
+
# The {#start_page} method returns the start page for
|
|
599
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
|
|
600
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
|
|
601
|
+
#
|
|
602
|
+
# @example
|
|
603
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
604
|
+
# page_number_def =
|
|
605
|
+
# doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
|
606
|
+
# # Default start page is the first page of the document. However we continue to start at that
|
|
607
|
+
# # page even if that page is moved.
|
|
608
|
+
# page = page_number_def.start_page
|
|
609
|
+
# p page == doc.pages[0]
|
|
610
|
+
# doc.pages.add('new page')
|
|
611
|
+
# doc.pages.reorder(doc.pages[0], 1)
|
|
612
|
+
# p page == doc.pages[1]
|
|
613
|
+
#
|
|
614
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
615
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
|
|
616
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
|
617
|
+
#
|
|
618
|
+
# @return [Layout::Page]
|
|
619
|
+
#
|
|
620
|
+
# @version LayOut 2022.0
|
|
621
|
+
def start_page
|
|
622
|
+
end
|
|
623
|
+
|
|
624
|
+
# The {#start_page=} method sets the start page for
|
|
625
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ and
|
|
626
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ {Layout::AutoTextDefinition}s.
|
|
627
|
+
#
|
|
628
|
+
# @example
|
|
629
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
630
|
+
# page_number_def =
|
|
631
|
+
# doc.auto_text_definitions.add("PageNumber", Layout::AutoTextDefinition::TYPE_PAGE_NUMBER)
|
|
632
|
+
# # Start the PageCount auto-text on the new page
|
|
633
|
+
# page_number_def.start_page = doc.pages.add('new page')
|
|
634
|
+
#
|
|
635
|
+
# @param [Layout::Page] page
|
|
636
|
+
#
|
|
637
|
+
# @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
|
|
638
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+ or
|
|
639
|
+
# +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+.
|
|
640
|
+
#
|
|
641
|
+
# @version LayOut 2022.0
|
|
642
|
+
def start_page=(page)
|
|
643
|
+
end
|
|
644
|
+
|
|
645
|
+
# The {#tag} method returns the tag string of the {Layout::AutoTextDefinition}.
|
|
646
|
+
#
|
|
647
|
+
# @example
|
|
648
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
649
|
+
# definitions = doc.auto_text_definitions
|
|
650
|
+
# tag = definitions.first.tag
|
|
651
|
+
#
|
|
652
|
+
# @return [String]
|
|
653
|
+
#
|
|
654
|
+
# @version LayOut 2018
|
|
655
|
+
def tag
|
|
656
|
+
end
|
|
657
|
+
|
|
658
|
+
# The {#type} method returns the type of the {Layout::AutoTextDefinition}.
|
|
659
|
+
#
|
|
660
|
+
# The type can be one of the following values:
|
|
661
|
+
# [+Layout::AutoTextDefinition::TYPE_FILE+]
|
|
662
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
|
|
663
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
|
|
664
|
+
# [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
|
|
665
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
|
|
666
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
|
|
667
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
|
|
668
|
+
# [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
|
|
669
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_GROUP_NAME+]
|
|
670
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_INSTANCE_NAME+]
|
|
671
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DEFINITION_NAME+]
|
|
672
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COMPONENT_DESCRIPTION+]
|
|
673
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_VOLUME+]
|
|
674
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_FACE_AREA+]
|
|
675
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_EDGE_LENGTH+]
|
|
676
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_COORDINATES+]
|
|
677
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_DYNAMIC_COMPONENT_ATTRIBUTE+]
|
|
678
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_CLASSIFIER_ATTRIBUTE+]
|
|
679
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_NAME+]
|
|
680
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCENE_DESCRIPTION+]
|
|
681
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SCALE+]
|
|
682
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_NAME+]
|
|
683
|
+
# [+Layout::AutoTextDefinition::TYPE_MODEL_SECTION_SYMBOL+]
|
|
684
|
+
# [+Layout::AutoTextDefinition::TYPE_PAGE_COUNT+]
|
|
685
|
+
# [+Layout::AutoTextDefinition::TYPE_SEQUENCE+]
|
|
686
|
+
#
|
|
687
|
+
# @example
|
|
688
|
+
# doc = Layout::Document.open("C:/path/to/document.layout")
|
|
689
|
+
# definitions = doc.auto_text_definitions
|
|
690
|
+
# type = definitions.first.type
|
|
691
|
+
#
|
|
692
|
+
# @return [Integer]
|
|
693
|
+
#
|
|
694
|
+
# @version LayOut 2018
|
|
695
|
+
def type
|
|
696
|
+
end
|
|
697
|
+
|
|
698
|
+
end
|