sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -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 +492 -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 +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -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 +371 -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 +220 -232
- 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 +204 -216
- 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 +694 -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/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -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 +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -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 +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -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 +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -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 +770 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -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 +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -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 +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
- metadata +3 -4
@@ -1,229 +1,229 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# UI::Notification objects allows you to show native notifications in the
|
5
|
-
# desktop, they are positioned in the top right of your screen, they can be
|
6
|
-
# customized to have a message, icon and accept and/or dismiss buttons with
|
7
|
-
# callback blocks.
|
8
|
-
#
|
9
|
-
# @version SketchUp 2017
|
10
|
-
class UI::Notification
|
11
|
-
|
12
|
-
# Instance Methods
|
13
|
-
|
14
|
-
# Gets the icon name, this is the path that will be used to get the icon from
|
15
|
-
# the file system path.
|
16
|
-
#
|
17
|
-
# @example
|
18
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
19
|
-
# puts "Icon Name: #{notification.icon_name}"
|
20
|
-
# notification.show
|
21
|
-
#
|
22
|
-
# @return [String]
|
23
|
-
#
|
24
|
-
# @version SketchUp 2017
|
25
|
-
def icon_name
|
26
|
-
end
|
27
|
-
|
28
|
-
# Sets the icon path, this icon will be loaded from the path give, the path
|
29
|
-
# has to be a local filesystem path.
|
30
|
-
#
|
31
|
-
# @example
|
32
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
33
|
-
# notification.icon_name = "/path/to/icon"
|
34
|
-
# notification.show
|
35
|
-
#
|
36
|
-
# @param [String] icon_name
|
37
|
-
# String providing the icon filesystem path.
|
38
|
-
#
|
39
|
-
# @return [Boolean]
|
40
|
-
#
|
41
|
-
# @version SketchUp 2017
|
42
|
-
def icon_name=(icon_name)
|
43
|
-
end
|
44
|
-
|
45
|
-
# Gets the icon Tooltip, this is the string that appear when the mouse is over
|
46
|
-
# the icon.
|
47
|
-
#
|
48
|
-
# @example
|
49
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
50
|
-
# puts "Tooltip: #{notification.icon_tooltip}"
|
51
|
-
# notification.show
|
52
|
-
#
|
53
|
-
# @return [String]
|
54
|
-
#
|
55
|
-
# @version SketchUp 2017
|
56
|
-
def icon_tooltip
|
57
|
-
end
|
58
|
-
|
59
|
-
# Sets the icon Tooltip, this string will appear when the mouse is over the
|
60
|
-
# icon.
|
61
|
-
#
|
62
|
-
# @example
|
63
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
64
|
-
# notification.icon_tooltip = "icon Tooltip"
|
65
|
-
# notification.show
|
66
|
-
#
|
67
|
-
# @param [String] icon_tooltip
|
68
|
-
# String providing the new icon Tooltip.
|
69
|
-
#
|
70
|
-
# @return [Boolean]
|
71
|
-
#
|
72
|
-
# @version SketchUp 2017
|
73
|
-
def icon_tooltip=(icon_tooltip)
|
74
|
-
end
|
75
|
-
|
76
|
-
# The new method is used to create a new {UI::Notification}.
|
77
|
-
#
|
78
|
-
# In order to insert line breaks into the message you need to use +\\r\\n+.
|
79
|
-
#
|
80
|
-
# @example
|
81
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
82
|
-
# notification.show
|
83
|
-
#
|
84
|
-
# @param [SketchupExtension] sketchup_extension
|
85
|
-
# Required sketchup_extension
|
86
|
-
# to identify the sender.
|
87
|
-
#
|
88
|
-
# @param [String] message
|
89
|
-
# Optionally assign the message.
|
90
|
-
#
|
91
|
-
# @param [String] icon_name
|
92
|
-
# Optionally set a path to an image.
|
93
|
-
#
|
94
|
-
# @param [String] icon_tooltip
|
95
|
-
# Optionally set an image tooltip.
|
96
|
-
#
|
97
|
-
# @return [UI::Notification]
|
98
|
-
#
|
99
|
-
# @version SketchUp 2017
|
100
|
-
def initialize(sketchup_extension, message, icon_name, icon_tooltip)
|
101
|
-
end
|
102
|
-
|
103
|
-
# Gets the message as string.
|
104
|
-
#
|
105
|
-
# @example
|
106
|
-
# notification = UI::Notification.new(sketchup_extension)
|
107
|
-
# puts "This is the current message: #{notification.message}"
|
108
|
-
# notification.show
|
109
|
-
#
|
110
|
-
# @return [String]
|
111
|
-
#
|
112
|
-
# @version SketchUp 2017
|
113
|
-
def message
|
114
|
-
end
|
115
|
-
|
116
|
-
# Sets a new message, notifications are meant for quick & brief messages,
|
117
|
-
# remember that they are dismissed automatically.
|
118
|
-
#
|
119
|
-
# @example
|
120
|
-
# notification = UI::Notification.new(sketchup_extension)
|
121
|
-
# notification.message = "Hello world"
|
122
|
-
# notification.show
|
123
|
-
#
|
124
|
-
# @param [String] message
|
125
|
-
# String providing the new message.
|
126
|
-
#
|
127
|
-
# @return [Boolean]
|
128
|
-
#
|
129
|
-
# @version SketchUp 2017
|
130
|
-
def message=(message)
|
131
|
-
end
|
132
|
-
|
133
|
-
# Shows a button in the notification with the given title and callback block,
|
134
|
-
# both arguments are required.
|
135
|
-
#
|
136
|
-
# @example
|
137
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
138
|
-
# notification.on_accept("Accept") do |notification, title|
|
139
|
-
# puts "The user pressed [#{title}] with message #{notification.message}"
|
140
|
-
# end
|
141
|
-
# notification.show
|
142
|
-
#
|
143
|
-
# @param [String] title
|
144
|
-
# Sets the title of the button.
|
145
|
-
#
|
146
|
-
# @param [Block] block
|
147
|
-
# Sets the action callback, this will be called when
|
148
|
-
# the user clicks on the dismiss button.
|
149
|
-
#
|
150
|
-
# @raise [RuntimeError] When calling on_accept when the notification has
|
151
|
-
# already been shown.
|
152
|
-
#
|
153
|
-
# @return [Boolean]
|
154
|
-
#
|
155
|
-
# @version SketchUp 2017
|
156
|
-
def on_accept(title, block)
|
157
|
-
end
|
158
|
-
|
159
|
-
# Returns the accept's button title.
|
160
|
-
#
|
161
|
-
# @example
|
162
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
163
|
-
# notification.on_accept("Accept") do |notification, title|
|
164
|
-
# puts "The user pressed #{notification.on_accept_title}"
|
165
|
-
# end
|
166
|
-
# notification.show
|
167
|
-
#
|
168
|
-
# @return [String]
|
169
|
-
#
|
170
|
-
# @version SketchUp 2017
|
171
|
-
def on_accept_title
|
172
|
-
end
|
173
|
-
|
174
|
-
# Shows a button in the notification with the given title and callback block,
|
175
|
-
# both arguments are required.
|
176
|
-
#
|
177
|
-
# @example
|
178
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
179
|
-
# notification.on_dismiss("Close") do |notification, title|
|
180
|
-
# puts "The user pressed [#{title}] with message #{notification.message}"
|
181
|
-
# end
|
182
|
-
# notification.show
|
183
|
-
#
|
184
|
-
# @param [String] title
|
185
|
-
# Sets the title of the button.
|
186
|
-
#
|
187
|
-
# @param [Block] block
|
188
|
-
# Sets the action callback, this will be called when
|
189
|
-
# the user clicks on the dismiss button.
|
190
|
-
#
|
191
|
-
# @raise [RuntimeError] When calling on_dismiss when the notification has
|
192
|
-
# already been shown.
|
193
|
-
#
|
194
|
-
# @return [Boolean]
|
195
|
-
#
|
196
|
-
# @version SketchUp 2017
|
197
|
-
def on_dismiss(title, block)
|
198
|
-
end
|
199
|
-
|
200
|
-
# Returns the dismiss's button title.
|
201
|
-
#
|
202
|
-
# @example
|
203
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
204
|
-
# notification.on_dismiss("Close") do |notification, title|
|
205
|
-
# puts "The user pressed #{notification.on_dismiss_title}"
|
206
|
-
# end
|
207
|
-
# notification.show
|
208
|
-
#
|
209
|
-
# @return [String]
|
210
|
-
#
|
211
|
-
# @version SketchUp 2017
|
212
|
-
def on_dismiss_title
|
213
|
-
end
|
214
|
-
|
215
|
-
# Shows the notification in the top right of the screen, the notifications will
|
216
|
-
# be ordered from top to bottom if multiple notifications are shown, it will
|
217
|
-
# automatically be dismissed if no action is taken.
|
218
|
-
#
|
219
|
-
# @example
|
220
|
-
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
221
|
-
# notification.show
|
222
|
-
#
|
223
|
-
# @return [Boolean]
|
224
|
-
#
|
225
|
-
# @version SketchUp 2017
|
226
|
-
def show
|
227
|
-
end
|
228
|
-
|
229
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# UI::Notification objects allows you to show native notifications in the
|
5
|
+
# desktop, they are positioned in the top right of your screen, they can be
|
6
|
+
# customized to have a message, icon and accept and/or dismiss buttons with
|
7
|
+
# callback blocks.
|
8
|
+
#
|
9
|
+
# @version SketchUp 2017
|
10
|
+
class UI::Notification
|
11
|
+
|
12
|
+
# Instance Methods
|
13
|
+
|
14
|
+
# Gets the icon name, this is the path that will be used to get the icon from
|
15
|
+
# the file system path.
|
16
|
+
#
|
17
|
+
# @example
|
18
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
19
|
+
# puts "Icon Name: #{notification.icon_name}"
|
20
|
+
# notification.show
|
21
|
+
#
|
22
|
+
# @return [String]
|
23
|
+
#
|
24
|
+
# @version SketchUp 2017
|
25
|
+
def icon_name
|
26
|
+
end
|
27
|
+
|
28
|
+
# Sets the icon path, this icon will be loaded from the path give, the path
|
29
|
+
# has to be a local filesystem path.
|
30
|
+
#
|
31
|
+
# @example
|
32
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
33
|
+
# notification.icon_name = "/path/to/icon"
|
34
|
+
# notification.show
|
35
|
+
#
|
36
|
+
# @param [String] icon_name
|
37
|
+
# String providing the icon filesystem path.
|
38
|
+
#
|
39
|
+
# @return [Boolean]
|
40
|
+
#
|
41
|
+
# @version SketchUp 2017
|
42
|
+
def icon_name=(icon_name)
|
43
|
+
end
|
44
|
+
|
45
|
+
# Gets the icon Tooltip, this is the string that appear when the mouse is over
|
46
|
+
# the icon.
|
47
|
+
#
|
48
|
+
# @example
|
49
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
50
|
+
# puts "Tooltip: #{notification.icon_tooltip}"
|
51
|
+
# notification.show
|
52
|
+
#
|
53
|
+
# @return [String]
|
54
|
+
#
|
55
|
+
# @version SketchUp 2017
|
56
|
+
def icon_tooltip
|
57
|
+
end
|
58
|
+
|
59
|
+
# Sets the icon Tooltip, this string will appear when the mouse is over the
|
60
|
+
# icon.
|
61
|
+
#
|
62
|
+
# @example
|
63
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
64
|
+
# notification.icon_tooltip = "icon Tooltip"
|
65
|
+
# notification.show
|
66
|
+
#
|
67
|
+
# @param [String] icon_tooltip
|
68
|
+
# String providing the new icon Tooltip.
|
69
|
+
#
|
70
|
+
# @return [Boolean]
|
71
|
+
#
|
72
|
+
# @version SketchUp 2017
|
73
|
+
def icon_tooltip=(icon_tooltip)
|
74
|
+
end
|
75
|
+
|
76
|
+
# The new method is used to create a new {UI::Notification}.
|
77
|
+
#
|
78
|
+
# In order to insert line breaks into the message you need to use +\\r\\n+.
|
79
|
+
#
|
80
|
+
# @example
|
81
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world", "/path/to/icon", "icon Tooltip")
|
82
|
+
# notification.show
|
83
|
+
#
|
84
|
+
# @param [SketchupExtension] sketchup_extension
|
85
|
+
# Required sketchup_extension
|
86
|
+
# to identify the sender.
|
87
|
+
#
|
88
|
+
# @param [String] message
|
89
|
+
# Optionally assign the message.
|
90
|
+
#
|
91
|
+
# @param [String] icon_name
|
92
|
+
# Optionally set a path to an image.
|
93
|
+
#
|
94
|
+
# @param [String] icon_tooltip
|
95
|
+
# Optionally set an image tooltip.
|
96
|
+
#
|
97
|
+
# @return [UI::Notification]
|
98
|
+
#
|
99
|
+
# @version SketchUp 2017
|
100
|
+
def initialize(sketchup_extension, message, icon_name, icon_tooltip)
|
101
|
+
end
|
102
|
+
|
103
|
+
# Gets the message as string.
|
104
|
+
#
|
105
|
+
# @example
|
106
|
+
# notification = UI::Notification.new(sketchup_extension)
|
107
|
+
# puts "This is the current message: #{notification.message}"
|
108
|
+
# notification.show
|
109
|
+
#
|
110
|
+
# @return [String]
|
111
|
+
#
|
112
|
+
# @version SketchUp 2017
|
113
|
+
def message
|
114
|
+
end
|
115
|
+
|
116
|
+
# Sets a new message, notifications are meant for quick & brief messages,
|
117
|
+
# remember that they are dismissed automatically.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# notification = UI::Notification.new(sketchup_extension)
|
121
|
+
# notification.message = "Hello world"
|
122
|
+
# notification.show
|
123
|
+
#
|
124
|
+
# @param [String] message
|
125
|
+
# String providing the new message.
|
126
|
+
#
|
127
|
+
# @return [Boolean]
|
128
|
+
#
|
129
|
+
# @version SketchUp 2017
|
130
|
+
def message=(message)
|
131
|
+
end
|
132
|
+
|
133
|
+
# Shows a button in the notification with the given title and callback block,
|
134
|
+
# both arguments are required.
|
135
|
+
#
|
136
|
+
# @example
|
137
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
138
|
+
# notification.on_accept("Accept") do |notification, title|
|
139
|
+
# puts "The user pressed [#{title}] with message #{notification.message}"
|
140
|
+
# end
|
141
|
+
# notification.show
|
142
|
+
#
|
143
|
+
# @param [String] title
|
144
|
+
# Sets the title of the button.
|
145
|
+
#
|
146
|
+
# @param [Block] block
|
147
|
+
# Sets the action callback, this will be called when
|
148
|
+
# the user clicks on the dismiss button.
|
149
|
+
#
|
150
|
+
# @raise [RuntimeError] When calling on_accept when the notification has
|
151
|
+
# already been shown.
|
152
|
+
#
|
153
|
+
# @return [Boolean]
|
154
|
+
#
|
155
|
+
# @version SketchUp 2017
|
156
|
+
def on_accept(title, block)
|
157
|
+
end
|
158
|
+
|
159
|
+
# Returns the accept's button title.
|
160
|
+
#
|
161
|
+
# @example
|
162
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
163
|
+
# notification.on_accept("Accept") do |notification, title|
|
164
|
+
# puts "The user pressed #{notification.on_accept_title}"
|
165
|
+
# end
|
166
|
+
# notification.show
|
167
|
+
#
|
168
|
+
# @return [String]
|
169
|
+
#
|
170
|
+
# @version SketchUp 2017
|
171
|
+
def on_accept_title
|
172
|
+
end
|
173
|
+
|
174
|
+
# Shows a button in the notification with the given title and callback block,
|
175
|
+
# both arguments are required.
|
176
|
+
#
|
177
|
+
# @example
|
178
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
179
|
+
# notification.on_dismiss("Close") do |notification, title|
|
180
|
+
# puts "The user pressed [#{title}] with message #{notification.message}"
|
181
|
+
# end
|
182
|
+
# notification.show
|
183
|
+
#
|
184
|
+
# @param [String] title
|
185
|
+
# Sets the title of the button.
|
186
|
+
#
|
187
|
+
# @param [Block] block
|
188
|
+
# Sets the action callback, this will be called when
|
189
|
+
# the user clicks on the dismiss button.
|
190
|
+
#
|
191
|
+
# @raise [RuntimeError] When calling on_dismiss when the notification has
|
192
|
+
# already been shown.
|
193
|
+
#
|
194
|
+
# @return [Boolean]
|
195
|
+
#
|
196
|
+
# @version SketchUp 2017
|
197
|
+
def on_dismiss(title, block)
|
198
|
+
end
|
199
|
+
|
200
|
+
# Returns the dismiss's button title.
|
201
|
+
#
|
202
|
+
# @example
|
203
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
204
|
+
# notification.on_dismiss("Close") do |notification, title|
|
205
|
+
# puts "The user pressed #{notification.on_dismiss_title}"
|
206
|
+
# end
|
207
|
+
# notification.show
|
208
|
+
#
|
209
|
+
# @return [String]
|
210
|
+
#
|
211
|
+
# @version SketchUp 2017
|
212
|
+
def on_dismiss_title
|
213
|
+
end
|
214
|
+
|
215
|
+
# Shows the notification in the top right of the screen, the notifications will
|
216
|
+
# be ordered from top to bottom if multiple notifications are shown, it will
|
217
|
+
# automatically be dismissed if no action is taken.
|
218
|
+
#
|
219
|
+
# @example
|
220
|
+
# notification = UI::Notification.new(sketchup_extension, "Hello world")
|
221
|
+
# notification.show
|
222
|
+
#
|
223
|
+
# @return [Boolean]
|
224
|
+
#
|
225
|
+
# @version SketchUp 2017
|
226
|
+
def show
|
227
|
+
end
|
228
|
+
|
229
|
+
end
|