<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dictionary SYSTEM "file://localhost/System/Library/DTDs/sdef.dtd
">
<dictionary title="Remote Buddy">
<suite name="Remote Buddy Suite" code="RmBS">
<command name="behaviourcore" code="behacore" description="Modify
Behaviour handling.">
<cocoa class="RBBehaviourScriptCommand"/>
<parameter name="accessor" code="accs" description="Command to
execute: activeBehaviour (returns the identifier of the currently
active Behaviour), setActiveBehaviour (set the active Behaviour to the
one specified by the identifier parameter), sticky (active Behaviour
remains active until it is manually deactivated), setSticky (can be
set to 0 or 1), triggerAutoRecognition (removes any set sticky flag
and auto recognizes which Behaviour should currently be active),
plainName (human readable name for the Behaviour identified by option
identifier), defaultMenuAddress (default menu address, i.e.
top.multimedia, top.games, top.system, top.applications, ..)"
type="text">
<cocoa key="accessor"/>
</parameter>
<parameter name="identifier" code="idtf" description="Identifier"
type="text" optional="yes">
<cocoa key="identifier"/>
</parameter>
<parameter name="stickyValue" code="ssck" description="If you are
using the "setActiveBehaviour" or "setSticky"
accessor, you can explicitely define whether the sticky bit is to be
set. It is set by default." type="boolean" optional="yes">
<cocoa key="setSticky"/>
</parameter>
<parameter name="useActivationEventCode" code="actv"
description="One of activated (behave as if explicitely activated by
the user), activatedInFront (behave as if automatically activated
because the corresponding application is in front),
activatedInBackground (behave as if automatically activated because
the frontmost application has no corresponding Behaviour and this
Behaviour has the currently highest background priority value).
Default is "activated". Optional. For use with
setActiveBehaviour only." type="text" optional="yes">
<cocoa key="activateEventCode"/>
</parameter>
<result description="Return value depends on value of accessor.">
<type type="text"/>
<type type="boolean"/>
</result>
</command>
<command name="behaviourlist" code="behalist" description="Receive a
list of the identifiers of all available Behaviours or the available
actions of one Behaviour.">
<cocoa class="RBBehaviourListScriptCommand"/>
<parameter name="allGlobalActionsForIdentifier" code="aafi"
description="If you specifiy a Behaviour identifier here, you'll
receive a list of all of its actions (as far as available)."
type="text" optional="yes">
<cocoa key="identifier"/>
</parameter>
<result description="Returns a list of text values containing the
identifiers of all available Behaviours.">
<type type="text" list="yes"/>
</result>
</command>
<command name="behaviouraction" code="invkactn" description="Invoke
an action by its identifier">
<cocoa class="RBInvokeActionScriptCommand"/>
<parameter name="event" code="acnc" description="One of
"pressed", "repeat" or "released"."
type="text">
<cocoa key="eventCode"/>
</parameter>
<parameter name="buttonCode" code="btnc" description="Button code
to send along with the event. Optional." type="integer" optional="yes">
<cocoa key="buttonCode"/>
</parameter>
<parameter name="actionIdentifier" code="acid" description="The
identifier of the action to send the event to." type="text">
<cocoa key="actionIdentifier"/>
</parameter>
<result description="Returns TRUE if the action was invoked."
type="boolean"/>
</command>
<command name="localize" code="localize" description="Localize a
string using a Localizable.strings look up table inside a bundle.">
<cocoa class="RBLocalizeScriptCommand"/>
<parameter name="string" code="stng" description="Pass the string
to localize." type="text">
<cocoa key="string"/>
</parameter>
<parameter name="in bundle" code="ibdl" description="And the bundle
containing the Localizable.strings lookup table (in general: please
make sure your file is encoded in UTF-8)." type="text">
<cocoa key="inBundle"/>
</parameter>
<result description="The localized version of the string."
type="text"/>
</command>
<command name="osdmessage" code="osdmesag" description="Display a
textual OSD message.">
<cocoa class="RBOSDMessageScriptCommand"/>
<parameter name="display text" code="msgt" description="The text to
display in the OSD" type="text">
<cocoa key="displayText"/>
</parameter>
<parameter name="for duration" code="dura" description="The number
of seconds to display the OSD message." type="real" optional="yes">
<cocoa key="duration"/>
</parameter>
</command>
<command name="read" code="readvalu" description="Read a previously
stored value.">
<cocoa class="RBReadValueScriptCommand"/>
<parameter name="value for key" code="fkey" description="Specify of
which key you'd like to read the associated value." type="text">
<cocoa key="forKey"/>
</parameter>
<parameter name="in domain" code="povr" description="Pass either of
permanent, temporary, merged. permanent will access the permanently
stored values, temporary will only access the temporarily stored
values and merged will first look into the temporary values and fall
back to permanent values if no temporary value exists for the key
given. If not specified, defaults to temporary storage." type="text"
optional="yes">
<cocoa key="inDomain"/>
</parameter>
<parameter name="with default value" code="dfvl" description="Value
to return if nothing was found in the storage specified" optional="yes">
<cocoa key="defaultValue"/>
<type type="text"/>
<type type="integer"/>
<type type="location specifier"/>
<type type="real"/>
<type type="date"/>
</parameter>
<result description="The stored value, if it was found. Or the
default value, if passed.">
<type type="text"/>
<type type="integer"/>
<type type="real"/>
<type type="boolean"/>
<type type="date"/>
<type type="any"/>
</result>
</command>
<command name="scriptremote" code="scptrmte" description="The Script
Remote is a virtual remote control input device in Remote Buddy. It
enables you to f.ex. send events from driver software to Remote Buddy
and use Remote Buddy as if it would directly support the hardware
supported by that driver software.">
<cocoa class="RBScriptRemoteScriptCommand"/>
<parameter name="with items" code="mits" description="Array/List
with all odd entries being the hidden ID to return and all even
entries the labels to present to the user. To implement hierarchical
menus, put arrays/lists (with the same odd/even layout) instead of the
respective hidden IDs." type="any">
<cocoa key="menuItems"/>
</parameter>
<parameter name="return value" code="rtvl" description="If you want
to use Remote Buddy's AppleScript support from outside of it, you
can not provide a call back. If you call showmenu with return value
set to true (or "with return value" in AppleScript
notation), Remote Buddy will pause your script's execution until
the user makes a choice or quits the menu and return the result. Note:
This does not work for scripts executed inside Remote Buddy itself.
For those it simply stops execution and does not resume it."
type="boolean" optional="yes">
<cocoa key="returnValue"/>
</parameter>
<parameter name="menu name" code="mnnm" description="The callback
is passed two parameters: the first one is the chosen value (or
"nothingSelected") and the second one the menu name you pass
here. Using the menu name, you can easily distinguish between several
menus and cleanly seperate your handling code for those." type="text">
<cocoa key="menuName"/>
</parameter>
<result description="The hidden ID that was chosen.
"nothingSelected", if the menu was closed without a
selection from the user.">
<type type="text"/>
<type type="integer"/>
<type type="real"/>
<type type="boolean"/>
<type type="date"/>
<type type="any"/>
</result>
</command>
<command name="store" code="storvalu" description="Store a value
temporarily or permanently for later reuse. All stored values are
global to all scripts run, so several scripts can share values.">
<cocoa class="RBStoreValueScriptCommand"/>
<parameter name="value" code="valu" description="The value to
store.">
<cocoa key="value"/>
<type type="text"/>
<type type="integer"/>
<type type="location specifier"/>
<type type="real"/>
<type type="date"/>
</parameter>
<parameter name="for key" code="fkey" description="The key to store
the value under. Prefix this value with your bundle identifier or
something similiarly unique, i.e. Joe Average would use
"com.average.joe.nameofmyvalue"." type="text">
<cocoa key="forKey"/>
</parameter>
<parameter name="in domain" code="perm" description="Pass either of
permanent, temporary, both. permanent will write to the permanently
stored values, temporary will only write to the temporarily stored
values and both will write to both values.If not specified, defaults
to temporary storage." type="text" optional="yes">
<cocoa key="inDomain"/>
</parameter>
</command>
<command name="visualize" code="visualiz" description="Trigger
visual effects like fade in / out.">
<cocoa class="RBVisualFXScriptCommand"/>
<parameter name="effect" code="efct" description="One of
fadeReserve, fadeOut, fadeIn, fadeCleanUp." type="text">
<cocoa key="effect"/>
</parameter>
<parameter name="for duration" code="fdrn" description="Number of
seconds for the action to perform in." type="real">
<cocoa key="forDuration"/>
</parameter>
<parameter name="with color" code="wclr" description="Optional,
possible values for now: black, white." type="text" optional="yes">
<cocoa key="withColor"/>
</parameter>
<result description="Returns TRUE on success." type="boolean"/>
</command>
<command name="virtualkeyboard" code="virtkbrd" description="Perform
an virtual keyboard action.">
<cocoa class="RBVirtualKeyboardScriptCommand"/>
<parameter name="event" code="evnt" description="One of either
"show", "hide" or "toggle" to show, hide
or toggle visibility of the onscreen keyboard. Show and hide will be
ignored if the keyboard is already shown or already hidden."
type="text">
<cocoa key="event"/>
</parameter>
</command>
</suite>
<suite name="Get URL" code="GURL">
<command name="Get URL" code="GURLGURL" description="Open an URL">
<cocoa class="RBURLHandlerCommand"/>
<direct-parameter type="text" description="The URL to load"/>
</command>
</suite>
</dictionary>
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Applescript-implementors mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription: http://lists.apple.com/mailman/options/applescript-implementors/email@hidden
