add peek$("refsreceived") documentation

This commit is contained in:
Jim Saxton
2016-05-03 17:50:13 -07:00
parent c898cf281c
commit e1459f1135
2 changed files with 221 additions and 219 deletions

View File

@@ -4893,6 +4893,14 @@ This peek returns the name of the operating system, on wich your yab version was
peek$("env","NAME") peek$("env","NAME")
Return the environment variable specified by NAME (which may be any string expression). Which kind of environment variables are available on your system depends, as well as their meaning, on your system; however typing env on the commandline will produce a list. Note, that peek$("env",...) can be written as peek$("environment",...) too. Return the environment variable specified by NAME (which may be any string expression). Which kind of environment variables are available on your system depends, as well as their meaning, on your system; however typing env on the commandline will produce a list. Note, that peek$("env",...) can be written as peek$("environment",...) too.
peek$("refsreceived")
Returns TrackerItem which you used 'open with...' your application on, or the path and name of the file that was double-clicked. The double-clicked file must have an attribute "BEOS:PREF_APP" set to the yab applications signature and the this application signature must be registered in the FileTypes prefflet.
Save a data file and then use :
ATTRIBUTE SET "Mime:, "BEOS:PREF_APP", "application/x-vnd.yourcool-app", Filename$
Where "application/x-vnd.yourcool-app" is the apoplication signature and Filename$ is the name of the data file. Double-clicking the data file will open the yab application. peek$("refsreceived") will return this data file pathame.
peek$("argument") peek$("argument")
Return one of the arguments, that have been passed to yab at invocation time (the next call will return the the second argument, and so on). E.g. if yab has been called like this: yab foo.yab bar baz, then the first call to peek$("argument") will return bar. This is because foo.yab is treated as the name of the program to run, whereas bar and baz are considered arguments to this program, which are passed on the commandline. The second call to peek$("argument") will return baz. Note, that peek$("argument") can be written as peek$("arguments"). Return one of the arguments, that have been passed to yab at invocation time (the next call will return the the second argument, and so on). E.g. if yab has been called like this: yab foo.yab bar baz, then the first call to peek$("argument") will return bar. This is because foo.yab is treated as the name of the program to run, whereas bar and baz are considered arguments to this program, which are passed on the commandline. The second call to peek$("argument") will return baz. Note, that peek$("argument") can be written as peek$("arguments").
Finally you will want to check out the corresponding function peek("argument"). Finally you will want to check out the corresponding function peek("argument").
@@ -4902,16 +4910,14 @@ print "You have supplied these arguments: "
while(peek("argument")) while(peek("argument"))
print peek("argument"),peek$("argument") print peek("argument"),peek$("argument")
wend wend
Explanation: Explanation:
If you save this program in a file foo.yab and execute it via yab t.yab a b c, your will get this output: If you save this program in a file foo.yab and execute it via yab t.yab a b c, your will get this output:
&exverbatim
3a 3a
2b 2b
1c 1c
&exverbatim
Related: peek, poke, open Related: peek, poke, open

View File

@@ -338,431 +338,427 @@ peek
136435 136435
peek$ peek$
141988 141988
3a
144889
144910
poke poke
144945 145605
rem rem
146183 146843
sleep sleep
147297 147957
system$() system$()
147656 148316
system() system()
148245 148905
thread get thread get
148868 149528
thread remove thread remove
150217 150877
time$ time$
151140 151800
to to
152309 152969
// //
152863 153523
: :
153367 154027
&Bitmaps &Bitmaps
154000 154660
& &
154002 154662
bitmap bitmap
154009 154669
bitmap color bitmap color
154368 155028
bitmap get bitmap get
154720 155380
bitmap image bitmap image
157845 158505
bitmap remove bitmap remove
158132 158792
bitmap save bitmap save
158360 159020
screenshot screenshot
158757 159417
159003 159663
159013 159673
draw bitmap draw bitmap
159027 159687
draw circle draw circle
159893 160553
draw curve draw curve
160552 161212
draw dot draw dot
161537 162197
draw ellipse draw ellipse
162118 162778
draw flush draw flush
162857 163517
draw get draw get
163987 164647
draw get$ draw get$
165933 166593
draw image draw image
167346 168006
draw line draw line
169252 169912
draw rect draw rect
169824 170484
draw set draw set
170480 171140
draw text draw text
173849 174509
& &
175019 175679
ismousein() ismousein()
175031 175691
keyboard message$() keyboard message$()
175753 176413
message$ message$
177642 178302
message send message send
179975 180635
mouse message$() mouse message$()
181025 181685
mousemove$ mousemove$
183049 183709
mouse set mouse set
183705 184365
shortcut shortcut
184211 184871
"S" for the shift key "S" for the shift key
185011 185671
185163 185823
"O" for ALT-O "O" for ALT-O
185313 185973
185378 186038
ALT-X ALT-X
185802 186462
185845 186505
&Printing &Printing
186796 187456
& &
186798 187458
printer printer
186806 187466
printer setup printer setup
189179 189839
& &
190203 190863
menu menu
190208 190868
Menu$ = "--" Menu$ = "--"
190676 191336
then the menu item will be a separator line. then the menu item will be a separator line.
190733 191393
"S" for the shift key "S" for the shift key
191206 191866
These modifiers can be combined, but the following combinations do not work: "SO", "SC" and "SCO" These modifiers can be combined, but the following combinations do not work: "SO", "SC" and "SCO"
191455 192115
"O" for ALT-O "O" for ALT-O
191506 192166
191571 192231
For the menu Head$ "File": For the menu Head$ "File":
192369 193029
192619 193279
menu set menu set
193711 194371
Option$ = "Disable" -- grey out the item so it cannot be selected anymore Option$ = "Disable" -- grey out the item so it cannot be selected anymore
194514 195174
194663 195323
popupmenu popupmenu
195774 196434
submenu submenu
197422 198082
Menu$ = "--" Menu$ = "--"
198006 198666
then the submenu item will be a separator line. then the submenu item will be a separator line.
198066 198726
"S" for the shift key "S" for the shift key
198542 199202
These modifiers can be combined, but the following combinations do not work: "SO", "SC" and "SCO" These modifiers can be combined, but the following combinations do not work: "SO", "SC" and "SCO"
198791 199451
"O" for ALT-O "O" for ALT-O
198842 199502
198907 199567
submenu set submenu set
201793 202453
Option$ = "Disable" -- grey out the item so it cannot be selected anymore Option$ = "Disable" -- grey out the item so it cannot be selected anymore
202669 203329
202818 203478
&Boxview &Boxview
203572 204232
& &
203574 204234
boxview boxview
203582 204242
boxview set boxview set
205007 205667
canvas canvas
205238 205898
layout layout
205676 206336
& &
206898 207558
scrollbar scrollbar
206908 207568
scrollbar get scrollbar get
207128 207788
scrollbar set scrollbar set
207407 208067
& &
208839 209499
splitview splitview
208849 209509
splitview get splitview get
209787 210447
splitview set splitview set
210017 210677
& &
210550 211210
stackview stackview
210560 211220
stackview get stackview get
212674 213334
stackview set stackview set
212965 213625
& &
213422 214082
tabview tabview
213430 214090
tabview add tabview add
213710 214370
tabview get tabview get
214607 215267
tabview set tabview set
214806 215466
& &
214990 215650
view view
214995 215655
view dropzone view dropzone
215139 215799
view get view get
215424 216084
view remove view remove
215699 216359
& &
216190 216850
button button
216197 216857
button image button image
217512 218172
calendar calendar
219253 219913
calendar get$ calendar get$
220920 221580
calendar set calendar set
221413 222073
checkbox checkbox
221838 222498
checkbox image checkbox image
223095 223755
checkbox set checkbox set
225322 225982
colorcontrol colorcontrol
225621 226281
colorcontrol get colorcontrol get
227643 228303
colorcontrol set colorcontrol set
228251 228911
columnbox columnbox
228587 229247
columnbox add columnbox add
233797 234457
columnbox clear columnbox clear
234978 235638
columnbox color columnbox color
235346 236006
columnbox column columnbox column
236391 237051
columnbox count columnbox count
237550 238210
columnbox get columnbox get
237988 238648
columnbox get$ columnbox get$
238523 239183
columnbox remove columnbox remove
239066 239726
columnbox select columnbox select
239423 240083
& &
239879 240539
dropbox dropbox
239887 240547
dropbox add dropbox add
241092 241752
dropbox clear dropbox clear
241366 242026
dropbox count dropbox count
241617 242277
dropbox get$ dropbox get$
241867 242527
dropbox remove dropbox remove
242161 242821
dropbox select dropbox select
242720 243380
listbox listbox
242999 243659
listbox add listbox add
245964 246624
listbox clear listbox clear
246442 247102
listbox count listbox count
246737 247397
listbox get listbox get
247133 247793
listbox get$ listbox get$
247620 248280
listbox remove listbox remove
248038 248698
listbox select listbox select
248377 249037
listbox sort listbox sort
249022 249682
& &
249731 250391
option color option color
249744 250404
option set option set
249954 250614
radiobutton radiobutton
250846 251506
radiobutton set radiobutton set
252580 253240
& &
252984 253644
slider slider
252991 253651
slider color slider color
253712 254372
slider get slider get
254135 254795
slider label slider label
254362 255022
slider set slider set
254613 255273
spincontrol spincontrol
255225 255885
spincontrol get spincontrol get
255522 256182
spincontrol set spincontrol set
255752 256412
statusbar statusbar
255972 256632
statusbar set statusbar set
257441 258101
text text
257939 258599
text set text set
259127 259787
& &
260249 260909
textcontrol textcontrol
260261 260921
textcontrol clear textcontrol clear
260786 261446
textcontrol get$ textcontrol get$
261024 261684
textcontrol set textcontrol set
261316 261976
textedit textedit
262442 263102
textedit add textedit add
263105 263765
textedit clear textedit clear
263430 264090
textedit color textedit color
263772 264432
textedit get textedit get
264753 265413
textedit get$ textedit get$
266445 267105
textedit set textedit set
266884 267544
& &
270091 270751
texturl texturl
270099 270759
texturl color texturl color
270707 271367
tooltip tooltip
271087 271747
tooltip color tooltip color
272767 273427
& &
274050 274710
treebox treebox
274058 274718
treebox add treebox add
274421 275081
treebox clear treebox clear
274946 275606
treebox collapse treebox collapse
275209 275869
treebox count treebox count
275507 276167
treebox expand treebox expand
275815 276475
treebox get$ treebox get$
276098 276758
treebox remove treebox remove
276425 277085
treebox select treebox select
276910 277570
treebox sort treebox sort
277213 277873
& &
277507 278167
localize localize
277516 278176
# A comment starts with a # # A comment starts with a #
279080 279740
279204 279864
translate$() translate$()
280770 281430
&Sound &Sound
281523 282183
& &
281525 282185
beep beep
281530 282190
bell bell
281764 282424
sound play sound play
282127 282787
sound stop sound stop
283052 283712
sound wait sound wait
283426 284086
&Window &Window
283831 284491
& &
283833 284493
alert alert
283839 284499
filepanel filepanel
285617 286277
window open window open
288907 289567
window close window close
291622 292282
window count window count
292114 292774
window get window get
292741 293401
window set window set
294462 295122