sketchup-api-stubs 0.7.4 → 0.7.5

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 (150) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs.rb +1 -1
  3. data/lib/sketchup-api-stubs/sketchup.rb +147 -145
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -318
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +498 -492
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  16. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  17. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
  18. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +179 -174
  20. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  21. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +515 -514
  22. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  23. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  25. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  26. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  27. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  28. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  29. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -371
  30. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  31. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -220
  33. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  34. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  36. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  37. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  38. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -204
  39. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  40. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  41. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +694 -694
  42. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  43. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  44. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  47. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +577 -562
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +604 -593
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +362 -329
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1126 -1119
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +751 -750
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +699 -697
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +417 -409
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +405 -393
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +327 -285
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +835 -829
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +71 -61
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1307 -1301
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  135. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +317 -310
  136. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +387 -356
  137. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +255 -229
  138. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  139. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  140. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  141. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  142. data/lib/sketchup-api-stubs/stubs/geom.rb +351 -348
  143. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  144. data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
  145. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  146. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1342 -1310
  147. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  148. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  149. data/lib/sketchup-api-stubs/stubs/ui.rb +668 -667
  150. metadata +4 -2
@@ -1,10 +1,10 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This is raised whenever a method attempts to modify any {Layout::Entity}
5
- # that is individually locked.
6
- #
7
- # @version LayOut 2018
8
- class Layout::LockedEntityError < ArgumentError
9
-
10
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This is raised whenever a method attempts to modify any {Layout::Entity}
5
+ # that is individually locked.
6
+ #
7
+ # @version LayOut 2018
8
+ class Layout::LockedEntityError < ArgumentError
9
+
10
+ end
@@ -1,11 +1,11 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This is raised whenever a method attempts to modify any {Layout::Entity}
5
- # that resides on a locked {Layout::Layer}, or when attempting to change the
6
- # shared attribute of a locked {Layout::Layer}.
7
- #
8
- # @version LayOut 2018
9
- class Layout::LockedLayerError < ArgumentError
10
-
11
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This is raised whenever a method attempts to modify any {Layout::Entity}
5
+ # that resides on a locked {Layout::Layer}, or when attempting to change the
6
+ # shared attribute of a locked {Layout::Layer}.
7
+ #
8
+ # @version LayOut 2018
9
+ class Layout::LockedLayerError < ArgumentError
10
+
11
+ end
@@ -1,183 +1,183 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # Class for a single page in a LayOut document.
5
- #
6
- # @version LayOut 2018
7
- class Layout::Page
8
-
9
- # Instance Methods
10
-
11
- # The {#==} method checks to see if the two {Layout::Page}s are equal.
12
- # This checks whether the Ruby Objects are pointing to the same internal
13
- # object.
14
- #
15
- # @example
16
- # doc = Layout::Document.open("C:/path/to/document.layout")
17
- # document = doc.pages.first.document
18
- # doc.pages.first == document.pages.first
19
- #
20
- # @param [Layout::Page] other
21
- #
22
- # @return [Boolean]
23
- #
24
- # @version LayOut 2018
25
- def ==(other)
26
- end
27
-
28
- # The {#document} method returns the {Layout::Document} that the {Layout::Page}
29
- # belongs to.
30
- #
31
- # @example
32
- # doc = Layout::Document.open("C:/path/to/document.layout")
33
- # first_page = doc.pages.first
34
- # # page_doc should reference the same document as doc
35
- # page_doc = first_page.document
36
- #
37
- # @return [Layout::Document]
38
- #
39
- # @version LayOut 2018
40
- def document
41
- end
42
-
43
- # The {#entities} method returns all {Layout::Entity}s that are on the
44
- # {Layout::Page}. This is the equivalent of iterating over all
45
- # {Layout::LayerInstance}s and using {Layout::LayerInstance.entities}.
46
- #
47
- # @example
48
- # doc = Layout::Document.open("C:/path/to/document.layout")
49
- # first_page = doc.pages.first
50
- # entities = first_page.entities
51
- #
52
- # @return [Layout::Entities]
53
- #
54
- # @version LayOut 2018
55
- def entities
56
- end
57
-
58
- # The {#in_presentation=} method sets whether the {Layout::Page} is included in
59
- # presentations.
60
- #
61
- # @example
62
- # doc = Layout::Document.open("C:/path/to/document.layout")
63
- # first_page = doc.pages.first
64
- # first_page.in_presentation = true
65
- #
66
- # @param [Boolean] in_presentation
67
- #
68
- # @version LayOut 2018
69
- def in_presentation=(in_presentation)
70
- end
71
-
72
- # The {#in_presentation?} method returns whether the {Layout::Page} is included
73
- # in presentations.
74
- #
75
- # @example
76
- # doc = Layout::Document.open("C:/path/to/document.layout")
77
- # first_page = doc.pages.first
78
- # in_presentation = first_page.in_presentation?
79
- #
80
- # @return [Boolean]
81
- #
82
- # @version LayOut 2018
83
- def in_presentation?
84
- end
85
-
86
- # The {#layer_instances} method returns an array of the {Layout::LayerInstance}s
87
- # for the {Layout::Page}.
88
- #
89
- # @example
90
- # # An example of page.layer_instances
91
- #
92
- # @return [Array<Layout::LayerInstance>]
93
- #
94
- # @version LayOut 2018
95
- def layer_instances
96
- end
97
-
98
- # The {#layer_visible?} method returns whether a {Layout::Layer} is visible
99
- # on the {Layout::Page}.
100
- #
101
- # @example
102
- # doc = Layout::Document.open("C:/path/to/document.layout")
103
- # first_page = doc.pages.first
104
- # layer = doc.layers.first
105
- # visible = first_page.layer_visible?(layer)
106
- #
107
- # @param [Layout::Layer] layer
108
- #
109
- # @raise [ArgumentError] if layer and page are not in the same document
110
- #
111
- # @return [Boolean]
112
- #
113
- # @version LayOut 2018
114
- def layer_visible?(layer)
115
- end
116
-
117
- # The {#name} method returns the name of the {Layout::Page}.
118
- #
119
- # @example
120
- # doc = Layout::Document.open("C:/path/to/document.layout")
121
- # pages = doc.pages
122
- # first_page_name = pages.first.name
123
- #
124
- # @return [String]
125
- #
126
- # @version LayOut 2018
127
- def name
128
- end
129
-
130
- # The {#name=} method sets the name of a page.
131
- #
132
- # @example
133
- # doc = Layout::Document.open("C:/path/to/document.layout")
134
- # pages = doc.pages
135
- # pages.first.name = "First page"
136
- #
137
- # @param [String] name
138
- #
139
- # @raise [ArgumentError] if name is an empty string
140
- #
141
- # @version LayOut 2018
142
- def name=(name)
143
- end
144
-
145
- # The {#nonshared_entities} method returns the {Layout::Entities}
146
- # unique to the {Layout::Page}.
147
- #
148
- # @example
149
- # doc = Layout::Document.open("C:/path/to/document.layout")
150
- # first_page = doc.pages.first
151
- # entities = first_page.nonshared_entities
152
- #
153
- # @return [Layout::Entities]
154
- #
155
- # @version LayOut 2018
156
- def nonshared_entities
157
- end
158
-
159
- # The {#set_layer_visibility} method sets whether a {Layout::Layer} is visible
160
- # on the {Layout::Page}.
161
- #
162
- # @example
163
- # doc = Layout::Document.open("C:/path/to/document.layout")
164
- # first_page = doc.pages.first
165
- # layer = doc.layers.first
166
- # first_page.set_layer_visibility(layer, false)
167
- #
168
- # @param [Layout::Layer] layer
169
- #
170
- # @param [Boolean] visible
171
- #
172
- # @raise [ArgumentError] if layer and page are not in the same document
173
- #
174
- # @raise [ArgumentError] if layer could not be hidden because there must be at
175
- # least one unlocked, visible layer on each page
176
- #
177
- # @return [Boolean]
178
- #
179
- # @version LayOut 2018
180
- def set_layer_visibility(layer, visible)
181
- end
182
-
183
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # Class for a single page in a LayOut document.
5
+ #
6
+ # @version LayOut 2018
7
+ class Layout::Page
8
+
9
+ # Instance Methods
10
+
11
+ # The {#==} method checks to see if the two {Layout::Page}s are equal.
12
+ # This checks whether the Ruby Objects are pointing to the same internal
13
+ # object.
14
+ #
15
+ # @example
16
+ # doc = Layout::Document.open("C:/path/to/document.layout")
17
+ # document = doc.pages.first.document
18
+ # doc.pages.first == document.pages.first
19
+ #
20
+ # @param [Layout::Page] other
21
+ #
22
+ # @return [Boolean]
23
+ #
24
+ # @version LayOut 2018
25
+ def ==(other)
26
+ end
27
+
28
+ # The {#document} method returns the {Layout::Document} that the {Layout::Page}
29
+ # belongs to.
30
+ #
31
+ # @example
32
+ # doc = Layout::Document.open("C:/path/to/document.layout")
33
+ # first_page = doc.pages.first
34
+ # # page_doc should reference the same document as doc
35
+ # page_doc = first_page.document
36
+ #
37
+ # @return [Layout::Document]
38
+ #
39
+ # @version LayOut 2018
40
+ def document
41
+ end
42
+
43
+ # The {#entities} method returns all {Layout::Entity}s that are on the
44
+ # {Layout::Page}. This is the equivalent of iterating over all
45
+ # {Layout::LayerInstance}s and using {Layout::LayerInstance.entities}.
46
+ #
47
+ # @example
48
+ # doc = Layout::Document.open("C:/path/to/document.layout")
49
+ # first_page = doc.pages.first
50
+ # entities = first_page.entities
51
+ #
52
+ # @return [Layout::Entities]
53
+ #
54
+ # @version LayOut 2018
55
+ def entities
56
+ end
57
+
58
+ # The {#in_presentation=} method sets whether the {Layout::Page} is included in
59
+ # presentations.
60
+ #
61
+ # @example
62
+ # doc = Layout::Document.open("C:/path/to/document.layout")
63
+ # first_page = doc.pages.first
64
+ # first_page.in_presentation = true
65
+ #
66
+ # @param [Boolean] in_presentation
67
+ #
68
+ # @version LayOut 2018
69
+ def in_presentation=(in_presentation)
70
+ end
71
+
72
+ # The {#in_presentation?} method returns whether the {Layout::Page} is included
73
+ # in presentations.
74
+ #
75
+ # @example
76
+ # doc = Layout::Document.open("C:/path/to/document.layout")
77
+ # first_page = doc.pages.first
78
+ # in_presentation = first_page.in_presentation?
79
+ #
80
+ # @return [Boolean]
81
+ #
82
+ # @version LayOut 2018
83
+ def in_presentation?
84
+ end
85
+
86
+ # The {#layer_instances} method returns an array of the {Layout::LayerInstance}s
87
+ # for the {Layout::Page}.
88
+ #
89
+ # @example
90
+ # # An example of page.layer_instances
91
+ #
92
+ # @return [Array<Layout::LayerInstance>]
93
+ #
94
+ # @version LayOut 2018
95
+ def layer_instances
96
+ end
97
+
98
+ # The {#layer_visible?} method returns whether a {Layout::Layer} is visible
99
+ # on the {Layout::Page}.
100
+ #
101
+ # @example
102
+ # doc = Layout::Document.open("C:/path/to/document.layout")
103
+ # first_page = doc.pages.first
104
+ # layer = doc.layers.first
105
+ # visible = first_page.layer_visible?(layer)
106
+ #
107
+ # @param [Layout::Layer] layer
108
+ #
109
+ # @raise [ArgumentError] if layer and page are not in the same document
110
+ #
111
+ # @return [Boolean]
112
+ #
113
+ # @version LayOut 2018
114
+ def layer_visible?(layer)
115
+ end
116
+
117
+ # The {#name} method returns the name of the {Layout::Page}.
118
+ #
119
+ # @example
120
+ # doc = Layout::Document.open("C:/path/to/document.layout")
121
+ # pages = doc.pages
122
+ # first_page_name = pages.first.name
123
+ #
124
+ # @return [String]
125
+ #
126
+ # @version LayOut 2018
127
+ def name
128
+ end
129
+
130
+ # The {#name=} method sets the name of a page.
131
+ #
132
+ # @example
133
+ # doc = Layout::Document.open("C:/path/to/document.layout")
134
+ # pages = doc.pages
135
+ # pages.first.name = "First page"
136
+ #
137
+ # @param [String] name
138
+ #
139
+ # @raise [ArgumentError] if name is an empty string
140
+ #
141
+ # @version LayOut 2018
142
+ def name=(name)
143
+ end
144
+
145
+ # The {#nonshared_entities} method returns the {Layout::Entities}
146
+ # unique to the {Layout::Page}.
147
+ #
148
+ # @example
149
+ # doc = Layout::Document.open("C:/path/to/document.layout")
150
+ # first_page = doc.pages.first
151
+ # entities = first_page.nonshared_entities
152
+ #
153
+ # @return [Layout::Entities]
154
+ #
155
+ # @version LayOut 2018
156
+ def nonshared_entities
157
+ end
158
+
159
+ # The {#set_layer_visibility} method sets whether a {Layout::Layer} is visible
160
+ # on the {Layout::Page}.
161
+ #
162
+ # @example
163
+ # doc = Layout::Document.open("C:/path/to/document.layout")
164
+ # first_page = doc.pages.first
165
+ # layer = doc.layers.first
166
+ # first_page.set_layer_visibility(layer, false)
167
+ #
168
+ # @param [Layout::Layer] layer
169
+ #
170
+ # @param [Boolean] visible
171
+ #
172
+ # @raise [ArgumentError] if layer and page are not in the same document
173
+ #
174
+ # @raise [ArgumentError] if layer could not be hidden because there must be at
175
+ # least one unlocked, visible layer on each page
176
+ #
177
+ # @return [Boolean]
178
+ #
179
+ # @version LayOut 2018
180
+ def set_layer_visibility(layer, visible)
181
+ end
182
+
183
+ end
@@ -1,387 +1,387 @@
1
- # Copyright:: Copyright 2020 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 2020 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