TweetFollow Us on Twitter

Multifile Dialogs in CPX

Volume Number: 13 (1997)
Issue Number: 7
Column Tag: Toolbox Essentials

Creating Multi-File Dialogs in CPX

by John Shackelford, Tangent Systems

How to build a custom file dialog with CustomGetFile and how to manage the dialog callback routines


The ease that applications are built in CPX often masks the flexibility of writing low-level code for the Macintosh. Prograph CPX ships with a class library called Application Building Classes (ABCs) which, in the world of Macintosh application frameworks, ranks among the richest. However, one particularly useful chunk of code that you will not find in the ABCs is the fancy file dialog you create using CustomGetFile.

You use the CustomGetFile feature to add source files to projects in several popular Macintosh applications like CodeWarrior, Roaster or Symantec Project Manager. The File classes in the ABCs all use the Standard GetFile dialog to retrieve files. This is fine for single file operations, but if your application must provide the ability to manipulate several files at once, CustomGetFile must be used to add controls for collecting the list of files. Surprisingly, when I wrote the code for a CPX version of CustomGetFile, it was difficult to find a complete example in C or Pascal on which to base the design. I did find some chunks or pieces in C and some CPX that I used as a basis for MultiFile.

MultiFile is a CPX section. It provides a class for a multifile dialog of the type shown below. It allows you to navigate, add and subtract several files all in one dialog session. The section also provides a basic file dialog allowing you to specify the user prompt. However, this article focuses on MultiFile Dialog -- it shows you how to use the MultiFile Dialog class and discusses key code snippets.

MultiFile Demo Application

The demo application opens a MultiFile Dialog and allows you to add and subtract files. Its purpose is to demonstrate what a MultiFile Dialog provides (see Figure 1). The demo application is one of those minimal apps. It does not use the ABCs and has no value other than showing you how the MultiFile Dialog looks.

Figure 1. The Demo Application opens a MultiFile Dialog.

The Macintosh Toolbox provides a function called CustomGetFile for creating custom file dialogs. First, I'll show you the top level CPX code for using it. That way, if all you want is to use MultiFile and you don't care about how it works, you'll have all you need to know. I will also show the function prototype and build up the associated functions for it in CPX.

Figure 2. The MultiFile section comes with an example method for using MultiFile.

Using MultiFile is pretty straightforward -- explaining it will be much more difficult. However, as you can see in Figure 2, all you do is create an instance of MultiFile Dialog, setup the type of files you want with the message "/setTypeList" and finally send the message "/multiFileGet" to get the whole process rolling. When the method completes, the list of selected files appears on the output of "/multiFileGet."

How it All Works

I'll first decompose the main method "/multiFileGet," describe the attributes of MultiFile Dialog and then expose in detail the major chunks of code that makes MultiFile Dialog work in support of CustomGetFile -- the Toolbox call we are encapsulating.

MultiFile Dialog Constructor

The first thing to look at is the constructor for MultiFile Dialog (Figure 3). When an instance of MultiFile Dialog is created, several attributes are initialized. The "Files" attribute will end up holding a new instance of File Results. This object will eventually hold the FSSpecs for the selected files, and it provides methods to add and remove FSSpecs from its internal list of FSSpecs. The attribute "Select List" is set to NULL. Eventually, it will hold a pointer to the scroll list item created by a call to LNew. The Persistent called "The Dialog" is set to the current MultiFile Dialog instance. Two other methods are executed -- one creates a Standard File Reply record while the other ("/makeCallbacks") sets up pointers to the callback functions. So by design a "The Dialog" (global) holds the MultiFile Dialog instance. Everything else hangs off of that -- the lower scroll list, StandardReplyRec and the File Results object. The callbacks rely on "The Dialog" to access the scroll list, the File Results object and the StandardReplyRec.

Figure 3. The "Constructor" for MultiFile Dialog sets up 3 Persistants.

The method "/makeCallbacks" (Figure 4) checks each of 4 attributes in MultiFile Dialog and creates a pointer to a callback method if a method name is specified. This provides a nice way for users of the class to specify their own callback methods -- just by specifying their own methods in the initialization list that can be fed to the Constructor. And of course if that does not provide enough flexibility, you can always subclass the whole thing and define "/makeCallbacks" anew.

Figure 4. "/makeCallbacks" checks each of 4 MultiFile Dialog attributes.

The local method "file filter proc" (Figure 5) is typical of the calls in "/makeCallbacks". An improvement on this local method would be to verify that the universal method is actually defined and if it isn't, then fail into a next case and set the "callback" attribute (in this specific case "File Filter Callback") value to NULL.

Figure 5. This local method is typical for what a "/makeCallbacks" method does.

The method "/multiFileGet" (Figure 6) is composed of three methods itself. The first performs the Toolbox call, the second retrieves the selected files and the final method cleans up.

Figure 6. "/multiFileGet" retrieves a list of file specifications.


The method "/callCustomGet" (Figure 7) makes the Toolbox call "CustomGetFile". The MultiFile Dialog instance carries the values necessary for the function to operate as the user wants.

Figure 7. "/callCustomGet" makes the low level Toolbox call.

Let's first look at the CustomGetFile arguments and what Prograph uses. The calling arguments for CustomGetFile are shown below (bold) with the MultiFile Dialog Attribute (underlined):

FileFilterYDProcPtr FileFilter Callback
A pointer to an optional file filter function, provided by your application, through which CustomGetFile passes files of the specified types.

short Num Types
The number of file types to be displayed. If you specify a "Num Types" value of -1, the first filtering passes files of all types.

SFTypeList /Type List
A list of file types to be displayed. You can define it using the call "/setTypeList" which automatically sets the value of attribute "Num Types" used above.

StandardFileReply * YourDataPointer
The reply record, which CustomGetFile fills in before returning. We create a pointer to a Reply record in the Constructor for MultiFile Dialog.

short DialogID
The resource ID of a customized dialog template. To use the standard template, set this parameter to 0. The MultiFile Dialog defines this value to be 1001. If you want to customize the look of the dialog, create a new dialog resource and set the DialogID to the new value in a subclass of MultiFile Dialog for the "new" dialog.

Point Where
The upper-left corner of the dialog box in global coordinates. This value is predefined to be {-1, -1} which will place it in the middle of the screen.

DlgHookYDProcPtr DialogHook Callback
A pointer to the dialog hook function, which handles item selections received from the Dialog Manager. This is in many ways the "meat" (I suppose I should instead say "fiber" for those vegetarians among us) of the matter; clicks within the dialog get handled by this method.

ModalFilterYDProcPtr ModalFilter Callback
A pointer to your modal-dialog filter function, which determines how the Dialog Manager filters events when called by CustomGetFile. Specify a value of NIL if you are not supplying your own function. We need a modal-dialog filter function because we must provide scroll control for our scrolling list. This method handles clicks in the user-defined lower scroll list. (Control of the upper list "comes" with CustomGetFile.)

short ActiveList

ActivateYDProcPtr Activate Proc Callback

void * YourDataPointer

These last three parameters are not used, and are set to NULL.

Figure 8. The default attributes are defined to work with a dialog resource 1001.

Figure 9 shows the default MultiFile dialog (ID = 1001) and the index numbers for its items.

Figure 9. Default MultiFile dialog (ID = 1001).

When CustomGetFile is called, three methods (all are Universals) take over until the user clicks "Cancel" or "Done" in the dialog window. They are "filterProc", "modalFilterYD" and "dialogHook". We'll describe each in turn.

Filter Proc Method

The "filterProc" method (Figure 10) does one job. It is called whenever the upper scroll list is about to be filled with files (after passing through the internal "types" filter). It gives us a chance to do further processing. The output of this method is a Boolean which determines whether or not the file should appear in the upper list. A TRUE output removes the item from the upper list while a FALSE value allows it to appear in the upper list. This method checks the list of FSSpecs in the File Results object. If the file is in the File Results object, this filter will remove it from the upper list.

Figure 10. "filterProc" is called whenever the upper scroll list is about to be filled with files.

The field "ioNamePtr" holds a pointer to a Pascal string. The first byte in a Pascal string must be the length of the string. we execute "get-integer" to determine the length of the string, and then we execute "get-text" using that value and start at byte 1 of the buffer. We then check the list of file names held by the File Results object (retrieved with "getFiles"). If a matching file name is found, the primitive "(in)" will return an integer greater than 0 indicating the files position in the list. In that case the method outputs TRUE. Otherwise it will output FALSE.

Modal Filter yd Method

The "modalFilterYD" method (Figure 11) is called as part of the event processing in the window. It is needed to control scrolling of the lower scroll list (the "Select List"). It is written such that it will only handle clicks within the scroll lists vertical control.

Figure 11. "modalFilterYD" controls scrolling of the lower scroll list.

Dialog Hook Method

The "dialogHook" is the biggest of these three methods. It installs the lower scroll list the first time the method is called. It also handles all clicks in the dialog. So for example when the "Add" button is clicked, the dialog hook method defines what happens in the window.

Instead of going through every case of this method (there are 15 cases), I'll just provide an overview of what the method is supposed to do:

First Time Through -- Creates the lower scroll list and installs it in the dialog window.

Add -- Adds the filename of the selected file to lower list. The file is removed from the upper the list through the file filter function. The FSSpec for the file is added to the File Results object.

Add All -- The names of all available files in the upper scroll list are added to the lower list. The FSSpecs are added to the File Results object. All files that get successfully added to the File Results are filtered from the upper list display by the file filter method.

Remove -- Enabled if an item is selected in the lower list. The selected item is removed from the File Results object, removed from the lower list and added to the upper list by the file filter method.

Remove All -- Enabled if there are any files in lower list. All files in the File Results object are removed, all items in the lower list are removed. The file filter method then allows available files to appear in the upper list.

Cancel -- Deletes all FSSpecs from the File Results object, then closes the dialog.

Done -- Closes the dialog.

Here is the code of two interesting cases to drive home how things work: what happens the first time though -- that's when we create and install the lower scroll list -- and how Add works. I leave the other cases as a review exercise for you and your CPX Debugger.

First Time Through

The first time "dialogHook" is executed, we must detect that this is the first time and display the lower list box.

Figure 12. The First Time Through case creates the lower scroll list item.

Figure 13. "initList" creates a new scroll list and places it in the position of window item 18 in the dialog resource.

The Toolbox call "LNew" creates a new scroll list. We define the rectangle for the list by getting the rectangle for window item 18 (see Figure 9). We "send" the new scroll list to the MultiFile Dialog in the message "/setSelectList".

Add file

The Add file case duplicates the FSSpec representing the selected file and sends that FSSpec as an argument in the call to "addFile".

Figure 14. The "Add" case calls "addFile" universal.

Figure 15. "addFile" universal also enables item 19 in the dialog window.

The "addFile" universal method performs several tasks. It first checks if the file can really be added. If so, it continues on by getting the value of the name field in the FSSpec and asking the File Results object for the number of items in its files list to form an index. It send those two values (name and index) as arguments to "addCell" which adds a new cell to the "Select List". It then sends the FSSpec to the File Results object in a message "/addItem" which adds the FSSpec to the File Result object. After all that, the lower scroll list is redrawn in method "updateScrollList" and window item 19 (Remove All) is enabled.

At this point "dialogHook" case 12:15 (Figure 14) outputs "sfHookRebuildList" and the method ends. The new item now appears in the lower scroll list and disappears from the upper list. The multifile dialog window waits for the next event.


This article describes the CPX code in the MultiFile section. MultiFile contains classes for creating special file dialogs that don't come out of the box with CPX. These classes are useful if you need a file dialog that can deal with several files at once or if you want to specify a unique prompt in a standard file dialog.

With the information in this article, CPX developers can now start using CustomGetFile based file dialogs in their applications. Simply add the MultiFile section to your project, create an instance of MultiFile Dialog, and send it the message "/multiFileGet". All of your problems will be solved.

Bibliography and References

Apple Computer's Inside Macintosh: Files, page 3-51.

John Shackelford is the founder of Tangent Systems - a software development company based in San Diego. When he's not playing with his 3 children, he's busy writing CPX code or playing the piano. He can be reached at You can find Tangent Systems on the world wide web at


Community Search:
MacTech Search:

Software Updates via MacUpdate

Path Finder 7.2 - Powerful, award-winnin...
Become a master of file management with Path Finder. Take full control over your file system. Save your time: compare and synchronize folders, view hidden files, use Dual Pane and full keyboard... Read more
Sid Meier's Civilization: Beyond Ea...
Sid Meier's Civilization: Beyond Earth is a new science-fiction-themed entry into the award-winning Civilization series. Set in the future, global events have destabilized the world leading to a... Read more
ForkLift 2.6.6 - Powerful file manager:...
ForkLift is a powerful file manager and ferociously fast FTP client clothed in a clean and versatile UI that offers the combination of absolute simplicity and raw power expected from a well-executed... Read more
Microsoft Remote Desktop 8.0.21 - Connec...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
OnyX 3.1.0 - Maintenance and optimizatio...
OnyX is a multifunctional utility for OS X. It allows you to verify the startup disk and the structure of its System files, to run miscellaneous tasks of system maintenance, to configure the hidden... Read more
Spotify - Stream music, crea...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue puts... Read more
ExpanDrive - Access cloud storag...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Markly 1.5.3 - Create measurement and de...
Markly is a measurement and design-spec plugin/extension for Photoshop and Sketch. It is made for modern Web designers and app front-end developers. You can add specification marks simply by clicking... Read more
Suitcase Fusion 6 17.3.0 - Font manageme...
Suitcase Fusion 6 is the creative professional's font manager. Every professional font manager should deliver the basics: spectacular previews, powerful search tools, and efficient font organization... Read more
Nisus Writer Pro 2.1.2 - Multilingual wo...
Nisus Writer Pro is a powerful multilingual word processor, similar to its entry level products, but brings new features such as table of contents, indexing, bookmarks, widow and orphan control,... Read more

Balls & Holes - Tips and tricks to h...
Balls & Holes is a gorgeous new endless runner that challenges you to make it as far up a mountain as possible before inevitably being sliced into a load of gooey bits. Making this task more difficult are both the wide variety of balls that... | Read more »
Balloony Land offers a fresh twist on th...
Balloony Land by Palringo offers a fresh twist on the match three genre and is out now on iOS and Android. First-off, you'll be popping balloons instead of crushing candy and the balloons will float up and fill the empty spaces instead of dropping... | Read more »
Graphic - vector illustration and design...
Graphic - vector illustration and design 1.0 Device: iOS iPhone Category: Productivity Price: $2.99, Version: 1.0 (iTunes) Description: Autodesk Graphic is a powerful full-featured vector drawing and illustration application right in... | Read more »
Sago Mini Babies (Education)
Sago Mini Babies 1.0 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0 (iTunes) Description: Introducing the Sago Mini babies. Boys and girls love caring for these adorable characters. Feed Robin her favorite mush... | Read more »
PAUSE - Relaxation at your fingertip (H...
PAUSE - Relaxation at your fingertip 1.1 Device: iOS iPhone Category: Healthcare & Fitness Price: $1.99, Version: 1.1 (iTunes) Description: | Read more »
Super Sharp (Games)
Super Sharp 1.1 Device: iOS Universal Category: Games Price: $1.99, Version: 1.1 (iTunes) Description: Your finger has never been so sharp! Cut with skill to complete the 120 ingenious physics levels of Super Sharp and become a cut... | Read more »
Assembly - Graphic design for everyone...
Assembly - Graphic design for everyone 1.0 Device: iOS Universal Category: Photography Price: $2.99, Version: 1.0 (iTunes) Description: Assembly is the easiest most powerful design tool on the App Store. Create anything you can... | Read more »
Dub Dash (Games)
Dub Dash 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: ARE YOU READY FOR THE ULTIMATE CHALLENGE? UNIQUE SYMBIOSIS OF MUSIC AND GRAPHICS | Read more »
Leave Me Alone (Games)
Leave Me Alone 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: 33% off launch sale!!! Somewhere between the 1980s and 1990s there exists a world that never was. A world of skatepunks,... | Read more »
YAMGUN (Games)
YAMGUN 1.0 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: The invasion has begun! Protect the walls of the citadel against waves of enemies! But watch out, you will soon run out of ammo...... | Read more »

Price Scanner via

Apple Products Four Of 2015′s Top Ten Most Wa..., Future’s global technology brand and the UK’s biggest technology website, has unveiled results from extensive research that show • The Smart Home is what excites the public most about... Read more
13-inch 2.7GHz/128GB Retina MacBook Pro on sa...
Best Buy has the 13″ 2.7GHz/128GB Retina MacBook Pro on sale for $1174.99 for a limited time. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-... Read more
App Tamer 2.1 Makes El Capitan Cooler, Quiete...
St. Clair Software has announced the availability of a free update to its App Tamer utility for Mac OS X. App Tamer 2.1 delivers compatibility with Yosemite and improves its support for a number of... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 2015 15″ Retina MacBook Pros on sale for up to $160 off MSRP including free shipping plus NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1849.99 $150 off - 15″ 2.5GHz Retina... Read more
12-inch Retina MacBooks on sale for $100 off...
Best Buy has 12″ Retina MacBooks available for $100 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Discounted prices available for online orders only... Read more
MacBook Airs on sale for up to $100 off MSRP
Save up to $100 on the purchase of a new 2015 13″ or 11″ 1.6GHz MacBook Air at the following resellers. Shipping is free with each model: 11" 128GB MSRP $899 11" 256GB... Read more
Save 15% with Apple refurbished Mac Pros
The Apple Store has Apple Certified Refurbished Mac Pros available 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
Apple restocks refurbished Mac minis for up t...
Apple has restocked Certified Refurbished 2014 Mac minis, with models available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz Mac mini: $419 $... Read more
TP-LINK Next-Gen Routers Support a Large Numb...
TP-LINK, specialists in consumer and business networking products, have announced the availability of Archer C2600, the company’s next-generation router featuring wireless AC, multi-user MIMO, and 4-... Read more
Apple refurbished 2014 MacBook Airs available...
Apple has Certified Refurbished 2014 MacBook Airs available starting at $679. An Apple one-year warranty is included with each MacBook, and shipping is free: - 11″ 1.4GHz/128GB MacBook Air: $679... Read more

Jobs Board

Project Manager: *Apple* Pay - Apple (Unite...
…The iOS Systems team is looking for a project manager who will manage Apple Pay server side integration project resources in a matrix organization, track tasks, prepare Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're Read more
Validation Engineering Manager - *Apple* Wa...
…hardware and software development to lead the validation of the next generation Apple Watch and related products. The Validation Team works closely with many Read more
Senior Payments Architect - *Apple* Pay - A...
**Job Summary** Apple , Inc. is looking for a highly motivated, innovative and hands-on senior payments architect to join the Apple Pay Engineering team. You will Read more
*Apple* Retail for Business Support Supervis...
…is looking for a motivated, outgoing, and creative individual who wants to offer Apple Business Customers an unparalleled customer experience. The Apple Retail for Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.