Mac OS 9
LocationManager.h File Reference

LocationManager (manages groups of settings) More...

#include <AppleEvents.h>
#include <Components.h>
#include <Dialogs.h>
#include <Processes.h>
#include <StandardFile.h>

Go to the source code of this file.

Data Structures

struct  ALMScriptManagerInfo
 
struct  ALMAltScriptManagerInfo
 

Macros

#define kALMNoLocationToken   ((ALMToken)(-1))
 
#define NewALMNotificationUPP(userRoutine)
 
#define DisposeALMNotificationUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeALMNotificationUPP(theEvent, userUPP)    CALL_ONE_PARAMETER_UPP((userUPP), uppALMNotificationProcInfo, (theEvent))
 
#define NewALMNotificationProc(userRoutine)   NewALMNotificationUPP(userRoutine)
 
#define CallALMNotificationProc(userRoutine, theEvent)    InvokeALMNotificationUPP(theEvent, userRoutine)
 

Typedefs

typedef struct OpaqueALMToken * ALMToken
 
typedef Str31 ALMLocationName
 
typedef SInt16 ALMConfirmChoice
 
typedef SInt32 ALMSwitchActionFlags
 
typedef const OSType * ConstALMModuleTypeListPtr
 
typedef struct ALMScriptManagerInfo ALMScriptManagerInfo
 
typedef ALMScriptManagerInfoALMScriptManagerInfoPtr
 
typedef struct ALMAltScriptManagerInfo ALMAltScriptManagerInfo
 
typedef ALMAltScriptManagerInfoALMAltScriptManagerInfoPtr
 
typedef ALMAltScriptManagerInfoPtrALMAltScriptManagerInfoHandle
 
typedef UInt32 ALMRebootFlags
 

Enumerations

enum  { kALMLocationNameMaxLen = 31 , kALMNoLocationIndex }
 
enum  { kALMConfirmRename = 1 , kALMConfirmReplace = 2 }
 
enum  { kALMDuplicateRenameButton , kALMDuplicateReplaceButton = 2 , kALMDuplicateCancelButton = 3 , kALMDuplicatePromptText = 5 }
 
enum  { kALMRenameRenameButton , kALMRenameCancelButton = 2 , kALMRenameEditText = 3 , kALMRenamePromptText = 4 }
 
enum  { kALMDuplicateDialogRefCon = FOUR_CHAR_CODE('dupl') , kALMRenameDialogRefCon = FOUR_CHAR_CODE('rnam') }
 
enum  { uppALMNotificationProcInfo = 0x000000C0 }
 
enum  { kAELocationChangedNoticeKey , kAELocationRescanNoticeKey }
 
enum  { kALMDefaultSwitchFlags = 0x00000000 , kALMDontShowStatusWindow = 0x00000001 , kALMSignalViaAE = 0x00000002 }
 
enum  { kALMAddAllOnSimple = 0 , kALMAddAllOff = -1 }
 
enum  {
  kALMLocationSelectButton = 1 , kALMLocationCancelButton = 2 , kALMLocationBalloonHelp = 3 , kALMLocationLocationList = 7 ,
  kALMLocationLocationNameEdit = 10 , kALMLocationPromptText = 11
}
 
enum  { kALMLocationSaveButton = kALMLocationSelectButton }
 
enum  { kALMScriptInfoVersion }
 
enum  { kALMAltScriptManagerInfoRsrcType = FOUR_CHAR_CODE('trip') , kALMAltScriptManagerInfoRsrcID = 0 }
 
enum  {
  kALMNoChange = 0 , kALMAvailableNow = 1 , kALMFinderRestart = 2 , kALMProcesses = 3 ,
  kALMExtensions = 4 , kALMWarmBoot = 5 , kALMColdBoot = 6 , kALMShutdown = 7
}
 
enum  {
  kALMFileCreator , kALMComponentModuleFileType , kALMComponentStateModuleFileType , kALMComponentActionModuleFileType ,
  kALMCFMStateModuleFileType , kALMCFMActionModuleFileType
}
 
enum  { kALMComponentRsrcType = FOUR_CHAR_CODE('thng') , kALMComponentType = FOUR_CHAR_CODE('walk') }
 
enum  { kALMModuleInfoRsrcType = FOUR_CHAR_CODE('walk') , kALMModuleInfoOriginalVersion = 0 }
 
enum  { kALMMultiplePerLocation , kALMDescriptionGetsStale }
 

Functions

typedef CALLBACK_API (void, ALMNotificationProcPtr)(AppleEvent *theEvent)
 
typedef STACK_UPP_TYPE (ALMNotificationProcPtr) ALMNotificationUPP
 
ALMNotificationUPP NewALMNotificationUPP (ALMNotificationProcPtr userRoutine)
 
void DisposeALMNotificationUPP (ALMNotificationUPP userUPP)
 
void InvokeALMNotificationUPP (AppleEvent *theEvent, ALMNotificationUPP userUPP)
 
OSErr ALMGetCurrentLocation (SInt16 *index, ALMToken *token, ALMLocationName name)
 
OSErr ALMGetIndLocation (SInt16 index, ALMToken *token, ALMLocationName name)
 
OSErr ALMCountLocations (SInt16 *locationCount)
 
OSErr ALMSwitchToLocation (ALMToken newLocation, ALMSwitchActionFlags switchFlags)
 
OSErr ALMRegisterNotifyProc (ALMNotificationUPP notificationProc, const ProcessSerialNumber *whichPSN)
 
OSErr ALMRemoveNotifyProc (ALMNotificationUPP notificationProc, const ProcessSerialNumber *whichPSN)
 
OSErr ALMConfirmName (ConstStr255Param message, Str255 theName, ALMConfirmChoice *choice, ModalFilterUPP filter)
 
OSErr ALMPutLocation (ConstStr255Param prompt, ALMLocationName name, SInt16 numTypes, ConstALMModuleTypeListPtr typeList, ModalFilterYDUPP filter, void *yourDataPtr)
 
OSErr ALMGetLocation (ConstStr255Param prompt, ALMLocationName name, ModalFilterYDUPP filter, void *yourDataPtr)
 
OSErr ALMMergeLocation (ConstStr255Param prompt, ALMLocationName name, SInt16 numTypes, ConstALMModuleTypeListPtr typeList, ModalFilterYDUPP filter, void *yourDataPtr)
 

Detailed Description

LocationManager (manages groups of settings)

Introduced In: Mac OS 8
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1995-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Macro Definition Documentation

◆ NewALMNotificationUPP

#define NewALMNotificationUPP (   userRoutine)
Value:
(ALMNotificationUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppALMNotificationProcInfo, \
GetCurrentArchitecture())
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

File types and signatures... Note: auto-routing of modules will not be supported for 'thng' files...

Function Documentation

◆ ALMConfirmName()

OSErr ALMConfirmName ( ConstStr255Param  message,
Str255  theName,
ALMConfirmChoice *  choice,
ModalFilterUPP  filter 
)

ALMConfirmName()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMCountLocations()

OSErr ALMCountLocations ( SInt16 *  locationCount)

ALMCountLocations()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMGetCurrentLocation()

OSErr ALMGetCurrentLocation ( SInt16 *  index,
ALMToken *  token,
ALMLocationName  name 
)

ALMGetCurrentLocation()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMGetIndLocation()

OSErr ALMGetIndLocation ( SInt16  index,
ALMToken *  token,
ALMLocationName  name 
)

ALMGetIndLocation()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMGetLocation()

OSErr ALMGetLocation ( ConstStr255Param  prompt,
ALMLocationName  name,
ModalFilterYDUPP  filter,
void *  yourDataPtr 
)

ALMGetLocation()

Non-Carbon CFM: in Walkabout 2.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMMergeLocation()

OSErr ALMMergeLocation ( ConstStr255Param  prompt,
ALMLocationName  name,
SInt16  numTypes,
ConstALMModuleTypeListPtr  typeList,
ModalFilterYDUPP  filter,
void *  yourDataPtr 
)

ALMMergeLocation()

Non-Carbon CFM: in Walkabout 2.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMPutLocation()

OSErr ALMPutLocation ( ConstStr255Param  prompt,
ALMLocationName  name,
SInt16  numTypes,
ConstALMModuleTypeListPtr  typeList,
ModalFilterYDUPP  filter,
void *  yourDataPtr 
)

ALMPutLocation()

Non-Carbon CFM: in Walkabout 2.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMRegisterNotifyProc()

OSErr ALMRegisterNotifyProc ( ALMNotificationUPP  notificationProc,
const ProcessSerialNumber whichPSN 
)

ALMRegisterNotifyProc()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMRemoveNotifyProc()

OSErr ALMRemoveNotifyProc ( ALMNotificationUPP  notificationProc,
const ProcessSerialNumber whichPSN 
)

ALMRemoveNotifyProc()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ ALMSwitchToLocation()

OSErr ALMSwitchToLocation ( ALMToken  newLocation,
ALMSwitchActionFlags  switchFlags 
)

ALMSwitchToLocation()

Non-Carbon CFM: in Walkabout 1.0 and later
Carbon Lib: not available
Mac OS X: not available

◆ DisposeALMNotificationUPP()

void DisposeALMNotificationUPP ( ALMNotificationUPP  userUPP)

DisposeALMNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ InvokeALMNotificationUPP()

void InvokeALMNotificationUPP ( AppleEvent theEvent,
ALMNotificationUPP  userUPP 
)

InvokeALMNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available

◆ NewALMNotificationUPP()

ALMNotificationUPP NewALMNotificationUPP ( ALMNotificationProcPtr  userRoutine)

NewALMNotificationUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: not available
Mac OS X: not available