TweetFollow Us on Twitter

March 96 - According to Script: Properties and Preferences

ACCORDING TO SCRIPT: Properties and Preferences

Cal Simone

On the way to implementing scripting support in your applications, you're bound to confront a variety of issues. In this column, I'll give you some pointers for devising and testing property names and discuss the techniques for handling preferences through scripting.

PROPERTIES

In an application's scripting vocabulary, a property is an attribute of an object. Properties can replace variables in if and repeat statements, as well as in expressions, and a script writer normally uses the AppleScript verbs set and get with them. Here I'll give some guidelines for coming up with human-language names for properties and testing the viability of those names within the overall natural style of the AppleScript language. It's important that properties have names that users can easily become familiar with. Ideally, users should be able to refer to properties in a script the way they think or speak about them.

Don't start property names with verbs. Starting property names with verbs leads to confusion when the property appears in the middle of a sentence. For example, naming a property disable call waiting leads to commands that don't read smoothly:

set disable call waiting to true 
if disable call waiting then ... 
This is somewhat clearer:
set call waiting enabled to false
if not call waiting enabled ... 
In fact, in the above case, it would be even better to name the property call waiting and use an enumeration as its value type (for a discussion of enumerations, see my article "Designing a Scripting Implementation" in develop Issue 21). The choices enabled and disabled allow grammatically correct sentences, as in the following:
set call waiting to enabled
if call waiting is disabled ... 
A little creative thinking goes a long way in making it easy for users to work with the language.

The "the" test. AppleScript allows you to add or remove the word the almost anywhere in a script without changing the meaning of the script. Many script writers precede object and property names with the word the to make their scripts easier to read. Writing your test scripts in this way helps you determine the degree to which your property names facilitate forming natural sentences.

set the service to "America Online"
if the priority is high then ...

Don't confuse attributes and actions. Sometimes setting a property can cause an immediate change on the screen. In deciding whether to use a property in this situation, a helpful rule is: When an action is initiated, use a verb; when an attribute changes (even if it produces immediate visible results), use a property. Another way of looking at this is if a visible change is immediate, it's OK to use a property, but if an action has a duration, use a verb.

As an example, the following command causes an immediate change on the screen:

set the font of the third paragraph to "Courier"
Even though setting the font property creates a visible change, the font is still an attribute of the text, not an action. On the other hand, naming a property or enumerator playing, as shown in the next two commands, is a poor choice, because playing actually initiates an action:
set playing to true   
set [the] status to playing   
The playing enumerator value in the second command is fine for obtaining state information, but a status property should be read-only. Instead of creating a property to control an action, use a verb. Verbs such as play or start playing are better suited for actions, as shown here:
play the movie "Wowie Zowie"
start playing the movie "Wowie Zowie"
Note that the commands are play and start playing, not play movie or start playing movie. In an application based on the object model, movie would be an object class.

The properties property. A properties property enables script writers to obtain all the properties for a given object in the form of a record by using a get properties construct. (I first suggested using records in this column in develop Issue 22.) The properties property can also be set with the set command. The sample properties property shown in Listing 1 can be included as a property of any object for which you allow the setting of more than one property at a time.

Listing 1. A sample properties property

{   /* array Properties: 5 elements */
   /* [5] */
   "properties",
   'Prop',
   'reco',
   "Property that allows setting of a list
      of properties.",
   reserved, singleItem, notEnumerated,
   readWrite, reserved,
   ...
},
Don't require the user to supply all the properties when setting the properties property -- allow the setting of just one or a few properties.

get the properties of the fourth paragraph 
   -- returns font, size, style, and so on
set the properties of the fourth paragraph to ~
   {font:"Helvetica", size:14} 

PREFERENCES

Developers use a variety of techniques to allow users to set preferences through scripts. I'll describe three common and easily implemented approaches for dealing with preference properties in your application class. (These same approaches can be used to implement document settings or group properties for individual objects within your application.)

Separate properties for each preference. Implementing preferences as individual properties works well when you have only a few preferences. For example:

set the connect sound to "Shriek"
set the receive folder to alias "HD:Drop Folder"
If you have many preferences, it's inefficient for the user to have to set each property individually. To solve this, you can implement your preferences as individual properties (usually in your vocabulary's application class definition) and also include a preferences property, described next.

A property that includes all the preferences. You can make a single preferences or settings property, which is a record that's defined elsewhere in your vocabulary. To define the elements of the record, create a fake "class" in your vocabulary, preferably in your Type Definitions Suite, to serve as the definition of the element labels in a record definition. In the comment field for your "class," be sure to document clearly that this is a record definition, not an object class. Listing 2 illustrates this technique; for more information, see the section "Define Record Labels in a Record Definition" in "Designing a Scripting Implementation" in develop Issue 21.

Listing 2. A sample preferences property

/* First, define this application property. */
{   /* array Properties: 5 elements */
   /* [5] */
   "preferences",
   'Pref',   
   'cprf,      /* for "preferences class" */
   "Property that allows setting some or all
      of your preferences.",
   reserved, singleItem, notEnumerated,
   readWrite, reserved,
   ...      /* more reserved items */
},
... /* more property definitions */

/* Later, in your Type Definitions Suite, */
/* create a fake class. */
{   /* array Classes: 1 element */
/* [1] */
"preferences record",
'cprf',
"A record containing individual preferences",
{   /* array Properties: 10 elements */
   /* [1] */
   "connect sound", 'CSND', 'itxt',
   "the name of the sound to use when
      connected",
   reserved, singleItem, notEnumerated,
   ...
   /* [2] */
   "receive folder", 'RFLD', 'alis',
   "the folder to place files when received",
   reserved, singleItem, notEnumerated,
   ...
},
{   /* array Elements: 0 elements */
}
Lists and records are the two principal constructs in AppleScript that don't lend themselves to human sentence structure. They are, however, an integral part of the language and can occasionally help to make the script writer's life easier. When you use a record to create a preferences property, it's OK to stray a little from strict natural-language style. Of course, when referring to elements of a list or record, you should use natural-language style.

As with the properties property described earlier, don't require the user to set all the individual preferences at once. Allow the setting of just one or a few preferences at a time:

set the preferences to ~
   {connect sound:"Shriek", ~
    receive folder:alias "HD:Drop folder"}
A user can address individual preferences as if they were defined as separate application properties. To allow for varying user experience with AppleScript, your application should always accept property specifications for individual preferences using the technique described above, regardless of whether the user includes the qualifying phrase of the preferences. For example, both of the following statements should be allowed:
set the receive folder of the preferences to ~
   alias "HD:Drop Folder"
set the receive folder to alias "HD:Drop Folder"

Multiple "group" properties for grouping preferences. If you have many preferences or want to group the preferences according to similar functionality, such as those often found in multipaneled dialog boxes, you can create separate properties for groups of preferences or settings (using the record definition technique just described). The properties can reflect the groupings you've set up in your graphical interface:

set the compiler preferences to ~
   {warnings included:true, ~
   default integer size:short integer}

set the drawing settings to ~
   {pen size:{1,2}, shape:circle}
A user addresses an individual preference by including in the object property specification the record that the preference is an element of, as follows:
the pen size of the drawing settings
set the shape of the drawing settings to ~
   rectangle
set the default integer size of the compiler ~
   preferences to short integer

PARTING WORDS

Following these guidelines in implementing scriptability in your applications makes it easier for users to write scripts. Although they may seem like small points, it's the details that mean the difference between frustration and smooth sailing for the script writer. Remember to think about the way a user would write or speak about accomplishing what they want to do. Until next time, I remain your obedient servant on the AppleScript front. I'll see you on applescript-implementors@abs.apple.com, the mailing list for scriptability.

CAL SIMONE (AppleLink MAIN.EVENT, Internet mainevent@his.com) wants your dictionary for the Webster database, which will be used to help resolve human-name conflicts between different applications and scripting additions. He'll be analyzing the terms in your vocabulary against others in search of similarities and differences. Send your 'aete' resources to Cal via AppleLink or the Internet.*

Thanks to Eric Gundrum, Jon Pugh, and Derrick Schneider for reviewing this column.*

 
AAPL
$117.60
Apple Inc.
-1.03
MSFT
$47.47
Microsoft Corpora
-0.12
GOOG
$541.08
Google Inc.
+1.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

MacUpdate Desktop 6.0.3 - Discover and i...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
SteerMouse 4.2.2 - Powerful third-party...
SteerMouse is an advanced driver for USB and Bluetooth mice. It also supports Apple Mighty Mouse very well. SteerMouse can assign various functions to buttons that Apple's software does not allow,... Read more
iMazing 1.1 - Complete iOS device manage...
iMazing (was DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and from... Read more
PopChar X 7.0 - Floating window shows av...
PopChar X helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to access any font's special characters. Expanded... Read more
Carbon Copy Cloner 4.0.3 - Easy-to-use b...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
ForeverSave 2.1.3 - Universal auto-save...
ForeverSave auto-saves all documents you're working on while simultaneously doing backup versioning in the background. Lost data can be quickly restored at any time. Losing data, caused by... Read more
Voila 3.8.1 - Capture, annotate, organiz...
Voila is a screen-capture, recording, and annotation tool that is a full-featured replacement for Mac's screen-capture and screen-recording capabilities. It has a large and robust set of editing,... Read more
SyncTwoFolders 2.0.6 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
Duplicate Annihilator 5.1.1 - Find and d...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator detects... Read more
HandBrake 0.10.0 - Versatile video encod...
HandBrake is a tool for converting video from nearly any format to a selection of modern, widely supported codecs. Supported Sources: VIDEO_TS folder, DVD image or real DVD (unencrypted -- CSS is... Read more

Latest Forum Discussions

See All

Screeny (Utilities)
Screeny 1.0 Device: iOS iPhone Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: Screeny is an utility app that helps you save space consumed by screenshots. It screens your camera roll and helps you to filter and... | Read more »
Tilt to Live Bundle Set to Arrive This T...
Tilt to Live Bundle Set to Arrive This Thanksgiving Posted by Ellis Spice on November 25th, 2014 [ permalink ] One Man Left has unveiled an upcoming Tilt to Live bundle, allowing players to get the series for a di | Read more »
BattleLore: Command (Entertainment)
BattleLore: Command 1.0 Device: iOS Universal Category: Entertainment Price: $9.99, Version: 1.0 (iTunes) Description: ***NOTE: Compatible with iPad 2/iPad mini, iPod touch 5 and up and iPhone 4S and up – WILL NOT RUN ON EARLIER... | Read more »
Weather Or Not Review
Weather Or Not Review By Jennifer Allen on November 25th, 2014 Our Rating: :: STYLISH WEATHER REPORTINGiPhone App - Designed for the iPhone, compatible with the iPad Check the weather quickly and conveniently with Weather or Not... | Read more »
The All-New Football Manager Handheld 20...
The All-New Football Manager Handheld 2015 is Available Now Posted by Jessica Fisher on November 25th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Six iOS Games to Get You Ready for Thank...
Image Source: Friends Wiki At this point in the month, you or at least a few people you know are probably getting ready to scramble around (or are already scrambling around) for Thanksgiving Dinner. It’s a hectic day of precise oven utilization, but... | Read more »
Call of Duty: Heroes: Tips, Tricks, and...
Hello Heroes: What’d we think of Call of Duty‘s take on Clash of Clans? Check out our Call of Duty: Heroes review to find out! Just downloaded Call of Duty: Heroes and need some handy tips and tricks on how to get ahead of the rest? As we often do,... | Read more »
Call of Duty: Heroes Review
Call of Duty: Heroes Review By Jennifer Allen on November 25th, 2014 Our Rating: :: CLASH OF FRANCHISESUniversal App - Designed for iPhone and iPad Mix Clash of Clans with Call of Duty, and this is what you get.   | Read more »
Slider Review
Slider Review By Jordan Minor on November 25th, 2014 Our Rating: :: SLIDE TO PLAYUniversal App - Designed for iPhone and iPad Slider has all the excitement of unlocking your phone screen.   | Read more »
oh my giraffe (Games)
oh my giraffe 1.0.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.0 (iTunes) Description: Eat fruits while being chased by lions. Cut the vines to send fruit plummeting onto the lions. Don't worry, your flexible... | Read more »

Price Scanner via MacPrices.net

Early Black Friday MacBook Pro sale: 15-inch...
 Best Buy has posted early Black Friday prices on 15″ Retina MacBook Pros, with models on sale for $300 off MSRP on their online store for a limited time. Choose free local store pickup (if available... Read more
A9 Chips Already?
It’s barely more than a couple of months since Apple got the first A8 systems-on-chip into consumer hands, but rumor and news focus is already turning to the next-generation A9 SoC. Apple Daily... Read more
NewerTech Announces NuGuard KXs Impact X-Orbi...
NewerTech has announced updates to its family of Impact X-Orbing Screen Armor bringing military grade, triple layer protection to Apple’s new iPhone 6 and 6 Plus. Like all models in the NuGuard KXs... Read more
13-inch 1.4GHz MacBook Air on sale for $889,...
 B&H Photo has the 13″ 1.4GHz/128GB MacBook Air on sale for $889 including free shipping plus NY tax only. Their price is $110 off MSRP. B&H will also include free copies of Parallels Desktop... Read more
Save up to $300 on Macs and iPads with your A...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple refurbished Mac Pros available for up t...
The Apple Store is offering Apple Certified Refurbished Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Jumptuit Launches One-Tap Windows 8.1 iTunes...
Jumptuit has launched Windows 8.1 support for One-Tap iTunes Sync. with which Windows 8.1 users can now easily sync their iTunes libraries with Microsoft OneDrive. Jumptuit provides easy access from... Read more
Apple restocks refurbished 13-inch 2014 Retin...
The Apple Store has restocked Apple Certified Refurbished 2014 13″ 2.6GHz Retina MacBook Pros for up to $230 off the cost of new models. An Apple one-year warranty is included with each model, and... Read more
CEA Study Finds More People Recycling Electro...
A new study by the Consumer Electronics Association (CEA) finds that electronics recycling receives the continued and growing support of consumers. According to the CEA,s Recycling and Reuse Study,... Read more
15″ 2.2GHz Retina MacBook Pro on sale for $17...
 B&H Photo has the 2014 15″ 2.2GHz Retina MacBook Pro on sale today for $1749. Shipping is free, and B&H charges NY sales tax only. B&H will also include free copies of Parallels Desktop... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.