TweetFollow Us on Twitter

A Select Few

Volume Number: 16 (2000)
Issue Number: 10
Column Tag: Carbon Development

A Select Few...

by Daniel Jalkut

Taking advantage of Apple's standardized Type Selection API

Introduction

A feature frequently overlooked by new Mac OS users is the ability to select items from a list by typing part of its name. Apple calls this functionality "type selection." Seasoned Mac users are accustomed to type selection and navigate rapidly through Finder hierarchies and StandardFile dialogs without ever letting their hands leave the keyboard. When a user discovers this feature, it is probably with some disappointment that they find support for type selection varies widely amongst third-party applications. Every application that uses StandardFile and Navigation Services dialogs gets type selection for free in those portions of their program. For custom application dialogs and views, developers have been required to write their own, custom type selection code. The result is that some applications don't support type selection at all, some support it to varying extents, and almost none support it in a way that mimics every last nuance of Apple's own type selection algorithm. The opportunity to end these inconsistencies is before us, for Apple's Type Selection APIs have made their public debut.

Without fanfare, Apple included their time-tested internal Type Selection APIs in the first public releases of the CarbonLib extension for Mac OS. As of this writing, the latest version is CarbonLib 1.0.4, and it is available from Apple's web site at http://asu.info.apple.com/swupdates.nsf/artnum/n11673. CarbonLib is the library that enables applications ported to Mac OS X's Carbon APIs to continue running on Mac OS 9 and earlier (as early as 8.1) systems. There is no shortage of compelling reasons to port your application to Carbon. Apple's decision to support two platforms with a nearly identical API set provides an irresistibly easy way of adding Mac OS X to the list of your supported platforms, without losing your existing customer base. Access to standardized type selection is by no means the greatest benefit of porting to Carbon, but it has the potential of causing a vast improvement in the user's experience on the Mac.

What's The Big Deal?

You might be wondering why something as seemingly straightforward as selecting list items with the keyboard should require a standardized API. The user hits a key, you select a matching item, and we're done - right? Actually, the apparent simplicity of type selection is a testament to its internal complexity. You may not have even considered much of the functionality Apple's TypeSelect APIs provide unless you have spent a great deal of time focusing only on the dynamics of type selection. Most developers do not have the time to become type selection experts, so they implement something that makes sense to them, yet lacks the subtle elegance of Apple's code. Some of the features of Apple's API are:

International Support

Support for international scripts, which Apple has always promoted, is becoming more and more important as the customer base for Apple outside of the United States continues to grow. As a developer, anything that provides international support for free is a big win for your product, because it is one fewer thing you need to worry about when pushing to make a localized release available. Apple's type selection APIs use script-aware string comparison functions, which in turn guarantee that every selection made by the user causes a match as expected for the appropriate script.

Multi-Character Matching

A major shortcoming of some third-party implementations of type selection is that only the last key pressed is ever used as a criterion for matching against items. If you type characters in a Finder view, you will notice that the active selection changes as the characters you type grow into a more specific match with the item you're seeking. For instance, if there are three icons in a view, "Belize", "Biafra", and "Burundi", typing just "B" will select the first, "Bi" the second, and "Bu" the third. In an implementation that didn't support multi-character matching, the user would be forced to type "B" to locate the first item, and then navigate with arrow keys to the desired item. No amount of typing would select either "Biafra," or "Burundi" without moving a hand from the keyboard to the mouse.

Time-Out and Cancellation

One unexpectedly complicated aspect of a proper type selection implementation is elegantly guessing the train of thought a user has embarked on: knowing when to stop one selection and begin another. This task is impossible to do correctly every time, but Apple comes close with comfortable and consistent behavior that gives the user a great deal of control.

The type selection APIs keep a running tab of the keys that have been pressed, and when no keys have been pressed for a duration of time, that buffer is flushed, with the assumption that the user has finished typing the fragment they were seeking. To accommodate the user who knows they have mistyped, or who has quickly changed their mind, the APIs also respond to the escape key, which forces type selection to clear its buffers and begin matching keys as a new string.

Implementing Type Selection In A List

To demonstrate the use of the type selection APIs, I have included with this article a sample application, "ListSample", which simply displays a list of selectable items in a dialog. The applications responds to keyDown events by passing them to the Type Selection API, "TypeSelectNewKey", which determines whether the key pressed justifies searching for a new match. If it does, another API, "TypeSelectFindItem" is called, which uses the state of the key buffer and a list of items provided by the client to determine the most appropriate selection.

Application Prerequisites

Before I could implement type selection in ListSample, I first had to ensure that the application had been carbonized and compiled with Apple's latest Universal Headers. If you have already carbonized your application, then you're ready to go. If you haven't, then you will need to do so before you can call any of the Type Selection APIs described in this article.

ListSample Implementation

The easiest way to demonstrate the use of the Type Selection APIs is to explain the three pieces of code in ListSample which interact with the APIs:

  • A TypeSelectRecord is initialized before any type selection can occur.
  • Key down events are passed to Type Selection, and a new match is found if appropriate.
  • A callback routine for finding matches is implemented.

First, initialize a TypeSelectRecord. This is done by calling TypeSelectClear() with an empty TypeSelectRecord as its parameter. In ListSample, this is done in main()

Listing 1: main

Main

Setup the menu bar, initialize TypeSelection, create our sample dialog and run the event loop until we are quit.

main()
{   
   // Setup the menu bar
   SetMenuBar(GetNewMBar(rAppMenuBarID));
   DrawMenuBar();
   
   // Initialize the type selection record
   TypeSelectClear(&gTypeSelectState);
   
   // Prepare the sample dialog
   gTheDialog = SetupSampleDialog();
   if (gTheDialog != NULL)
   {
      // Handle Events!
      while (gQuitApplication == false)
      {
         ApplicationEventLoop();
      }
      DisposeDialog(gTheDialog);
   }
   
   ExitToShell();
   return 0;
}


Next, for each keyDown event that pertains to the list, ask if a new item needs to be matched. This is done by calling TypeSelectNewKey() - if it returns true, then it is time to find a new match for the list by calling TypeSelectFindItem. I have implemented this functionality in the ListSample routine that handles all keyDown events:

Listing 2: HandleKeyDownEvent

HandleKeyDownEvent

Handle key down events not handled by the Dialog Manager. If the key is not a menu-shortcut, then ask the TypeSelection APIs whether the key might change the state of the current selection, and if so, ask it to determine the new selection

void HandleKeyDownEvent(EventRecord* theEvent)
{
   Boolean               eventHandled = false;
   static IndexToStringUPP   myStringGetter = NULL;
   
   // Handle the cmd-key menu case first
   if(theEvent->modifiers & cmdKey)
   {
      long   menuKeyResult;
      
      menuKeyResult = MenuKey(theEvent->message &charCodeMask);
   DoMenuSelection(HiWord(menuKeyResult),
                           LoWord(menuKeyResult));
   }                        
   else if (gTheDialogList != NULL)
   {
      // Only allocate the IndexToStringUPP once
      if (myStringGetter == NULL)
      {
         // This call-back function is used by Type Selection to
         // fetch elements of the list the user is navigating.
         myStringGetter =
                        NewIndexToStringUPP(GetStringFromIndex);      
      }      

      // Ask Type Select APIs whether we need to re-check
      // the selection
      if (TypeSelectNewKey(theEvent, &gTypeSelectState))
      {
         short            listCount;
         short            newListIndex = 0;
         Cell               newSelection;
         
         // How many items are we dealing with?
         listCount = (**gTheDialogList).dataBounds.bottom;
         
         // Ask Type Select for a new index, based
         // on the current state of typing
         newListIndex = TypeSelectFindItem(&gTypeSelectState,
                                       listCount, tsNormalSelectMode,
                                       myStringGetter, NULL);
         
         // Unset any selected items before choosing
         // a new selection
         SetPt(&newSelection, 0, 0);                              
         // Starting at the beginning, get a selected cell
      while (LGetSelect(true, &newSelection, gTheDialogList))
         {
            // Unselect it
            LSetSelect(false, newSelection, gTheDialogList);
         }
         
         // Set the new item to selected
         SetPt(&newSelection, 0, newListIndex - 1);
         LSetSelect(true, newSelection, gTheDialogList);      
         
         // Auto scroll to make sure the selection is visible
         LAutoScroll(gTheDialogList);
         
         // Workaround to List Box control behavior - LsetSelect
         // causes an immediate redraw into the list's port,
         // which in the ListBox control case is an offscreen
         // buffer allocated by the control manager, and doesn't
         // cause an update event to be generated for the parent
         // window, so we need to force a redraw.
         DrawOneDialogItem(gTheDialog, rDialogListBoxItem);         
      }
   }
}



One of the parameters to the TypeSelectFindItem call is a callback routine that you provide to allow TypeSelection to determine the elements of the list it is choosing from. Depending on the circumstances of your implementation, the items you are selecting from might not be a straightforward list. In our case the routine is quite simple. It simply looks up the desired index in the list control we are searching in:

Listing 3: GetStringFromIndex

GetStringFromIndex

Callback routine for the type selection routine TypeSelectFindItem(). This routine is called to fetch the items in a list, and determines which of the items is the best choice considering the key strokes that have been pressed.

pascal Boolean
GetStringFromIndex(short theIndex, ScriptCode *whichScript,
                           StringPtr *whichString, void *ignored)
{
#pragma unused (ignored)
   Boolean            returnValue;
   static Str255   thisString;      // static because we return a
                                       // pointer to this string
   
   // Set the script - in this sample, we know that
   // all the list items are in Roman script.
   *whichScript = smRoman;
   
   if (gTheDialogList != NULL)
   {
      Cell   desiredCell;
      short   stringLength = 255;
      
      // Fetch the item from the list, 

      // and get the cell data (a string) into the result

      SetPt(&desiredCell, 0, theIndex - 1);      
      LGetCell(thisString + 1, &stringLength, desiredCell, 
                     gTheDialogList);
      thisString[0] = stringLength;
      *whichString = thisString;
      returnValue = true;

   }
   else
   {
      *whichString = NULL;
      returnValue = false;   
   }
   
   return returnValue;
}

Summary

Type selection is certainly not the top selling point of Carbon. The APIs I have described would have been appreciated if they were publicized years ago in the classic Mac OS arena, but at least they have finally arrived in Carbon. I hope this article has demonstrated that it's not difficult at all to implement this functionality, and that the benefits to the customer are overwhelming. I hope to see all of your applications sporting fancy new type selection capabilities in their next releases. Happy typing!

Acknowledgements

Thanks to Darren Litzinger for reviewing this article.


The type selection APIs consist of only four routines and one callback routine. Here is a short description of their functionality:

TypeSelectClear

Used to initialize a TypeSelectRecord, which is the data structure that holds the state of type selection at any given time. Call this routine at least once, when your application is starting up. After you launch, only call this routine if you want to intentionally void the typing the user has made at a given point.

void         TypeSelectClear(TypeSelectRecord *tsr);

tsr   Points to a TypeSelectRecord, which requires initialization.

TypeSelectNewKey

Every time your application receives a keyDown event that might pertain to selection of a list item, you should pass the event to this routine. It examines the current buffer of characters and the value of the key event it is receiving, and returns true if the new keystroke has warranted the need to update the active list selection.

Boolean   TypeSelectNewKey(const EventRecord *theEvent,
                                    TypeSelectRecord *tsr);

theEvent   A pointer to an event record containing a keyDown event. 

tsr   Points to a TypeSelectRecord previously initialized with TypeSelectClear.

TypeSelectFindItem

When TypeSelectNewKey returns true, use this routine to actually determine the most appropriate list item to receive the new selection. This routine takes as a parameter a callback function that you use to supply the algorithm with the contents of your list.

short       TypeSelectFindItem(const TypeSelectRecord *tsr,
                                    short listSize, TSCode selectMode,
                                    IndexToStringUPP getStringProc,
                                    void *yourDataPtr);

tsr   Points to a TypeSelectRecord previously initialized with TypeSelectClear.

listSize The number of items in the list you are selecting from. If the number of items is unknown, pass 0x7FFF, and be sure that your callback function returns false when a requested index is not found.

selectMode Specify one of "tsPreviousSelectMode", "tsNormalSelectMode", or "tsNextSelectMode" to request the item before the matched item, the matched item itself, or the item after the matched item. The previous and next modes are what the Finder uses to respond to the Tab and Cmd-Tab keys. Typically you will pass tsNormalSelectMode.

getStringProc   Pass a UPP to a routine that will fetch strings by index from
the list of items you are selecting from.

yourDataPtr   Pass any value you would like to have passed back to your callback
function.

TypeSelectCompare

TypeSelectCompare is used to compare specific items from a list, using the exact same comparison that TypeSelect would use in a call to TypeSelectFindItem. This is useful if you have a sorted list, and want to optimize item selection based on knowledge about the sorting in the list. TypeSelectFindItem compares each and every item in a list, so for very long lists pre-sorting and using TypeSelectCompare might result in a performance gain.

short       TypeSelectCompare(const TypeSelectRecord * tsr,
                                    ScriptCode testStringScript,
                                    StringPtr testStringPtr);      

tsr   Points to a TypeSelectRecord previously initialized with TypeSelectClear.

testStringScript   Indicates the script of the string that is being compared.

testStringPtr   Points to the string that is being compared.

MyIndexToStringProc

This routine is defined by your code, and serves as an access point for TypeSelection to determine the items of the list that you are selecting from. When called, you will need to fetch and return a string from your list that is indexed by the given item number. You must return both a pointer to the string and the script code for that item.

Boolean   MyIndexToStringProc(short item, 
                                    ScriptCode *itemsScript,
                                    StringPtr *itemsStringPtr,
                                    void *yourDataPtr);

item   The index of the list item being requested.

itemsScript   You return the script of the requested string here.

itemsStringPtr   You return a pointer to the requested string here.

yourDataPtr   A reference pointer for whatever you choose.

Daniel Jalkut is a software engineer in the Mac OS X Carbon API group at Apple Computer. In his spare time, Daniel works on his guitar playing and book reading. You can contact him at jalkut@red-sweater.com, or view his home page at http://www.red-sweater.com.

 
AAPL
$100.87
Apple Inc.
+0.34
MSFT
$44.96
Microsoft Corpora
-0.37
GOOG
$584.46
Google Inc.
-2.40

MacTech Search:
Community Search:

Software Updates via MacUpdate

Tidy Up 3.0.15.0 - Find duplicate files...
Tidy Up is a complete duplicate finder and disk-tidiness utility. With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator, extension, time... Read more
Parallels Desktop 10.0 - Run Windows app...
Parallels Desktop is simply the world's bestselling, top-rated, and most trusted solution for running Windows applications on your Mac. With Parallels Desktop for Mac, you can seamlessly run both... Read more
Apple Final Cut Pro X 10.1.3 - Professio...
Apple Final Cut Pro X is a professional video editing solution.Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more
Apple Compressor 4.1.3 - Adds power and...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Powerful... Read more
Chromium 36.0.1985.143 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Macgo Blu-ray Player 2.10.6.1691 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple Motion 5.1.2 - Create and customiz...
Apple Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time... Read more
A Better Finder Rename 9.39 - File, phot...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
PopChar X 6.6 - 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
MacUpdate Desktop 6.0.2 - Install Mac ap...
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

Latest Forum Discussions

See All

Cubic Castles Review
Cubic Castles Review By Rob Thomas on August 20th, 2014 Our Rating: :: CASTLE CRAFTINGiPad Only App - Designed for the iPad Some ridiculously frustrating camera issues aside, Cubic Castles is a pretty neat, voxel-based crafting... | Read more »
Space Colors – Tips, Tricks, Strategies,...
Hello Cadets: Want to know what we thought about this hectic space combat/roguelike? Check out our Space Colors review! Space Colors is a cool shooter/roguelike from Team Chaos. You travel from planet to planet across a huge galaxy and complete a... | Read more »
Tap Sports Baseball – Tips, Tricks, and...
Tap Sports Baseball is a pretty simple game to learn, but that doesn’t mean it’s an easy game to master, by any means. To start your batting career off well, we thought we’d give you the heads up on some handy tips and tricks. Hey Batter-Batter:... | Read more »
Tap Sports Baseball Review
Tap Sports Baseball Review By Jennifer Allen on August 20th, 2014 Our Rating: :: LET'S PLAY BALLUniversal App - Designed for iPhone and iPad Tap Sports Baseball is briefly fun but lacks some important features.   | Read more »
Earn to Die 2 Set to Drive in to the App...
Earn to Die 2 Set to Drive in to the App Store Later This Year Posted by Ellis Spice on August 20th, 2014 [ permalink ] Not Doppler has announced that Earn to Die 2, a sequel to their successful game | Read more »
Frontier Heroes Review
Frontier Heroes Review By Andrew Fisher on August 20th, 2014 Our Rating: :: BLAZES NO TRAILSUniversal App - Designed for iPhone and iPad Despite awesome visuals and great music, Frontier Heroes just doesn’t quite deliver enough fun... | Read more »
Echo Prime is Now on Sale for $0.99
Echo Prime is Now on Sale for $0.99 Posted by Jessica Fisher on August 20th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Star Realms Review
Star Realms Review By Andrew Fisher on August 20th, 2014 Our Rating: :: A STAR IS BORNUniversal App - Designed for iPhone and iPad Star Realms is an excellent adaptation of an outstanding deck-builder. With great visuals and an... | Read more »
This. Is. SPRINGFIELD! War comes to The...
This. Is. SPRINGFIELD! | Read more »
One Tap RPG Review
One Tap RPG Review By Campbell Bird on August 20th, 2014 Our Rating: :: DUNGEON SLIDERUniversal App - Designed for iPhone and iPad This casual arcade game introduces some very light rpg elements into its fantasy-themed pachinko... | Read more »

Price Scanner via MacPrices.net

Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Best Buy’s College Student Deals: $100 off Ma...
Take an additional $100 off all MacBooks and iMacs, $50 off iPad Airs and iPad minis, at Best Buy Online with their College Students Deals Savings, valid through September 6th. Anyone with a valid .... Read more
MacBook Airs on sale for $100 off MSRP, free...
B&H Photo has three 2014 MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for Laptops... Read more
Razer Taipan Mouse For Gamers And Non-Gamers...
If you’re a serious gamer on either Mac or Windows PCs, a serious gaming mouse is a necessity for first-tier performance. However, even if like me you’re not much of a gamer, there’s still a strong... Read more
15-inch 2.2GHz MacBook Pro on sale for $1899,...
Adorama has the new 15″ 2.2GHz Retina MacBook Pro on sale for $1899 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP, and it’s the lowest price available for this... Read more
Mid-Size Tablet Shootout Posted: iPad mini wi...
I ‘m curious about how many iPads Apple is actually selling these days. It’s been widely rumored and anticipated that new models with A8 SoCs, 2 GB of RAM, 8 megapixel cameras, and fingerprint... Read more
The 15 Biggest iPad Air Problems And How To A...
What’s this? Fifteen “biggest” problems with the iPad Air? Does that mean there are a lot of smaller problems as well? Say it isn’t so! My old iPad 2 has manifested no hardware problems in three... Read more
TYLT Syncable-Duo, 2-in-1 USB Cable With Appl...
TYLT has introduced the Syncable-Duo, a universal cable solution for charging and syncing data to smartphones and tablets. The Syncable-Duo eliminates the need for multiple cables by incorporating... Read more
Save up to $140 off MSRP with Apple refurbish...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
2.5GHz Mac mini on sale for $549, save $50
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more

Jobs Board

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* Solutions Consultant - Apple (United...
**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
Position Opening at *Apple* - Apple (United...
**Job Summary** Being a Business Manager at an Apple Store means you're the catalyst for businesses to discover and leverage the power, ease, and flexibility of Apple Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.