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,141 +1,142 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to materials events.
|
5
|
-
#
|
6
|
-
#
|
7
|
-
#
|
8
|
-
#
|
9
|
-
#
|
10
|
-
#
|
11
|
-
#
|
12
|
-
#
|
13
|
-
#
|
14
|
-
#
|
15
|
-
#
|
16
|
-
#
|
17
|
-
#
|
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
|
-
# is
|
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
|
-
# is
|
100
|
-
#
|
101
|
-
#
|
102
|
-
# materials
|
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
|
-
|
1
|
+
# Copyright:: Copyright 2022 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to materials events.
|
5
|
+
#
|
6
|
+
# @abstract To implement this observer, create a Ruby class of this type, override the
|
7
|
+
# desired methods, and add an instance of the observer to the objects of
|
8
|
+
# interests.
|
9
|
+
#
|
10
|
+
# @example
|
11
|
+
# class MyMaterialsObserver < Sketchup::MaterialsObserver
|
12
|
+
# def onMaterialAdd(materials, material)
|
13
|
+
# puts "onMaterialAdd: #{material}"
|
14
|
+
# end
|
15
|
+
# end
|
16
|
+
#
|
17
|
+
# Sketchup.active_model.materials.add_observer(MyMaterialsObserver.new)
|
18
|
+
#
|
19
|
+
# @note The callback +onMaterialRemoveAll+ has been deprecated, we recommend using
|
20
|
+
# {#onMaterialRemove} instead.
|
21
|
+
#
|
22
|
+
# @version SketchUp 6.0
|
23
|
+
class Sketchup::MaterialsObserver
|
24
|
+
|
25
|
+
# Instance Methods
|
26
|
+
|
27
|
+
# The {#onMaterialAdd} method is invoked whenever a new material is added.
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
# def onMaterialAdd(materials, material)
|
31
|
+
# puts "onMaterialAdd: #{material}"
|
32
|
+
# end
|
33
|
+
#
|
34
|
+
# @param [Sketchup::Materials] materials
|
35
|
+
#
|
36
|
+
# @param [Sketchup::Material] material
|
37
|
+
#
|
38
|
+
# @return [nil]
|
39
|
+
#
|
40
|
+
# @version SketchUp 6.0
|
41
|
+
def onMaterialAdd(materials, material)
|
42
|
+
end
|
43
|
+
|
44
|
+
# The {#onMaterialChange} method is invoked whenever a material's texture image
|
45
|
+
# is altered.
|
46
|
+
#
|
47
|
+
# @example
|
48
|
+
# def onMaterialChange(materials, material)
|
49
|
+
# puts "onMaterialChange: #{material}"
|
50
|
+
# end
|
51
|
+
#
|
52
|
+
# @param [Sketchup::Materials] materials
|
53
|
+
#
|
54
|
+
# @param [Sketchup::Material] material
|
55
|
+
#
|
56
|
+
# @return [nil]
|
57
|
+
#
|
58
|
+
# @version SketchUp 6.0
|
59
|
+
def onMaterialChange(materials, material)
|
60
|
+
end
|
61
|
+
|
62
|
+
# The {#onMaterialRefChange} method is invoked whenever the number of entities
|
63
|
+
# that a material is painted on changes. This could be due to the user
|
64
|
+
# manually painting something, but it could also be when faces are split,
|
65
|
+
# pasted, push-pulled, deleted, etc.
|
66
|
+
#
|
67
|
+
# @example
|
68
|
+
# def onMaterialRefChange(materials, material)
|
69
|
+
# puts "onMaterialRefChange: #{material}"
|
70
|
+
# end
|
71
|
+
#
|
72
|
+
# @param [Sketchup::Materials] materials
|
73
|
+
#
|
74
|
+
# @param [Sketchup::Material] material
|
75
|
+
#
|
76
|
+
# @return [nil]
|
77
|
+
#
|
78
|
+
# @version SketchUp 6.0
|
79
|
+
def onMaterialRefChange(materials, material)
|
80
|
+
end
|
81
|
+
|
82
|
+
# The {#onMaterialRemove} method is invoked whenever a material is deleted.
|
83
|
+
#
|
84
|
+
# @example
|
85
|
+
# def onMaterialRemove(materials, material)
|
86
|
+
# puts "onMaterialRemove: #{material}"
|
87
|
+
# end
|
88
|
+
#
|
89
|
+
# @param [Sketchup::Materials] materials
|
90
|
+
#
|
91
|
+
# @param [Sketchup::Material] material
|
92
|
+
#
|
93
|
+
# @return [nil]
|
94
|
+
#
|
95
|
+
# @version SketchUp 6.0
|
96
|
+
def onMaterialRemove(materials, material)
|
97
|
+
end
|
98
|
+
|
99
|
+
# The {#onMaterialSetCurrent} method is invoked whenever a different material
|
100
|
+
# is selected in the Materials dialog.
|
101
|
+
#
|
102
|
+
# The materials parameter might be Nil when the material is picked from the
|
103
|
+
# materials libraries and not yet added to the model.
|
104
|
+
#
|
105
|
+
# @example
|
106
|
+
# def onMaterialSetCurrent(materials, material)
|
107
|
+
# puts "onMaterialSetCurrent: #{material}"
|
108
|
+
# end
|
109
|
+
#
|
110
|
+
# @param [Sketchup::Materials] materials
|
111
|
+
#
|
112
|
+
# @param [Sketchup::Material] material
|
113
|
+
#
|
114
|
+
# @return [nil]
|
115
|
+
#
|
116
|
+
# @version SketchUp 6.0
|
117
|
+
def onMaterialSetCurrent(materials, material)
|
118
|
+
end
|
119
|
+
|
120
|
+
# The {#onMaterialUndoRedo} method is invoked whenever a material is altered
|
121
|
+
# and then those changes are undone or redone.
|
122
|
+
#
|
123
|
+
# @example
|
124
|
+
# def onMaterialUndoRedo(materials, material)
|
125
|
+
# puts "onMaterialUndoRedo: #{material}"
|
126
|
+
# end
|
127
|
+
#
|
128
|
+
# @note Due to a bug, this callback does not fire in SU6 or SU7. You can use
|
129
|
+
# the {Sketchup::ModelObserver#onTransactionStart} to capture all undo
|
130
|
+
# events.
|
131
|
+
#
|
132
|
+
# @param [Sketchup::Materials] materials
|
133
|
+
#
|
134
|
+
# @param [Sketchup::Material] material
|
135
|
+
#
|
136
|
+
# @return [nil]
|
137
|
+
#
|
138
|
+
# @version SketchUp 6.0
|
139
|
+
def onMaterialUndoRedo(materials, material)
|
140
|
+
end
|
141
|
+
|
142
|
+
end
|
@@ -1,95 +1,93 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# An interface to a menu.
|
5
|
-
#
|
6
|
-
# @version SketchUp 6.0
|
7
|
-
class Sketchup::Menu
|
8
|
-
|
9
|
-
# Instance Methods
|
10
|
-
|
11
|
-
# The {#add_item} method is used to add a menu item to the specified menu.
|
12
|
-
#
|
13
|
-
# This method takes a block that defines the action to perform when the menu
|
14
|
-
# item is selected.
|
15
|
-
#
|
16
|
-
# The item id that is returned can be used when adding an optional
|
17
|
-
# validation procedure for the menu item.
|
18
|
-
#
|
19
|
-
# @example
|
20
|
-
# menu = UI.menu('Plugins')
|
21
|
-
# menu.add_item("Test") { puts 'Hello World' }
|
22
|
-
#
|
23
|
-
# @overload add_item(
|
24
|
-
#
|
25
|
-
# @param [String]
|
26
|
-
# @yield A block that will be invoked when the menu item is selected.
|
27
|
-
# @return [Integer] A unique integer id for the added menu item.
|
28
|
-
#
|
29
|
-
# @overload add_item(command)
|
30
|
-
#
|
31
|
-
# @param [UI::Command] command
|
32
|
-
# @return [Integer] A unique integer id for the added menu item.
|
33
|
-
#
|
34
|
-
# @version SketchUp 6.0
|
35
|
-
def add_item(*args)
|
36
|
-
end
|
37
|
-
|
38
|
-
# The add_separator method is used to add a menu separator to a menu.
|
39
|
-
#
|
40
|
-
# @example
|
41
|
-
# plugins_menu = UI.menu("Plugins")
|
42
|
-
# plugins_menu.add_separator
|
43
|
-
#
|
44
|
-
# @return [nil]
|
45
|
-
#
|
46
|
-
# @version SketchUp 6.0
|
47
|
-
def add_separator
|
48
|
-
end
|
49
|
-
|
50
|
-
# The add_submenu method is used to add a sub-menu to a menu.
|
51
|
-
#
|
52
|
-
# @example
|
53
|
-
# plugins_menu = UI.menu("Plugins")
|
54
|
-
# submenu = plugins_menu.add_submenu("Test")
|
55
|
-
# submenu.add_item("Hello World") {
|
56
|
-
# UI.messagebox("Hi there!")
|
57
|
-
# }
|
58
|
-
#
|
59
|
-
# @param [String] title
|
60
|
-
# The title of the sub menu.
|
61
|
-
#
|
62
|
-
# @return [Sketchup::Menu] a Menu object
|
63
|
-
#
|
64
|
-
# @version SketchUp 6.0
|
65
|
-
def add_submenu(title)
|
66
|
-
end
|
67
|
-
|
68
|
-
# The set_validation_proc method is used to
|
69
|
-
# procedure. Your procedure should return either MF_ENABLED, MF_DISABLED,
|
70
|
-
# MF_CHECKED, MF_UNCHECKED, or MF_GRAYED.
|
71
|
-
#
|
72
|
-
# @example
|
73
|
-
# plugins_menu = UI.menu("Plugins")
|
74
|
-
# item = plugins_menu.add_item("Test") { UI.messagebox "My Test Item"}
|
75
|
-
# status = plugins_menu.set_validation_proc(item) {
|
76
|
-
# if Sketchup.is_pro?
|
77
|
-
# MF_ENABLED
|
78
|
-
# else
|
79
|
-
# MF_GRAYED
|
80
|
-
# end
|
81
|
-
# }
|
82
|
-
#
|
83
|
-
# @param [
|
84
|
-
#
|
85
|
-
#
|
86
|
-
# @
|
87
|
-
#
|
88
|
-
# @
|
89
|
-
#
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
end
|
1
|
+
# Copyright:: Copyright 2022 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# An interface to a menu.
|
5
|
+
#
|
6
|
+
# @version SketchUp 6.0
|
7
|
+
class Sketchup::Menu
|
8
|
+
|
9
|
+
# Instance Methods
|
10
|
+
|
11
|
+
# The {#add_item} method is used to add a menu item to the specified menu.
|
12
|
+
#
|
13
|
+
# This method takes a block that defines the action to perform when the menu
|
14
|
+
# item is selected.
|
15
|
+
#
|
16
|
+
# The item id that is returned can be used when adding an optional
|
17
|
+
# validation procedure for the menu item.
|
18
|
+
#
|
19
|
+
# @example
|
20
|
+
# menu = UI.menu('Plugins')
|
21
|
+
# menu.add_item("Test") { puts 'Hello World' }
|
22
|
+
#
|
23
|
+
# @overload add_item(title, &block)
|
24
|
+
#
|
25
|
+
# @param [String] title
|
26
|
+
# @yield A block that will be invoked when the menu item is selected.
|
27
|
+
# @return [Integer] A unique integer id for the added menu item.
|
28
|
+
#
|
29
|
+
# @overload add_item(command)
|
30
|
+
#
|
31
|
+
# @param [UI::Command] command
|
32
|
+
# @return [Integer] A unique integer id for the added menu item.
|
33
|
+
#
|
34
|
+
# @version SketchUp 6.0
|
35
|
+
def add_item(*args)
|
36
|
+
end
|
37
|
+
|
38
|
+
# The {#add_separator} method is used to add a menu separator to a menu.
|
39
|
+
#
|
40
|
+
# @example
|
41
|
+
# plugins_menu = UI.menu("Plugins")
|
42
|
+
# plugins_menu.add_separator
|
43
|
+
#
|
44
|
+
# @return [nil]
|
45
|
+
#
|
46
|
+
# @version SketchUp 6.0
|
47
|
+
def add_separator
|
48
|
+
end
|
49
|
+
|
50
|
+
# The {#add_submenu} method is used to add a sub-menu to a menu.
|
51
|
+
#
|
52
|
+
# @example
|
53
|
+
# plugins_menu = UI.menu("Plugins")
|
54
|
+
# submenu = plugins_menu.add_submenu("Test")
|
55
|
+
# submenu.add_item("Hello World") {
|
56
|
+
# UI.messagebox("Hi there!")
|
57
|
+
# }
|
58
|
+
#
|
59
|
+
# @param [String] title
|
60
|
+
# The title of the sub menu.
|
61
|
+
#
|
62
|
+
# @return [Sketchup::Menu] a Menu object
|
63
|
+
#
|
64
|
+
# @version SketchUp 6.0
|
65
|
+
def add_submenu(title)
|
66
|
+
end
|
67
|
+
|
68
|
+
# The {#set_validation_proc} method is used to specify the menu validation
|
69
|
+
# procedure. Your procedure should return either MF_ENABLED, MF_DISABLED,
|
70
|
+
# MF_CHECKED, MF_UNCHECKED, or MF_GRAYED.
|
71
|
+
#
|
72
|
+
# @example
|
73
|
+
# plugins_menu = UI.menu("Plugins")
|
74
|
+
# item = plugins_menu.add_item("Test") { UI.messagebox "My Test Item"}
|
75
|
+
# status = plugins_menu.set_validation_proc(item) {
|
76
|
+
# if Sketchup.is_pro?
|
77
|
+
# MF_ENABLED
|
78
|
+
# else
|
79
|
+
# MF_GRAYED
|
80
|
+
# end
|
81
|
+
# }
|
82
|
+
#
|
83
|
+
# @param [Integer] item
|
84
|
+
# The numerical identifier for the menu item.
|
85
|
+
#
|
86
|
+
# @version SketchUp 6.0
|
87
|
+
#
|
88
|
+
# @yield A method that will be invoked when the menu item is
|
89
|
+
# selected.
|
90
|
+
def set_validation_proc(item, &block)
|
91
|
+
end
|
92
|
+
|
93
|
+
end
|