Retired Document
Important: This sample code may not represent best practices for current development. The project may use deprecated symbols and illustrate technologies and techniques that are no longer recommended.
3_Carbon_Events/ExamplePrefs.c
/* |
File: ExamplePrefs.c |
Abstract: Demo program showing how the custom Icon List Definition function might |
be used in creating a Preferences window/dialog. |
Version: 3.0 |
Change History: |
<3.0> converted to RunApplicationEventLoop for Carbon |
much of this file has been separated into Classic and |
Carbon code |
added appEventHandler to support Carbon Events |
<2.0> Carbonized |
added RunningInMacOSX to support the Aqua appearance |
<1.0> first release version, this is totally Mac OS 8.6-savvy |
it's kind of cheating but we decided to use Carbon Event |
HI Command IDs even though we're not using Carbon Events |
(or Carbon for that matter) |
© Copyright 2005 Apple Computer, Inc. All rights reserved. |
IMPORTANT: This Apple software is supplied to |
you by Apple Computer, Inc. ("Apple") in |
consideration of your agreement to the following |
terms, and your use, installation, modification |
or redistribution of this Apple software |
constitutes acceptance of these terms. If you do |
not agree with these terms, please do not use, |
install, modify or redistribute this Apple |
software. |
In consideration of your agreement to abide by |
the following terms, and subject to these terms, |
Apple grants you a personal, non-exclusive |
license, under Apple's copyrights in this |
original Apple software (the "Apple Software"), |
to use, reproduce, modify and redistribute the |
Apple Software, with or without modifications, in |
source and/or binary forms; provided that if you |
redistribute the Apple Software in its entirety |
and without modifications, you must retain this |
notice and the following text and disclaimers in |
all such redistributions of the Apple Software. |
Neither the name, trademarks, service marks or |
logos of Apple Computer, Inc. may be used to |
endorse or promote products derived from the |
Apple Software without specific prior written |
permission from Apple. Except as expressly |
stated in this notice, no other rights or |
licenses, express or implied, are granted by |
Apple herein, including but not limited to any |
patent rights that may be infringed by your |
derivative works or by other works in which the |
Apple Software may be incorporated. |
The Apple Software is provided by Apple on an "AS |
IS" basis. APPLE MAKES NO WARRANTIES, EXPRESS OR |
IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED |
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY |
AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING |
THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE |
OR IN COMBINATION WITH YOUR PRODUCTS. |
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY |
SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL |
DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS |
OF USE, DATA, OR PROFITS; OR BUSINESS |
INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, |
REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF |
THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER |
UNDER THEORY OF CONTRACT, TORT (INCLUDING |
NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN |
IF APPLE HAS BEEN ADVISED OF THE POSSIBILITY OF |
SUCH DAMAGE. |
*/ |
#include "ExamplePrefs.h" |
#include "Help.h" |
#include "IconListUtilities.h" |
#include "PrefsDialog.h" |
#include "PrefsWindow.h" |
#if TARGET_API_MAC_OS8 // additional includes for this file under Classic |
#include <AEDataModel.h> |
#include <AEInteraction.h> |
#include <Appearance.h> |
#include <AppleEvents.h> |
#include <Balloons.h> |
#include <CarbonEvents.h> |
#include <Controls.h> |
#include <Devices.h> |
#include <Dialogs.h> |
#include <DiskInit.h> |
#include <Events.h> |
#include <Fonts.h> |
#include <MacErrors.h> |
#include <MacMemory.h> |
#include <MacWindows.h> |
#include <Processes.h> |
#include <Quickdraw.h> |
#include <Sound.h> |
#include <TextEdit.h> |
#include <ToolUtils.h> |
#include <limits.h> |
#endif |
static Boolean gMacOSX; |
static AEEventHandlerUPP gOpenAppAEHandler; |
static AEEventHandlerUPP gQuitAppAEHandler; |
static AEEventHandlerUPP gViewsFontChangedAEHandler; |
#if TARGET_API_MAC_OS8 |
static Boolean gDone; |
#else |
static EventHandlerUPP gAppEventHandler; |
#endif |
static void initialize(void); |
#if TARGET_API_MAC_OS8 |
static void handleEvents(EventRecord *event); |
static void doIdleProcessing(void); |
#else |
static pascal OSStatus appEventHandler(EventHandlerCallRef nextHandler, EventRef event, |
void *junk); |
#endif |
static pascal OSErr openApplicationAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon); |
static pascal OSErr quitApplicationAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon); |
static pascal OSErr viewsFontChangedAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon); |
// -------------------------------------------------------------------------------------- |
int main(void) |
{ |
WindowRef window; |
initialize(); // initialization |
#if TARGET_API_MAC_OS8 |
gDone = false; |
while (!gDone) // application event loop |
{ |
EventRecord event; |
if (WaitNextEvent(everyEvent, &event, ULONG_MAX, NULL)) |
{ |
if (IsDialogEvent(&event)) |
HandleDialogEvents(&event); |
else |
handleEvents(&event); |
} |
else |
doIdleProcessing(); |
} |
#else |
RunApplicationEventLoop(); |
#endif |
// finalization |
for (window = FrontNonFloatingWindow(); window != NULL; window = FrontNonFloatingWindow()) |
{ |
if (GetWindowKind(window) == kDialogWindowKind) |
ClosePrefsDialog(GetDialogFromWindow(window)); |
else // kApplicationWindowKind |
ClosePrefsWindow(window); |
} |
DisposeAEEventHandlerUPP(gOpenAppAEHandler); |
DisposeAEEventHandlerUPP(gQuitAppAEHandler); |
DisposeAEEventHandlerUPP(gViewsFontChangedAEHandler); |
#if TARGET_API_MAC_CARBON |
DisposeEventHandlerUPP(gAppEventHandler); |
#endif |
return 0; |
} |
// -------------------------------------------------------------------------------------- |
static void initialize(void) |
{ |
MenuBarHandle menuBar; |
OSErr error; |
#if TARGET_API_MAC_OS8 |
MoreMasters(); // I doubt we actually need any extra master pointers |
InitGraf(&qd.thePort); // but I left the calls here as a reminder for where they |
InitFonts(); // belong if they are needed |
InitWindows(); |
InitMenus(); |
TEInit(); |
InitDialogs(NULL); |
#else |
MoreMasterPointers(64); // each call to MoreMasters allocates 64 master pointers |
#endif |
InitCursor(); |
RegisterAppearanceClient(); |
menuBar = GetNewMBar(rMenuBar); // draw the menu bar as soon as possible |
if (menuBar == NULL) |
ExitToShell(); |
SetMenuBar(menuBar); |
DrawMenuBar(); |
// do non time sensitive initialization after we get the application event loop going |
gOpenAppAEHandler = NewAEEventHandlerUPP(openApplicationAEHandler); |
error = AEInstallEventHandler(kCoreEventClass, kAEOpenApplication, gOpenAppAEHandler, 0, |
false); |
if (error != noErr) |
ExitToShell(); |
/* If we supported them, we would install open documents and print documents |
handlers here and we would do most of the same initialization stuff that we |
do in the open application handler. */ |
#if TARGET_API_MAC_OS8 |
FlushEvents(everyEvent, 0); |
#endif |
} |
#if TARGET_API_MAC_OS8 |
// -------------------------------------------------------------------------------------- |
static void handleEvents(EventRecord *event) |
{ |
WindowRef window; |
Boolean activate; |
WindowPartCode partCode; |
OSErr error; |
Rect tempRect, newSize; |
long menuChoice; |
MenuCommand commandID; |
switch (event->what) // handle events according to the priority determined by the system |
{ |
case activateEvt: |
window = (WindowRef)event->message; |
activate = (event->modifiers & activeFlag) != 0; |
HandleActivate(window, activate); |
break; |
case mouseDown: |
partCode = FindWindow(event->where, &window); |
switch(partCode) |
{ |
case inMenuBar: |
menuChoice = MenuSelect(event->where); |
error = GetMenuItemCommandID(GetMenuRef(HiWord(menuChoice)), |
LoWord(menuChoice), &commandID); |
if (error == noErr) |
{ |
if (commandID == 0) // if the menu item clicked on does not have a |
commandID = (MenuCommand)menuChoice; // command ID |
HandleMenuChoice(commandID); |
} |
break; |
case inSysWindow: // system window clicks are automatically handled in Carbon |
if (window != NULL) |
SystemClick(event, window); |
break; |
case inContent: // the following window part codes will only be returned |
if (window != FrontWindow()) // for the preferences window |
SelectWindow(window); |
else |
HandleContentClick(window, event->where, event->modifiers); |
break; |
case inDrag: |
GetRegionBounds(GetGrayRgn(), &tempRect); |
DragWindow(window, event->where, &tempRect); |
break; |
case inGrow: |
SetRect(&tempRect, kPrefsWindowPlatinumWidth, kPrefsWindowPlatinumHeight, |
SHRT_MAX, SHRT_MAX); |
ResizeWindow(window, event->where, &tempRect, &newSize); |
AdjustControls(window); |
break; |
case inGoAway: |
ClosePrefsWindow(window); |
break; |
} |
break; |
case keyDown: |
case autoKey: // a separate auto key handler would go after disk events |
if ((event->modifiers & cmdKey) != 0) |
{ |
UInt32 keyMenuChoice; |
keyMenuChoice = MenuEvent(event); |
error = GetMenuItemCommandID(GetMenuRef(HiWord(keyMenuChoice)), |
LoWord(keyMenuChoice), &commandID); |
if (error == noErr) |
{ |
if (commandID == 0) // if the menu item chosen does not have a command |
commandID = (MenuCommand)keyMenuChoice; // ID (but they all should) |
HandleMenuChoice(commandID); |
} |
} |
else |
{ |
window = FrontNonFloatingWindow(); |
if (window != NULL) |
{ |
char keyCode = (event->message & keyCodeMask) >> 8; |
HandleKeyDown(keyCode, window); |
} |
} |
break; |
case diskEvt: // disk events aren't sent in Carbon |
if (HiWord(event->message) != noErr) |
{ |
Point where; |
SetPt(&where, 70, 50); |
ShowCursor(); |
DIBadMount(where, event->message); |
} |
break; |
case updateEvt: |
window = (WindowRef)event->message; |
SetPortWindowPort(window); |
BeginUpdate(window); |
HandleDrawContent(window); |
EndUpdate(window); |
break; |
case kHighLevelEvent: // an OS Event handler would go before high level events |
AEProcessAppleEvent(event); |
break; |
} |
} // handleEvents |
// -------------------------------------------------------------------------------------- |
static void doIdleProcessing(void) |
{ |
WindowRef frontWindow; |
frontWindow = FrontNonFloatingWindow(); |
if (frontWindow != NULL) |
{ |
IdleControls(frontWindow); |
if ( (GetWindowKind(frontWindow) == kApplicationWindowKind) && HMGetBalloons() ) |
DisplayHelpBalloons(frontWindow); |
} |
} |
#else // TARGET_API_MAC_CARBON |
// -------------------------------------------------------------------------------------- |
static pascal OSStatus appEventHandler(EventHandlerCallRef nextHandler, EventRef event, |
void *junk) |
{ |
#pragma unused (nextHandler, junk) |
OSStatus result = eventNotHandledErr; |
UInt32 eventClass, eventKind; |
HICommand command; |
eventClass = GetEventClass(event); |
eventKind = GetEventKind(event); |
switch (eventClass) |
{ |
case kEventClassCommand: |
switch (eventKind) |
{ |
case kEventCommandProcess: |
GetEventParameter(event, kEventParamDirectObject, typeHICommand, NULL, |
sizeof(HICommand), NULL, &command); |
if (command.commandID != kHICommandQuit) // let the Quit Application |
{ // Apple Event handler take care of Quit commands |
MenuCommand commandID; |
if (command.commandID != 0) |
commandID = command.commandID; |
else // if the command doesn't have a commandID |
{ |
MenuID menuID; |
long menuChoice; |
menuID = GetMenuID(command.menu.menuRef); |
menuChoice = ((long)menuID << 16) + command.menu.menuItemIndex; |
commandID = (MenuCommand)menuChoice; |
} |
HandleMenuChoice(commandID); |
result = noErr; |
} |
break; |
} |
break; |
} |
return result; |
} |
#endif // TARGET_API_MAC_OS8 |
// -------------------------------------------------------------------------------------- |
void HandleMenuChoice(MenuCommand commandID) |
{ |
MenuID menuID; |
MenuItemIndex menuItem; |
Str255 itemName; |
short daDriverRefNum; |
switch (commandID) |
{ |
case kHICommandAbout: |
SysBeep(30); |
break; |
case kHICommandClose: |
ClosePrefsWindow(FrontNonFloatingWindow()); |
break; |
#if TARGET_API_MAC_OS8 // in Carbon we are handling this in the |
case kHICommandQuit: // Quit Application Apple Event handler |
gDone = true; |
break; |
#endif |
case kCommandPrWin: |
OpenPrefsWindow(); |
break; |
case kCommandPrDlg: |
OpenPrefsDialog(); |
break; |
default: // there isn't a command ID; the commandID parameter is actually a |
menuID = HiWord((long)commandID); // MenuID:MenItemIndex structure |
menuItem = LoWord((long)commandID); |
switch (menuID) |
{ |
#if TARGET_API_MAC_OS8 // we handled the About item above, the other Apple Menu Items |
case mAppleApplication: // are automatically handled in Carbon |
GetMenuItemText(GetMenuRef(menuID), menuItem, itemName); |
daDriverRefNum = OpenDeskAcc(itemName); |
break; |
#else |
#pragma unused (itemName, daDriverRefNum) |
#endif |
} |
} |
HiliteMenu(0); |
} |
#pragma mark - |
// -------------------------------------------------------------------------------------- |
static pascal OSErr openApplicationAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon) |
{ |
OSErr error; |
DescType returnedType; |
Size actualSize; |
error = AEGetAttributePtr(appleEvent, keyMissedKeywordAttr, typeWildCard, &returnedType, |
NULL, 0, &actualSize); |
if (error == noErr) |
error = errAEParamMissed; |
else if (error == errAEDescNotFound) |
{ |
MenuRef menu; |
long response; |
EventTypeSpec applicationEvents[] = { |
{kEventClassCommand, kEventCommandProcess} |
}; |
/* For our program running in Carbon, a Quit Application Apple Event handler |
is unnecessary because RunApplicationEventLoop installs one for us that |
calls QuitApplicationEventLoop. However we will leave ours here in case |
we ever need it to do something different so that we know where it |
belongs. */ |
gQuitAppAEHandler = NewAEEventHandlerUPP(quitApplicationAEHandler); |
error = AEInstallEventHandler(kCoreEventClass, kAEQuitApplication, gQuitAppAEHandler, |
0, false); |
if (error != noErr) // if we can't allow the user a mechanism to quit |
{ // we'd better just quit right now |
DisposeAEEventHandlerUPP(gOpenAppAEHandler); |
DisposeAEEventHandlerUPP(gQuitAppAEHandler); |
ExitToShell(); |
} |
gViewsFontChangedAEHandler = NewAEEventHandlerUPP(viewsFontChangedAEHandler); |
error = AEInstallEventHandler(kAppearanceEventClass, kAEViewsFontChanged, |
gViewsFontChangedAEHandler, 0, false); |
#if TARGET_API_MAC_OS8 // manually set up the Apple menu in Classic |
#pragma unused (reply, refcon, response, applicationEvents) |
menu = GetMenuRef(mAppleApplication); |
AppendResMenu(menu,'DRVR'); |
gMacOSX = false; |
#else // the Apple menu is automatically set up in Carbon |
#pragma unused (reply, refcon) |
error = Gestalt(gestaltMenuMgrAttr, &response); |
if ( (error == noErr) && (response & gestaltMenuMgrAquaLayoutMask) ) |
{ |
StringHandle aboutString; |
menu = GetMenuRef(mAppleApplication); |
aboutString = GetString(rXAboutString); |
SetMenuItemText(menu, iAbout, *aboutString); // get rid of the "..." |
ReleaseResource((Handle)aboutString); // if we're running in OS X |
menu = GetMenuRef(mFile); |
ChangeMenuAttributes(menu, kMenuAttrAutoDisable, 0); |
DeleteMenuItem(menu, iQuit); // remove the Quit item and separator |
DeleteMenuItem(menu, iQuitSeparator); // if we're running in OS X |
gMacOSX = true; |
} |
else |
gMacOSX = false; |
gAppEventHandler = NewEventHandlerUPP(appEventHandler); |
InstallApplicationEventHandler(gAppEventHandler, GetEventTypeCount(applicationEvents), |
applicationEvents, NULL, NULL); |
#endif |
ClearIconsAreRegistered(); |
error = noErr; |
} |
return error; |
} |
// -------------------------------------------------------------------------------------- |
static pascal OSErr quitApplicationAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon) |
{ |
#pragma unused (reply, refcon) |
OSErr error; |
DescType returnedType; |
Size actualSize; |
error = AEGetAttributePtr(appleEvent, keyMissedKeywordAttr, typeWildCard, &returnedType, |
NULL, 0, &actualSize); |
if (error == noErr) |
error = errAEParamMissed; |
else if (error == errAEDescNotFound) |
{ |
#if TARGET_API_MAC_OS8 |
gDone = true; |
#else |
QuitApplicationEventLoop(); |
#endif |
error = noErr; |
} |
return error; |
} |
// -------------------------------------------------------------------------------------- |
static pascal OSErr viewsFontChangedAEHandler(const AppleEvent *appleEvent, AppleEvent *reply, |
long refcon) |
{ |
#pragma unused (reply, refcon) |
OSErr error; |
DescType returnedType; |
Size actualSize; |
error = AEGetAttributePtr(appleEvent, keyMissedKeywordAttr, typeWildCard, &returnedType, |
NULL, 0, &actualSize); |
if (error == noErr) |
error = errAEParamMissed; |
else if (error == errAEDescNotFound) |
{ |
WindowRef window; |
for (window = FrontNonFloatingWindow(); window != NULL; window = GetNextWindow(window)) |
{ |
if (GetWindowKind(window) == kDialogWindowKind) |
RedrawPrefsDialogList(GetDialogFromWindow(window)); |
else // kApplicationWindowKind |
RedrawPrefsWindowList(window); |
} |
error = noErr; |
} |
return error; |
} |
#pragma mark - |
// -------------------------------------------------------------------------------------- |
Boolean RunningInMacOSX(void) |
{ |
return gMacOSX; |
} |
// -------------------------------------------------------------------------------------- |
void GetWindowDeviceDepthAndColor(WindowRef inWindow, short *outPixelSize, |
Boolean *outIsColorDevice) |
{ |
Rect contentRect; |
GDHandle device; |
GetWindowBounds(inWindow, kWindowContentRgn, &contentRect); |
device = GetMaxDevice(&contentRect); |
*outPixelSize = (*(*device)->gdPMap)->pixelSize; |
if (BitTst(&(*device)->gdFlags, gdDevType)) |
*outIsColorDevice = true; |
else |
*outIsColorDevice = false; |
} |
Copyright © 2006 Apple Computer, Inc. All Rights Reserved. Terms of Use | Privacy Policy | Updated: 2006-07-25