＃ operator? operator@ operatorabs tagadd tagalign fieldand tagarray tagaudio tagbackgroundColor fieldbold fieldborder fieldborderBottom fieldborderColor fieldborderLeft fieldborderRight fieldborderStyle fieldborderTop fieldbottom fieldbox tagbutton tagcarat fieldcheckBox tagchoiceBox tagclass tagclear tagclientFrame tagcolor fieldconsole tagdialog tagdiv tagdo fieldeditable fieldellipse tagelse fieldeq tagfalse tagfocus fieldfocusOrder fieldfont fieldfor tagformat fieldge taggt tagheight fieldhotKey fieldif tagimg taginf taginline fieldinput taginvalid tagint tagitalic fieldjoin taglayer fieldle tagleft fieldlimit fieldline taglt tagmargin fieldmarginBottom fieldmarginLeft fieldmarginRight fieldmarginTop fieldmod tagmul tagne tagneg tagnot tagnull tagnum tagonClear fieldonClick fieldonContextClick fieldonExit fieldonFocus fieldonGet fieldonInput fieldonKeyDown fieldonSet fieldonKeyPress fieldonKeyUp fieldonMouseDown fieldonMouseIn fieldonMouseMove fieldonMouseOut fieldonMouseUp fieldonPull fieldonPush fieldonResize fieldonTimer fieldopenLink tagopacity fieldor tagpivot fieldplaying fieldput tagputError tagputLn tagrequestTransfer tagright fieldrotate fieldscalar tagscroll fieldscrollPos fieldselectable fieldsize fieldspacing fieldspacingBottom fieldspacingLeft fieldspacingRight fieldspacingTop fieldspan tagsplit tagsub tagtable tagtabRow tagthen fieldtimer tagtop fieldtransfer tagtransferAbility tagtransition fieldtrue tagunderline fieldvector tagvideo tagvisible fieldvoid tagwidth fieldwith fieldwrap fieldxor tag

transferAbility tag

Persistent logic tag

Offers one of the program's file operations to other applications, such as saving, opening or printing.

TODO: this page is incomplete.

Sample usage

<save:transferAbility mode={wa} format={txt:Text file} description={Save to this notebook} {Save}> offers a Save ability for text files, which other applications can write to.

Fields

Primary field

Scalar field

The name of the ability, such as {Save} or {Print}. It must be unique within this program.

Secondary fields

description: (scalar field) a description of the ability, which may be shown to the user when they choose which application to connect to.
format: (vector field) the file formats the ability can handle, such as {txt:Text file} or {*} for any format. See format.
mode: (scalar field) the access modes that may be used while a transfer connection exists, such as {w}, {rR} or {wa}. Order matters: the expected initial mode (direction of transfer) is listed first. A connection may require only the first mode, while being able to use the others if available.
onRequest: (code field) carried out when another application asks to use the ability.
instance: one or more reference pointers to transfer tag instances, one for each incoming request, which can be used to accept the connection.
*: the current incoming request (see async).
async: (scalar field, optional) false by default. When false, incoming requests are queued: each waits until the earlier ones have been accepted or rejected, and * refers to the oldest. When true, each request triggers onRequest immediately and * refers to the newest, so several requests can be handled at once; store a reference to * before another request arrives and replaces it.

Behaviour

While a transferAbility tag exists, other applications in the user's environment can find the ability and ask to use it. When the user chooses this program to connect to, the request arrives as a transfer tag instance. Removing the tag withdraws the ability.

Create one transferAbility for each file operation the program offers: for example, a text editor might offer Open and Save, and a printer Print and Scan.