MBS Macextras Plugin.Pdf

MBS MacExtras Plugin Documentation

Christian Schmitz

September 6, 2021 2 0.1 Introduction

This is the PDF version of the documentation for the Xojo Plug-in from Monkeybread Software Germany. Plugin part: MBS MacExtras Plugin

0.2 Content

• 1 List of all topics 3 • 2 List of all classes 29 • 3 List of all controls 31 • 4 List of all modules 33 • 5 List of all global methods 35 • 6 All items in this plugin 37 • 18 List of Questions in the FAQ 231 • 19 The FAQ 241 Chapter 1

List of Topics

• 7 Apple Remote 39 – 7.1.1 class AppleRemoteMBS 39 ∗ 7.1.7 startListening 40 ∗ 7.1.8 stopListening 40 ∗ 7.1.10 ClickCountEnabledButtons as Integer 40 ∗ 7.1.11 ClickCountingEnabled as Boolean 40 ∗ 7.1.12 Handle as Integer 41 ∗ 7.1.13 ListeningOnAppActivate as Boolean 41 ∗ 7.1.14 ListeningToRemote as boolean 41 ∗ 7.1.15 MaximumClickCountTimeDifference as Double 41 ∗ 7.1.16 OpenInExclusiveMode as boolean 42 ∗ 7.1.17 ProcessesBacklog as Boolean 42 ∗ 7.1.18 RemoteAvailable as boolean 42 ∗ 7.1.19 remoteId as Integer 42 ∗ 7.1.20 SimulatesPlusMinusHold as Boolean 42 ∗ 7.1.22 ButtonPressed(ButtonID as Integer, PressedDown as boolean, clickCount as Integer) 43 ∗ 7.1.24 kRemoteButtonFullscreen2009 = 32768 43 ∗ 7.1.25 kRemoteButtonLeft = 64 43 ∗ 7.1.26 kRemoteButtonLeftHold = 256 43 ∗ 7.1.27 kRemoteButtonMenu = 8 44 ∗ 7.1.28 kRemoteButtonMenuHold = 512 44 ∗ 7.1.29 kRemoteButtonPlay = 16 44 ∗ 7.1.30 kRemoteButtonPlay2009 = 16384 44 ∗ 7.1.31 kRemoteButtonPlaySleep = 1024 44 ∗ 7.1.32 kRemoteButtonRight = 32 44 ∗ 7.1.33 kRemoteButtonRightHold = 128 45

3 4 CHAPTER 1. LIST OF TOPICS ∗ 7.1.34 kRemoteButtonVolumeMinus = 4 45 ∗ 7.1.35 kRemoteButtonVolumeMinus_Hold = 8192 45 ∗ 7.1.36 kRemoteButtonVolumePlus = 2 45 ∗ 7.1.37 kRemoteButtonVolumePlus_Hold = 4096 45 ∗ 7.1.38 kRemoteControlSwitched = 2048 45 5 • 9 Cocoa 85 – 9.1.1 class ContinuityCameraMBS 85 ∗ 9.1.9 Constructor 86 ∗ 9.1.10 Destructor 86 ∗ 9.1.11 Import(index as Integer) 87 ∗ 9.1.12 Import(index as Integer, Control as control) 87 ∗ 9.1.13 Import(index as Integer, Win as window) 87 ∗ 9.1.14 InstallForCanvas 87 ∗ 9.1.15 InstallForListbox 87 ∗ 9.1.16 InstallForWindow 88 ∗ 9.1.17 PopupMenu as NSMenuMBS 88 ∗ 9.1.18 SetDelegate(d as ContinuityCameraDelegateMBS) 88 ∗ 9.1.20 Handle as Integer 88 ∗ 9.1.22 ContinuityCameraDelegateMBS(Data as MemoryBlock, type as String) 89 6 CHAPTER 1. LIST OF TOPICS • 13 Growl 111 – 13.1.1 class GrowlApplicationBridgeMBS 111 ∗ 13.1.5 bestRegistrationDictionary as Dictionary 112 ∗ 13.1.6 Constructor 112 ∗ 13.1.7 Destructor 113 ∗ 13.1.8 frameworkInfoDictionary as Dictionary 113 ∗ 13.1.9 IsFrameworkLoaded as boolean 113 ∗ 13.1.10 isGrowlRunning as boolean 113 ∗ 13.1.11 isMistEnabled as boolean 114 ∗ 13.1.12 LoadFramework(path as folderitem) as boolean 114 ∗ 13.1.13 notificationDictionaryByFillingInDictionary(notifDict as dictionary) as Dictionary 114 ∗ 13.1.14 notifyWithDictionary(userInfo as dictionary) 115 ∗ 13.1.15 notifyWithTitle(title as string, description as string, notificationName as string, icon- Data as memoryblock = nil, Priority as Integer = 0, isSticky as boolean = false, clickContext as Variant = nil) 115 ∗ 13.1.16 notifyWithTitle(title as string, description as string, notificationName as string, icon- Data as memoryblock, Priority as Integer, isSticky as boolean, clickContext as Variant, iden- tifier as string) 116 ∗ 13.1.17 registerWithDictionary(regDict as dictionary = nil) as boolean 116 ∗ 13.1.18 registrationDictionaryByFillingInDictionary(regDict as dictionary) as Dictionary 117 ∗ 13.1.19 registrationDictionaryByFillingInDictionary(regDict as dictionary, restrictToKeys() as string) as Dictionary 118 ∗ 13.1.20 registrationDictionaryFromBundle(bundle as Variant = nil) as Dictionary 119 ∗ 13.1.21 registrationDictionaryFromDelegate as Dictionary 119 ∗ 13.1.22 reregisterGrowlNotifications 120 ∗ 13.1.24 Handle as Integer 120 ∗ 13.1.25 shouldUseBuiltInNotifications as boolean 120 ∗ 13.1.26 willRegisterWhenGrowlIsReady as boolean 121 ∗ 13.1.28 applicationIconDataForGrowl as Memoryblock 121 ∗ 13.1.29 applicationIconForGrowl as Variant 121 ∗ 13.1.30 applicationNameForGrowl as string 122 ∗ 13.1.31 growlIsReady 122 ∗ 13.1.32 growlNotificationTimedOut(clickContext as Variant) 122 ∗ 13.1.33 growlNotificationWasClicked(clickContext as Variant) 122 ∗ 13.1.34 hasNetworkClientEntitlement as boolean 123 ∗ 13.1.35 registrationDictionaryForGrowl as dictionary 123 ∗ 13.1.37 kApplicationIcon = ”ApplicationIcon” 124 ∗ 13.1.38 kApplicationId = ”ApplicationId” 124 ∗ 13.1.39 kApplicationName = ”ApplicationName” 124 ∗ 13.1.40 kApplicationPID = ”ApplicationPID” 125 ∗ 13.1.41 kGrowlNotificationIdentifier = ”GrowlNotificationIdentifier” 125 7 ∗ 13.1.42 kNotificationAppIcon = ”NotificationAppIcon” 125 ∗ 13.1.43 kNotificationClickContext = ”NotificationClickContext” 126 ∗ 13.1.44 kNotificationDescription = ”NotificationDescription” 126 ∗ 13.1.45 kNotificationIcon = ”NotificationIcon” 126 ∗ 13.1.46 kNotificationName = ”NotificationName” 127 ∗ 13.1.47 kNotificationPriority = ”NotificationPriority” 127 ∗ 13.1.48 kNotificationProgress = ”NotificationProgress” 127 ∗ 13.1.49 kNotificationsAll = ”AllNotifications” 127 ∗ 13.1.50 kNotificationsDefault = ”DefaultNotifications” 128 ∗ 13.1.51 kNotificationsDescriptions = ”NotificationDescriptions” 128 ∗ 13.1.52 kNotificationsHumanReadableNames = ”HumanReadableNames” 128 ∗ 13.1.53 kNotificationSticky = ”NotificationSticky” 129 ∗ 13.1.54 kNotificationTitle = ”NotificationTitle” 129 ∗ 13.1.55 kTicketVersion = ”TicketVersion” 129 8 CHAPTER 1. LIST OF TOPICS • 14 iTunes 131

– 14.1.1 class iTunesLibraryAlbumMBS 131 ∗ 14.1.3 Constructor 131 ∗ 14.1.5 AlbumArtist as String 131 ∗ 14.1.6 Artist as iTunesLibraryArtistMBS 132 ∗ 14.1.7 Compilation as Boolean 132 ∗ 14.1.8 DiscCount as Integer 132 ∗ 14.1.9 DiscNumber as Integer 132 ∗ 14.1.10 Gapless as Boolean 132 ∗ 14.1.11 Handle as Integer 133 ∗ 14.1.12 Rating as Integer 133 ∗ 14.1.13 RatingComputed as Boolean 133 ∗ 14.1.14 SortAlbumArtist as String 133 ∗ 14.1.15 SortTitle as String 133 ∗ 14.1.16 Title as String 133 ∗ 14.1.17 TrackCount as Integer 134 – 14.2.1 class iTunesLibraryArtistMBS 135 ∗ 14.2.3 Constructor 135 ∗ 14.2.5 Handle as Integer 135 ∗ 14.2.6 name as String 135 ∗ 14.2.7 sortName as String 135 – 14.3.1 class iTunesLibraryArtworkMBS 137 ∗ 14.3.3 Constructor 137 ∗ 14.3.5 Handle as Integer 137 ∗ 14.3.6 image as NSImageMBS 137 ∗ 14.3.7 imageData as Memoryblock 137 ∗ 14.3.8 imageDataFormat as Integer 138 ∗ 14.3.10 ITLibArtworkFormatBitmap = 1 138 ∗ 14.3.11 ITLibArtworkFormatBMP = 6 138 ∗ 14.3.12 ITLibArtworkFormatGIF = 4 138 ∗ 14.3.13 ITLibArtworkFormatJPEG = 2 138 ∗ 14.3.14 ITLibArtworkFormatJPEG2000 = 3 139 ∗ 14.3.15 ITLibArtworkFormatNone = 0 139 ∗ 14.3.16 ITLibArtworkFormatPICT = 8 139 ∗ 14.3.17 ITLibArtworkFormatPNG = 5 139 ∗ 14.3.18 ITLibArtworkFormatTIFF = 7 139 – 14.4.1 class iTunesLibraryMBS 141 ∗ 14.4.7 allMediaItems as iTunesLibraryMediaItemMBS() 142 ∗ 14.4.8 allPlaylists as iTunesLibraryPlaylistMBS() 142 ∗ 14.4.9 artworkForMediaFile(mediaFile as folderitem) as iTunesLibraryArtworkMBS 142 9 ∗ 14.4.10 artworkForMediaFile(mediaFileURL as string) as iTunesLibraryArtworkMBS 142 ∗ 14.4.11 Constructor(requestedAPIVersion as string, byref error as NSErrorMBS, threaded as boolean = false) 143 ∗ 14.4.12 libraryWithAPIVersion(requestedAPIVersion as string, byref error as NSErrorMBS) as iTunesLibraryMBS 143 ∗ 14.4.14 apiMajorVersion as Integer 144 ∗ 14.4.15 apiMinorVersion as Integer 144 ∗ 14.4.16 applicationVersion as String 144 ∗ 14.4.17 features as Integer 144 ∗ 14.4.18 Handle as Integer 144 ∗ 14.4.19 musicFolderLocation as String 145 ∗ 14.4.20 showContentRating as Boolean 145 ∗ 14.4.22 ITLibExportFeatureNone = 0 145 – 14.5.1 class iTunesLibraryMediaEntityMBS 146 ∗ 14.5.5 Constructor 146 ∗ 14.5.6 enumerateValuesExceptForProperties(propertyNames() as string) as dictionary 146 ∗ 14.5.7 enumerateValuesForAllProperties as dictionary 146 ∗ 14.5.8 enumerateValuesForProperties(propertyNames() as string) as dictionary 147 ∗ 14.5.9 ITLibMediaEntityPropertyPersistentID as string 147 ∗ 14.5.10 valueForProperty(PropertyName as string) as Variant 147 ∗ 14.5.12 Handle as Integer 147 ∗ 14.5.13 persistentID as Int64 147 – 14.6.1 class iTunesLibraryMediaItemMBS 148 ∗ 14.6.3 Constructor 148 ∗ 14.6.4 ITLibMediaItemPropertyAddedDate as string 148 ∗ 14.6.5 ITLibMediaItemPropertyAlbumArtist as string 148 ∗ 14.6.6 ITLibMediaItemPropertyAlbumDiscCount as string 148 ∗ 14.6.7 ITLibMediaItemPropertyAlbumDiscNumber as string 149 ∗ 14.6.8 ITLibMediaItemPropertyAlbumIsCompilation as string 149 ∗ 14.6.9 ITLibMediaItemPropertyAlbumIsGapless as string 149 ∗ 14.6.10 ITLibMediaItemPropertyAlbumRating as string 149 ∗ 14.6.11 ITLibMediaItemPropertyAlbumRatingComputed as string 149 ∗ 14.6.12 ITLibMediaItemPropertyAlbumTitle as string 149 ∗ 14.6.13 ITLibMediaItemPropertyAlbumTrackCount as string 150 ∗ 14.6.14 ITLibMediaItemPropertyArtistName as string 150 ∗ 14.6.15 ITLibMediaItemPropertyArtwork as string 150 ∗ 14.6.16 ITLibMediaItemPropertyBeatsPerMinute as string 150 ∗ 14.6.17 ITLibMediaItemPropertyBitRate as string 150 ∗ 14.6.18 ITLibMediaItemPropertyCategory as string 150 ∗ 14.6.19 ITLibMediaItemPropertyComments as string 151 ∗ 14.6.20 ITLibMediaItemPropertyComposer as string 151 10 CHAPTER 1. LIST OF TOPICS ∗ 14.6.21 ITLibMediaItemPropertyContentRating as string 151 ∗ 14.6.22 ITLibMediaItemPropertyDescription as string 151 ∗ 14.6.23 ITLibMediaItemPropertyFileType as string 151 ∗ 14.6.24 ITLibMediaItemPropertyGenre as string 151 ∗ 14.6.25 ITLibMediaItemPropertyGrouping as string 152 ∗ 14.6.26 ITLibMediaItemPropertyHasArtwork as string 152 ∗ 14.6.27 ITLibMediaItemPropertyIsDRMProtected as string 152 ∗ 14.6.28 ITLibMediaItemPropertyIsPurchased as string 152 ∗ 14.6.29 ITLibMediaItemPropertyIsUserDisabled as string 152 ∗ 14.6.30 ITLibMediaItemPropertyIsVideo as string 152 ∗ 14.6.31 ITLibMediaItemPropertyKind as string 153 ∗ 14.6.32 ITLibMediaItemPropertyLastPlayDate as string 153 ∗ 14.6.33 ITLibMediaItemPropertyLocation as string 153 ∗ 14.6.34 ITLibMediaItemPropertyLocationType as string 153 ∗ 14.6.35 ITLibMediaItemPropertyLyricsContentRating as string 153 ∗ 14.6.36 ITLibMediaItemPropertyMediaKind as string 153 ∗ 14.6.37 ITLibMediaItemPropertyModifiedDate as string 154 ∗ 14.6.38 ITLibMediaItemPropertyPlayCount as string 154 ∗ 14.6.39 ITLibMediaItemPropertyRating as string 154 ∗ 14.6.40 ITLibMediaItemPropertyRatingComputed as string 154 ∗ 14.6.41 ITLibMediaItemPropertyReleaseDate as string 154 ∗ 14.6.42 ITLibMediaItemPropertySampleRate as string 154 ∗ 14.6.43 ITLibMediaItemPropertySize as string 155 ∗ 14.6.44 ITLibMediaItemPropertySkipDate as string 155 ∗ 14.6.45 ITLibMediaItemPropertySortAlbumArtist as string 155 ∗ 14.6.46 ITLibMediaItemPropertySortAlbumTitle as string 155 ∗ 14.6.47 ITLibMediaItemPropertySortArtistName as string 155 ∗ 14.6.48 ITLibMediaItemPropertySortComposer as string 155 ∗ 14.6.49 ITLibMediaItemPropertySortTitle as string 156 ∗ 14.6.50 ITLibMediaItemPropertyStartTime as string 156 ∗ 14.6.51 ITLibMediaItemPropertyStopTime as string 156 ∗ 14.6.52 ITLibMediaItemPropertyTitle as string 156 ∗ 14.6.53 ITLibMediaItemPropertyTotalTime as string 156 ∗ 14.6.54 ITLibMediaItemPropertyTrackNumber as string 156 ∗ 14.6.55 ITLibMediaItemPropertyUserSkipCount as string 157 ∗ 14.6.56 ITLibMediaItemPropertyVideoEpisode as string 157 ∗ 14.6.57 ITLibMediaItemPropertyVideoEpisodeOrder as string 157 ∗ 14.6.58 ITLibMediaItemPropertyVideoHeight as string 157 ∗ 14.6.59 ITLibMediaItemPropertyVideoIsHD as string 157 ∗ 14.6.60 ITLibMediaItemPropertyVideoSeason as string 157 ∗ 14.6.61 ITLibMediaItemPropertyVideoSeries as string 158 ∗ 14.6.62 ITLibMediaItemPropertyVideoSortSeries as string 158 11 ∗ 14.6.63 ITLibMediaItemPropertyVideoWidth as string 158 ∗ 14.6.64 ITLibMediaItemPropertyVoiceOverLanguage as string 158 ∗ 14.6.65 ITLibMediaItemPropertyVolumeAdjustment as string 158 ∗ 14.6.66 ITLibMediaItemPropertyVolumeNormalizationEnergy as string 158 ∗ 14.6.67 ITLibMediaItemPropertyYear as string 159 ∗ 14.6.69 addedDate as Date 159 ∗ 14.6.70 addedDateTime as DateTime 159 ∗ 14.6.71 album as iTunesLibraryAlbumMBS 159 ∗ 14.6.72 artist as iTunesLibraryArtistMBS 159 ∗ 14.6.73 artwork as iTunesLibraryArtworkMBS 160 ∗ 14.6.74 ArtworkAvailable as Boolean 160 ∗ 14.6.75 beatsPerMinute as Integer 160 ∗ 14.6.76 bitrate as Integer 160 ∗ 14.6.77 category as String 160 ∗ 14.6.78 comments as String 160 ∗ 14.6.79 composer as String 161 ∗ 14.6.80 contentRating as String 161 ∗ 14.6.81 description as String 161 ∗ 14.6.82 DRMProtected as Boolean 161 ∗ 14.6.83 fileType as Integer 161 ∗ 14.6.84 genre as String 162 ∗ 14.6.85 grouping as String 162 ∗ 14.6.86 kind as String 162 ∗ 14.6.87 lastPlayedDate as Date 162 ∗ 14.6.88 lastPlayedDateTime as DateTime 162 ∗ 14.6.89 location as String 162 ∗ 14.6.90 locationFile as FolderItem 163 ∗ 14.6.91 locationType as Integer 163 ∗ 14.6.92 lyricsContentRating as Integer 163 ∗ 14.6.93 mediaKind as Integer 163 ∗ 14.6.94 modifiedDate as Date 163 ∗ 14.6.95 modifiedDateTime as DateTime 164 ∗ 14.6.96 playCount as Integer 164 ∗ 14.6.97 Purchased as Boolean 164 ∗ 14.6.98 rating as Integer 164 ∗ 14.6.99 RatingComputed as Boolean 164 ∗ 14.6.100 releaseDate as Date 165 ∗ 14.6.101 releaseDateTime as DateTime 165 ∗ 14.6.102 sampleRate as Integer 165 ∗ 14.6.103 size as UInt64 165 ∗ 14.6.104 skipCount as Integer 166 ∗ 14.6.105 skipDate as Date 166 12 CHAPTER 1. LIST OF TOPICS ∗ 14.6.106 skipDateTime as DateTime 166 ∗ 14.6.107 sortComposer as String 166 ∗ 14.6.108 sortTitle as String 166 ∗ 14.6.109 startTime as Integer 166 ∗ 14.6.110 stopTime as Integer 167 ∗ 14.6.111 title as String 167 ∗ 14.6.112 totalTime as Integer 167 ∗ 14.6.113 trackNumber as Integer 167 ∗ 14.6.114 userDisabled as Boolean 167 ∗ 14.6.115 video as Boolean 168 ∗ 14.6.116 videoInfo as iTunesLibraryMediaItemVideoInfoMBS 168 ∗ 14.6.117 voiceOverLanguage as String 168 ∗ 14.6.118 volumeAdjustment as Integer 168 ∗ 14.6.119 volumeNormalizationEnergy as Integer 168 ∗ 14.6.120 year as Integer 168 ∗ 14.6.122 ITLibMediaItemLocationTypeFile = 1 169 ∗ 14.6.123 ITLibMediaItemLocationTypeRemote = 3 169 ∗ 14.6.124 ITLibMediaItemLocationTypeUnknown = 0 169 ∗ 14.6.125 ITLibMediaItemLocationTypeURL = 2 169 ∗ 14.6.126 ITLibMediaItemLyricsContentRatingClean = 2 169 ∗ 14.6.127 ITLibMediaItemLyricsContentRatingExplicit = 1 170 ∗ 14.6.128 ITLibMediaItemLyricsContentRatingNone = 0 170 ∗ 14.6.129 ITLibMediaItemMediaKindAlertTone = 21 170 ∗ 14.6.130 ITLibMediaItemMediaKindAudiobook = 5 170 ∗ 14.6.131 ITLibMediaItemMediaKindBook = 19 170 ∗ 14.6.132 ITLibMediaItemMediaKindDigitalBooklet = 15 170 ∗ 14.6.133 ITLibMediaItemMediaKindHomeVideo = 12 171 ∗ 14.6.134 ITLibMediaItemMediaKindInteractiveBooklet = 9 171 ∗ 14.6.135 ITLibMediaItemMediaKindIOSApplication = 16 171 ∗ 14.6.136 ITLibMediaItemMediaKindiTunesU = 18 171 ∗ 14.6.137 ITLibMediaItemMediaKindMovie = 3 171 ∗ 14.6.138 ITLibMediaItemMediaKindMusicVideo = 7 172 ∗ 14.6.139 ITLibMediaItemMediaKindPDFBook = 20 172 ∗ 14.6.140 ITLibMediaItemMediaKindPDFBooklet = 6 172 ∗ 14.6.141 ITLibMediaItemMediaKindPodcast = 4 172 ∗ 14.6.142 ITLibMediaItemMediaKindRingtone = 14 172 ∗ 14.6.143 ITLibMediaItemMediaKindSong = 2 172 ∗ 14.6.144 ITLibMediaItemMediaKindTVShow = 8 173 ∗ 14.6.145 ITLibMediaItemMediaKindUnknown = 1 173 ∗ 14.6.146 ITLibMediaItemMediaKindVoiceMemo = 17 173 – 14.7.1 class iTunesLibraryMediaItemVideoInfoMBS 174 13 ∗ 14.7.3 Constructor 174 ∗ 14.7.5 episode as String 174 ∗ 14.7.6 episodeOrder as Integer 174 ∗ 14.7.7 Handle as Integer 174 ∗ 14.7.8 HD as Boolean 175 ∗ 14.7.9 season as Integer 175 ∗ 14.7.10 series as String 175 ∗ 14.7.11 sortSeries as String 175 ∗ 14.7.12 videoHeight as Integer 175 ∗ 14.7.13 videoWidth as Integer 176 – 14.8.1 class iTunesLibraryPlaylistMBS 177 ∗ 14.8.5 Constructor 177 ∗ 14.8.6 items(threaded as boolean = false) as iTunesLibraryMediaItemMBS() 177 ∗ 14.8.7 ITLibPlaylistPropertyAllItemsPlaylist as string 177 ∗ 14.8.8 ITLibPlaylistPropertyDistinguisedKind as string 178 ∗ 14.8.9 ITLibPlaylistPropertyItems as string 178 ∗ 14.8.10 ITLibPlaylistPropertyMaster as string 178 ∗ 14.8.11 ITLibPlaylistPropertyName as string 178 ∗ 14.8.12 ITLibPlaylistPropertyParentPersistentID as string 178 ∗ 14.8.13 ITLibPlaylistPropertyVisible as string 178 ∗ 14.8.15 AllItemsPlaylist as Boolean 179 ∗ 14.8.16 DistinguishedKind as Integer 179 ∗ 14.8.17 Master as Boolean 179 ∗ 14.8.18 name as String 179 ∗ 14.8.19 ParentID as Int64 179 ∗ 14.8.20 Visible as Boolean 180 ∗ 14.8.22 ITLibDistinguishedPlaylistKind90sMusic = 42 180 ∗ 14.8.23 ITLibDistinguishedPlaylistKindBooks = 4 180 ∗ 14.8.24 ITLibDistinguishedPlaylistKindClassicalMusic = 48 180 ∗ 14.8.25 ITLibDistinguishedPlaylistKindHomeVideos = 50 180 ∗ 14.8.26 ITLibDistinguishedPlaylistKindiTunesU = 26 181 ∗ 14.8.27 ITLibDistinguishedPlaylistKindLibraryMusicVideos = 49 181 ∗ 14.8.28 ITLibDistinguishedPlaylistKindMovies = 1 181 ∗ 14.8.29 ITLibDistinguishedPlaylistKindMusic = 3 181 ∗ 14.8.30 ITLibDistinguishedPlaylistKindMusicVideos = 47 181 ∗ 14.8.31 ITLibDistinguishedPlaylistKindMyTopRated = 43 181 ∗ 14.8.32 ITLibDistinguishedPlaylistKindNone = 0 182 ∗ 14.8.33 ITLibDistinguishedPlaylistKindPodcasts = 7 182 ∗ 14.8.34 ITLibDistinguishedPlaylistKindPurchases = 16 182 ∗ 14.8.35 ITLibDistinguishedPlaylistKindRecentlyAdded = 46 182 ∗ 14.8.36 ITLibDistinguishedPlaylistKindRecentlyPlayed = 45 182 14 CHAPTER 1. LIST OF TOPICS ∗ 14.8.37 ITLibDistinguishedPlaylistKindRingtones = 5 183 ∗ 14.8.38 ITLibDistinguishedPlaylistKindTop25MostPlayed = 44 183 ∗ 14.8.39 ITLibDistinguishedPlaylistKindTVShows = 2 183 ∗ 14.8.40 ITLibDistinguishedPlaylistKindVoiceMemos = 14 183 15 • 17 Window 221 – 17.1.1 class MAAttachedWindowMBS 221 ∗ 17.1.5 attachedWindow(view as NSViewMBS, point as NSPointMBS = nil, window as NSWin- dowMBS = nil, onSide as Integer = 12, distance as Double = 0.0) as MAAttachedWin- dowMBS 223 ∗ 17.1.6 Constructor(view as NSViewMBS, point as NSPointMBS = nil, window as NSWin- dowMBS = nil, onSide as Integer = 12, distance as Double = 0.0) 223 ∗ 17.1.7 setBackgroundImage(image as NSImageMBS) 224 ∗ 17.1.8 setPoint(point as NSPointMBS, side as Integer) 224 ∗ 17.1.9 side as Integer 224 ∗ 17.1.11 arrowBaseWidth as Double 224 ∗ 17.1.12 arrowHeight as Double 225 ∗ 17.1.13 borderColor as NSColorMBS 225 ∗ 17.1.14 borderWidth as Double 225 ∗ 17.1.15 cornerRadius as Double 225 ∗ 17.1.16 drawsRoundCornerBesideArrow as boolean 226 ∗ 17.1.17 hasArrow as boolean 226 ∗ 17.1.18 viewMargin as Double 226 ∗ 17.1.19 windowBackgroundColor as NSColorMBS 226 ∗ 17.1.21 MAPositionAutomatic = 12 227 ∗ 17.1.22 MAPositionBottom = 1 227 ∗ 17.1.23 MAPositionBottomLeft = 10 227 ∗ 17.1.24 MAPositionBottomRight = 11 227 ∗ 17.1.25 MAPositionLeft = 0 227 ∗ 17.1.26 MAPositionLeftBottom = 5 228 ∗ 17.1.27 MAPositionLeftTop = 4 228 ∗ 17.1.28 MAPositionRight = 2 228 ∗ 17.1.29 MAPositionRightBottom = 7 228 ∗ 17.1.30 MAPositionRightTop = 6 228 ∗ 17.1.31 MAPositionTop = 3 228 ∗ 17.1.32 MAPositionTopLeft = 8 229 ∗ 17.1.33 MAPositionTopRight = 9 229 16 CHAPTER 1. LIST OF TOPICS • 6 Accessibility 37 – ?? Globals ?? ∗ 6.1.1 InstallNSAccessibilityPatchMBS 37 17 • 11 Cocoa Tasks 97 – 11.1.1 class NSUserAppleScriptTaskMBS 97 ∗ 11.1.3 Constructor(file as folderitem, byref error as NSErrorMBS) 98 ∗ 11.1.4 Constructor(URL as String, byref error as NSErrorMBS) 98 ∗ 11.1.5 executeWithAppleEvent(eventDesc as NSAppleEventDescriptorMBS, tag as Variant = nil) 98 – 11.2.1 class NSUserAutomatorTaskMBS 100 ∗ 11.2.3 Constructor(file as folderitem, byref error as NSErrorMBS) 100 ∗ 11.2.4 Constructor(URL as String, byref error as NSErrorMBS) 100 ∗ 11.2.5 executeWithInput(input as Variant, tag as Variant = nil) 101 ∗ 11.2.7 Variables as Dictionary 101 – 11.3.1 class NSUserScriptTaskMBS 102 ∗ 11.3.3 Available as Boolean 102 ∗ 11.3.4 Constructor(file as folderitem, byref error as NSErrorMBS) 102 ∗ 11.3.5 Constructor(URL as String, byref error as NSErrorMBS) 102 ∗ 11.3.6 execute(tag as Variant = nil) 103 ∗ 11.3.7 ScriptFolder as FolderItem 103 ∗ 11.3.9 Handle as Integer 103 ∗ 11.3.10 scriptURL as String 104 ∗ 11.3.12 executeFinished(error as NSErrorMBS, tag as Variant, result as Variant, input as Variant) 104 – 11.4.1 class NSUserUnixTaskMBS 105 ∗ 11.4.5 Constructor(file as folderitem, byref error as NSErrorMBS) 105 ∗ 11.4.6 Constructor(URL as String, byref error as NSErrorMBS) 106 ∗ 11.4.7 executeWithArguments(arguments() as string, tag as Variant = nil) 106 ∗ 11.4.9 standardError as NSFileHandleMBS 106 ∗ 11.4.10 standardInput as NSFileHandleMBS 106 ∗ 11.4.11 standardOutput as NSFileHandleMBS 107 18 CHAPTER 1. LIST OF TOPICS • 8 Apple Script 47 – 8.1.1 class OSALanguageInstanceMBS 47 ∗ 8.1.3 Constructor(language as OSALanguageMBS) 47 ∗ 8.1.4 languageInstanceWithLanguage(language as OSALanguageMBS) as OSALanguageIn- stanceMBS 47 ∗ 8.1.5 richTextFromDescriptor(descriptor as NSAppleEventDescriptorMBS) as NSAttributed- StringMBS 48 ∗ 8.1.7 componentInstance as Integer 48 ∗ 8.1.8 defaultTarget as NSAppleEventDescriptorMBS 48 ∗ 8.1.9 Handle as Integer 48 ∗ 8.1.10 language as OSALanguageMBS 48 – 8.2.1 class OSALanguageMBS 50 ∗ 8.2.3 availableLanguages as OSALanguageMBS() 50 ∗ 8.2.4 Constructor(ComponentHandle as Integer) 50 ∗ 8.2.5 defaultLanguage as OSALanguageMBS 50 ∗ 8.2.6 languageForName(name as String) as OSALanguageMBS 50 ∗ 8.2.7 languageForScriptDataDescriptor(Descriptor as NSAppleEventDescriptorMBS) as OS- ALanguageMBS 51 ∗ 8.2.8 setDefaultLanguage(Language as OSALanguageMBS) 51 ∗ 8.2.10 componentInstance as Integer 51 ∗ 8.2.11 Features as Integer 51 ∗ 8.2.12 Handle as Integer 51 ∗ 8.2.13 Info as String 52 ∗ 8.2.14 isThreadSafe as Boolean 52 ∗ 8.2.15 Manufacturer as String 52 ∗ 8.2.16 Name as String 53 ∗ 8.2.17 sharedLanguageInstance as OSALanguageInstanceMBS 53 ∗ 8.2.18 SubType as String 53 ∗ 8.2.19 Type as String 53 ∗ 8.2.20 version as String 54 ∗ 8.2.22 OSASupportsAECoercion = 8 54 ∗ 8.2.23 OSASupportsAESending = 16 54 ∗ 8.2.24 OSASupportsCompiling = 2 54 ∗ 8.2.25 OSASupportsConvenience = 64 55 ∗ 8.2.26 OSASupportsDialects = 128 55 ∗ 8.2.27 OSASupportsEventHandling = 256 55 ∗ 8.2.28 OSASupportsGetSource = 4 55 ∗ 8.2.29 OSASupportsRecording = 32 55 – 8.3.1 class OSAScriptControllerMBS 56 ∗ 8.3.3 compileScript 56 ∗ 8.3.4 Constructor 56 19 ∗ 8.3.5 recordScript 56 ∗ 8.3.6 runScript 56 ∗ 8.3.7 stopScript 56 ∗ 8.3.9 Handle as Integer 57 ∗ 8.3.10 isCompiling as Boolean 57 ∗ 8.3.11 language as OSALanguageMBS 57 ∗ 8.3.12 resultView as NSTextViewMBS 57 ∗ 8.3.13 script as OSAScriptMBS 57 ∗ 8.3.14 scriptState as Integer 58 ∗ 8.3.15 scriptView as OSAScriptViewMBS 58 ∗ 8.3.17 OSAScriptRecording = 2 58 ∗ 8.3.18 OSAScriptRunning = 1 58 ∗ 8.3.19 OSAScriptStopped = 0 58 – 8.4.1 control OSAScriptControlMBS 59 ∗ 8.4.3 AcceptTabs as Boolean 59 ∗ 8.4.4 Scrollview as Variant 59 ∗ 8.4.5 View as OSAScriptViewMBS 59 ∗ 8.4.7 BoundsChanged 60 ∗ 8.4.8 EnableMenuItems 60 ∗ 8.4.9 FrameChanged 60 ∗ 8.4.10 GotFocus 60 ∗ 8.4.11 LostFocus 60 ∗ 8.4.12 MenuAction(HitItem as MenuItem) As Boolean 60 ∗ 8.4.13 MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean 61 ∗ 8.4.14 MouseDrag(x as Integer, y as Integer) 61 ∗ 8.4.15 MouseUp(x as Integer, y as Integer) 61 ∗ 8.4.16 ScaleFactorChanged(NewFactor as Double) 62 ∗ 8.4.17 shouldChangeTextInRange(affectedCharRange as NSRangeMBS, replacementString as string) as boolean 62 ∗ 8.4.18 textDidBeginEditing 62 ∗ 8.4.19 textDidChange 62 ∗ 8.4.20 textDidEndEditing 62 ∗ 8.4.21 textShouldBeginEditing as boolean 63 ∗ 8.4.22 textShouldEndEditing as boolean 63 ∗ 8.4.23 textViewDidChangeSelection 63 – 8.5.1 class OSAScriptMBS 64 ∗ 8.5.3 compile(byref error as dictionary) as boolean 64 ∗ 8.5.4 compiledDataForType(type as string, options as Integer, byref error as dictionary) as MemoryBlock 64 ∗ 8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary) 64 ∗ 8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as Integer, byref error as NSErrorMBS) 65 20 CHAPTER 1. LIST OF TOPICS ∗ 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65 ∗ 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66 ∗ 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67 ∗ 8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, stor- ageOptions as Integer, byref error as NSErrorMBS) 67 ∗ 8.5.11 Constructor(Source as String) 68 ∗ 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69 ∗ 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageIn- stanceMBS, storageOptions as Integer) 69 ∗ 8.5.14 Constructor(URL as String, byref error as dictionary) 70 ∗ 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70 ∗ 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, stora- geOptions as Integer, byref error as NSErrorMBS) 71 ∗ 8.5.17 copy as OSAScriptMBS 72 ∗ 8.5.18 execute(byref error as dictionary) as NSAppleEventDescriptorMBS 72 ∗ 8.5.19 executeAndReturnDisplayValue(byref displayValue as NSAttributedStringMBS, byref error as dictionary) as NSAppleEventDescriptorMBS 72 ∗ 8.5.20 executeAppleEvent(event as NSAppleEventDescriptorMBS, byref error as dictionary) as NSAppleEventDescriptorMBS 72 ∗ 8.5.21 executeHandlerWithName(Name as String, arguments() as String, byref error as dictionary) as NSAppleEventDescriptorMBS 72 ∗ 8.5.22 OSAScriptErrorAppAddressKey as String 73 ∗ 8.5.23 OSAScriptErrorAppNameKey as String 73 ∗ 8.5.24 OSAScriptErrorBriefMessageKey as String 73 ∗ 8.5.25 OSAScriptErrorExpectedTypeKey as String 73 ∗ 8.5.26 OSAScriptErrorMessageKey as String 73 ∗ 8.5.27 OSAScriptErrorNumberKey as String 74 ∗ 8.5.28 OSAScriptErrorOffendingObjectKey as String 74 ∗ 8.5.29 OSAScriptErrorPartialResultKey as String 74 ∗ 8.5.30 OSAScriptErrorRangeKey as String 75 ∗ 8.5.31 OSAStorageApplicationBundleType as String 75 ∗ 8.5.32 OSAStorageApplicationType as String 75 ∗ 8.5.33 OSAStorageScriptBundleType as String 75 ∗ 8.5.34 OSAStorageScriptType as String 76 ∗ 8.5.35 OSAStorageTextType as String 76 ∗ 8.5.36 richTextFromDescriptor(descriptor as NSAppleEventDescriptorMBS) as NSAttribut- edStringMBS 76 ∗ 8.5.37 scriptDataDescriptorWithContentsOfFile(file as FolderItem) as NSAppleEventDescrip- torMBS 76 ∗ 8.5.38 scriptDataDescriptorWithContentsOfURL(URL as String) as NSAppleEventDescrip- torMBS 76 21 ∗ 8.5.39 writeToFile(File as FolderItem, type as String, byref error as dictionary) as boolean 76 ∗ 8.5.40 writeToFile(File as FolderItem, type as String, storageOptions as Integer, byref error as dictionary) as boolean 77 ∗ 8.5.41 writeToURL(URL as String, type as String, byref error as dictionary) as boolean 77 ∗ 8.5.42 writeToURL(URL as String, type as String, storageOptions as Integer, byref error as dictionary) as boolean 77 ∗ 8.5.44 Handle as Integer 77 ∗ 8.5.45 isCompiled as Boolean 78 ∗ 8.5.46 language as OSALanguageMBS 78 ∗ 8.5.47 languageInstance as OSALanguageInstanceMBS 78 ∗ 8.5.48 richTextSource as NSAttributedStringMBS 78 ∗ 8.5.49 Source as String 79 ∗ 8.5.50 URL as String 79 ∗ 8.5.52 OSACompileIntoContext = 2 79 ∗ 8.5.53 OSADontSetScriptLocation = & h01000000 79 ∗ 8.5.54 OSANull = 0 80 ∗ 8.5.55 OSAPreventGetSource = 1 80 ∗ 8.5.56 OSAShowStartupScreen = & h20000000 80 ∗ 8.5.57 OSAStayOpenApplet = & h10000000 80 – 8.6.1 class OSAScriptViewMBS 81 ∗ 8.6.3 Constructor 81 ∗ 8.6.4 Constructor(Handle as Integer) 81 ∗ 8.6.5 Constructor(left as Double, top as Double, width as Double, height as Double) 82 ∗ 8.6.7 indentsWrappedLines as Boolean 82 ∗ 8.6.8 indentWidth as Integer 82 ∗ 8.6.9 source as String 82 ∗ 8.6.10 tabWidth as Integer 83 ∗ 8.6.11 usesScriptAssistant as Boolean 83 ∗ 8.6.12 usesTabs as Boolean 83 ∗ 8.6.13 wrapsLines as Boolean 83 22 CHAPTER 1. LIST OF TOPICS • 12 Encryption and Hash 109 – 12.1.1 module PassSignerMBS 109 ∗ 12.1.5 signPass(Pass as folderitem, CertSuffix as String, Output as folderitem, Zip as boolean = true) as boolean 109 ∗ 12.1.6 verifyPassSignature(pass as folderitem) as Boolean 110 23 • 15 SFPassword 185 – 15.1.1 class SFPasswordAssistantMBS 185 ∗ 15.1.7 BaseWindowWillClose 186 ∗ 15.1.8 Constructor 186 ∗ 15.1.9 ShowPanel 186 ∗ 15.1.11 Password as string 187 ∗ 15.1.13 TextChanged(text as string) 187 24 CHAPTER 1. LIST OF TOPICS • 10 Cocoa Controls 91 – 10.1.1 class SpinningProgressIndicatorMBS 91 ∗ 10.1.5 Constructor 92 ∗ 10.1.6 Constructor(Handle as Integer) 92 ∗ 10.1.7 Constructor(left as Double, top as Double, width as Double, height as Double) 92 ∗ 10.1.8 startAnimation 93 ∗ 10.1.9 stopAnimation 93 ∗ 10.1.11 backgroundColor as NSColorMBS 93 ∗ 10.1.12 colorValue as NSColorMBS 93 ∗ 10.1.13 doubleValue as Double 94 ∗ 10.1.14 drawsBackground as boolean 94 ∗ 10.1.15 isDisplayedWhenStopped as boolean 94 ∗ 10.1.16 isIndeterminate as boolean 94 ∗ 10.1.17 maxValue as Double 95 ∗ 10.1.18 usesThreadedAnimation as boolean 95 25 • 16 Sparkle 189 – 16.1.1 class SUAppcastItemMBS 189 ∗ 16.1.5 Constructor 189 ∗ 16.1.6 Constructor(dict as dictionary) 190 ∗ 16.1.7 Constructor(dict as dictionary, byref error as string) 190 ∗ 16.1.9 ContentLength as Int64 190 ∗ 16.1.10 CriticalUpdate as Boolean 190 ∗ 16.1.11 date as date 191 ∗ 16.1.12 DateString as String 191 ∗ 16.1.13 DateTime as DateTime 191 ∗ 16.1.14 DeltaUpdate as Boolean 191 ∗ 16.1.15 DeltaUpdates as Dictionary 191 ∗ 16.1.16 displayVersionString as string 191 ∗ 16.1.17 fileURL as string 192 ∗ 16.1.18 Handle as Integer 192 ∗ 16.1.19 InformationOnlyUpdate as Boolean 192 ∗ 16.1.20 InfoURL as String 192 ∗ 16.1.21 itemDescription as string 193 ∗ 16.1.22 MacOsUpdate as Boolean 193 ∗ 16.1.23 MaximumSystemVersion as String 193 ∗ 16.1.24 minimumSystemVersion as string 193 ∗ 16.1.25 OSString as String 193 ∗ 16.1.26 phasedRolloutInterval as Variant 194 ∗ 16.1.27 propertiesDictionary as dictionary 194 ∗ 16.1.28 releaseNotesURL as string 194 ∗ 16.1.29 title as string 194 ∗ 16.1.30 versionString as string 195 – 16.2.1 class SUAppcastMBS 196 ∗ 16.2.5 Constructor 196 ∗ 16.2.6 copyWithoutDeltaUpdates as SUAppcastMBS 196 ∗ 16.2.7 fetchAppcastFromURL(url as string) 196 ∗ 16.2.8 fetchAppcastFromURL(url as string, inBackground as Boolean) 197 ∗ 16.2.9 incrementalData as Memoryblock 197 ∗ 16.2.10 items as SUAppcastItemMBS() 197 ∗ 16.2.12 Handle as Integer 197 ∗ 16.2.13 httpHeaders as Dictionary 198 ∗ 16.2.14 UserAgentString as string 198 – 16.3.1 class SUUpdaterMBS 199 ∗ 16.3.5 checkForUpdateInformation 199 ∗ 16.3.6 checkForUpdates 200 ∗ 16.3.7 checkForUpdatesInBackground 200 26 CHAPTER 1. LIST OF TOPICS ∗ 16.3.8 Constructor 200 ∗ 16.3.9 Constructor(Bundle as folderitem) 200 ∗ 16.3.10 installUpdatesIfAvailable 201 ∗ 16.3.11 InvokeImmediateInstallation 201 ∗ 16.3.12 InvokeUpdate 201 ∗ 16.3.13 IsFrameworkLoaded as boolean 201 ∗ 16.3.14 LoadFramework(path as folderitem) as boolean 201 ∗ 16.3.15 resetUpdateCycle 202 ∗ 16.3.16 SUSparkleErrorDomain as String 202 ∗ 16.3.17 SUUpdaterAppcastItemNotificationKey as String 202 ∗ 16.3.18 SUUpdaterAppcastNotificationKey as String 203 ∗ 16.3.19 SUUpdaterDidFindValidUpdateNotification as String 203 ∗ 16.3.20 SUUpdaterDidFinishLoadingAppCastNotification as String 203 ∗ 16.3.21 SUUpdaterDidNotFindUpdateNotification as String 203 ∗ 16.3.22 SUUpdaterWillRestartNotification as String 203 ∗ 16.3.23 validateMenuItem(menuItem as NSMenuItemMBS) as Boolean 203 ∗ 16.3.25 automaticallyChecksForUpdates as boolean 204 ∗ 16.3.26 automaticallyDownloadsUpdates as boolean 204 ∗ 16.3.27 decryptionPassword as String 204 ∗ 16.3.28 feedURL as string 204 ∗ 16.3.29 Handle as Integer 204 ∗ 16.3.30 hostBundle as Variant 205 ∗ 16.3.31 httpHeaders as Dictionary 205 ∗ 16.3.32 lastUpdateCheckDate as date 205 ∗ 16.3.33 lastUpdateCheckDateTime as DateTime 205 ∗ 16.3.34 sendsSystemProfile as boolean 206 ∗ 16.3.35 sparkleBundle as Variant 206 ∗ 16.3.36 updateCheckInterval as Double 206 ∗ 16.3.37 updateInProgress as boolean 206 ∗ 16.3.38 userAgentString as String 206 ∗ 16.3.40 bestValidUpdateInAppcast(appcast as SUAppcastMBS) as SUAppcastItemMBS 207 ∗ 16.3.41 didAbortWithError(error as NSErrorMBS) 207 ∗ 16.3.42 didCancelInstallUpdateOnQuit(update as SUAppcastItemMBS) 207 ∗ 16.3.43 didDismissUpdateAlertPermanently(permanently as boolean, item as SUAppcastItemMBS) 207 ∗ 16.3.44 didDownloadUpdate(item as SUAppcastItemMBS) 208 ∗ 16.3.45 didExtractUpdate(item as SUAppcastItemMBS) 208 ∗ 16.3.46 didFindValidUpdate(update as SUAppcastItemMBS) 208 ∗ 16.3.47 didFinishLoadingAppcast(update as SUAppcastMBS) 208 ∗ 16.3.48 failedToDownloadUpdate(item as SUAppcastItemMBS, error as NSErrorMBS) 209 ∗ 16.3.49 feedParametersForUpdater(sendingProfile as boolean) as dictionary() 209 ∗ 16.3.50 feedURLStringForUpdater as String 209 27 ∗ 16.3.51 pathToRelaunchForUpdater as string 209 ∗ 16.3.52 shouldPostponeRelaunchForUpdate(sendingProfile as SUAppcastItemMBS) as boolean 210 ∗ 16.3.53 updaterDidNotFindUpdate 210 ∗ 16.3.54 updaterDidRelaunchApplication 210 ∗ 16.3.55 updaterDidShowModalAlert 210 ∗ 16.3.56 updaterMayCheckForUpdates as boolean 210 ∗ 16.3.57 updaterShouldPromptForPermissionToCheckForUpdates as boolean 211 ∗ 16.3.58 updaterShouldRelaunchApplication as boolean 211 ∗ 16.3.59 updaterShouldShowUpdateAlertForScheduledUpdate(item as SUAppcastItemMBS) as boolean 211 ∗ 16.3.60 updaterWillRelaunchApplication 211 ∗ 16.3.61 updaterWillShowModalAlert 212 ∗ 16.3.62 userDidCancelDownload 212 ∗ 16.3.63 userDidSkipThisVersion(item as SUAppcastItemMBS) 212 ∗ 16.3.64 versionComparatorForUpdater as SUVersionComparisonMBS 212 ∗ 16.3.65 willDownloadUpdate(item as SUAppcastItemMBS, request as Variant) 212 ∗ 16.3.66 willExtractUpdate(item as SUAppcastItemMBS) 213 ∗ 16.3.67 willInstallUpdate(update as SUAppcastItemMBS) 213 ∗ 16.3.68 willInstallUpdateOnQuit(update as SUAppcastItemMBS) 213 ∗ 16.3.70 SUAppcastError = 1002 213 ∗ 16.3.71 SUAppcastParseError = 1000 214 ∗ 16.3.72 SUAuthenticationFailure = 4001 214 ∗ 16.3.73 SUDowngradeError = 4006 214 ∗ 16.3.74 SUDownloadError = 2001 214 ∗ 16.3.75 SUFileCopyFailure = 4000 214 ∗ 16.3.76 SUInstallationCancelledError = 4007 215 ∗ 16.3.77 SUInstallationError = 4005 215 ∗ 16.3.78 SUMissingInstallerToolError = 4003 215 ∗ 16.3.79 SUMissingUpdateError = 4002 215 ∗ 16.3.80 SUNoUpdateError = 1001 215 ∗ 16.3.81 SURelaunchError = 4004 216 ∗ 16.3.82 SURunningFromDiskImageError = 1003 216 ∗ 16.3.83 SURunningTranslocated = 1004 216 ∗ 16.3.84 SUSignatureError = 3001 216 ∗ 16.3.85 SUSystemPowerOffError = 5000 216 ∗ 16.3.86 SUTemporaryDirectoryError = 2000 216 ∗ 16.3.87 SUUnarchivingError = 3000 217 – 16.4.1 class SUVersionComparisonMBS 218 ∗ 16.4.3 Constructor 218 ∗ 16.4.4 Destructor 218 ∗ 16.4.6 Handle as Integer 218 28 CHAPTER 1. LIST OF TOPICS ∗ 16.4.8 compareVersion(VersionA as string, VersionB as string) as Integer 218 ∗ 16.4.10 NSOrderedAscending = -1 219 ∗ 16.4.11 NSOrderedDescending = 1 219 ∗ 16.4.12 NSOrderedSame = 0 219 Chapter 2

List of all classes

• AppleRemoteMBS 39

• ContinuityCameraMBS 85

• iTunesLibraryAlbumMBS 131

• iTunesLibraryArtistMBS 135

• iTunesLibraryArtworkMBS 137

• iTunesLibraryMBS 141

• iTunesLibraryMediaEntityMBS 146

• iTunesLibraryMediaItemMBS 148

• iTunesLibraryMediaItemVideoInfoMBS 174

• iTunesLibraryPlaylistMBS 177

• MAAttachedWindowMBS 221

• NSUserAppleScriptTaskMBS 97

• NSUserAutomatorTaskMBS 100

• NSUserScriptTaskMBS 102

• NSUserUnixTaskMBS 105

• OSALanguageInstanceMBS 47

• OSALanguageMBS 50

• OSAScriptControllerMBS 56

• OSAScriptMBS 64

29 30 CHAPTER 2. LIST OF ALL CLASSES • OSAScriptViewMBS 81 • SFPasswordAssistantMBS 185 • SpinningProgressIndicatorMBS 91 • SUAppcastItemMBS 189 • SUAppcastMBS 196 • SUUpdaterMBS 199 • SUVersionComparisonMBS 218 Chapter 3

List of all controls

• OSAScriptControlMBS 59

31 32 CHAPTER 3. LIST OF ALL CONTROLS Chapter 4

List of all modules

• PassSignerMBS 109

33 34 CHAPTER 4. LIST OF ALL MODULES Chapter 5

List of all global methods

• 6.1.1 InstallNSAccessibilityPatchMBS 37

35 36 CHAPTER 5. LIST OF ALL GLOBAL METHODS Chapter 6

Accessibility

6.1 Globals

6.1.1 InstallNSAccessibilityPatchMBS

Plugin Version: 18.5, Platform: macOS, Targets: Desktop only. Function: Patches crashes with [ NSMenuItem accessibilityIsAttributeSettable: ] . Notes: The plugin adds a method [ NSMenuItem accessibilityIsAttributeSettable: ] if missing to make sure the app doesn’t crash when some framework method from Apple calls it.

6.1.2 Blog Entries

• MonkeyBread Software Releases the MBS Xojo Plugins in version 18.5 • MBS Xojo Plugins, version 18.5pr6 • Fix for missing accessibilityIsAttributeSettable function

37 38 CHAPTER 6. ACCESSIBILITY Chapter 7

Apple Remote

7.1 class AppleRemoteMBS

7.1.1 class AppleRemoteMBS

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: A class to handle an Apple Remote device from Xojo. Notes: All methods in this class will catch exceptions from Cocoa and raise a NSExceptionMBS instead. Using the message, name and reason properties you can see what was the reason for this exception. Please report if you find a method which does not handle exceptions correct.

With Mac OS X 10.6 Apple made changes to the behavior of the driver so the exclusive mode does no longer work.

7.1.2 Blog Entries

• MBS Xojo / Real Studio Plugins, version 15.0pr8

• Plugins 10.1

7.1.3 Xojo Developer Magazine

• 5.4, page 50: The Case of the Top 20, The mayor is caught in an explosive situation, and our boys are on the case by Toby Rush

39 40 CHAPTER 7. APPLE REMOTE 7.1.4 Blog Entries

• MBS Xojo / Real Studio Plugins, version 15.0pr8

• Plugins 10.1

7.1.5 Xojo Developer Magazine

• 5.4, page 50: The Case of the Top 20, The mayor is caught in an explosive situation, and our boys are on the case by Toby Rush

7.1.6 Methods

7.1.7 startListening

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: Starts listening to device.

7.1.8 stopListening

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: Stops listening to device.

7.1.9 Properties

7.1.10 ClickCountEnabledButtons as Integer

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. Function: Which buttons to enable for click counting. Notes: (Read and Write property)

7.1.11 ClickCountingEnabled as Boolean

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. Function: Whether to do click counting. Notes: 7.1. CLASS APPLEREMOTEMBS 41 Click counting makes it possible to recognize if the user has pressed a button repeatedly click counting does delay each event as it has to wait if there is another event (second click) therefore there is a slight time difference (maximumClickCountTimeDifference) between a single click of the user and the call of your delegate method click counting can be enabled individually for specific buttons. Use the property clickCountEnable- Buttons to set the buttons for which click counting shall be enabled (Read and Write property)

7.1.12 Handle as Integer

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: The handle to the used AppleRemote Cocoa object. Notes: (Read and Write property)

7.1.13 ListeningOnAppActivate as Boolean

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. Function: Sets an NSApplication delegate which starts listening when application is becoming active and stops listening when application resigns being active. Notes: If an NSApplication delegate has been already set all method calls will be forwarded to this delegate, too. (Read and Write property)

7.1.14 ListeningToRemote as boolean

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: Whether object is currently listening to the devices. Notes: True if yes and false if no. (Read and Write property)

7.1.15 MaximumClickCountTimeDifference as Double

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. Function: The maximum time difference till which clicks are recognized as multi clicks. Notes: (Read and Write property) 42 CHAPTER 7. APPLE REMOTE 7.1.16 OpenInExclusiveMode as boolean

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: Whether device should be opened in exclusive mode. Notes: True if yes and False if no. (Read and Write property)

7.1.17 ProcessesBacklog as Boolean

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. Function: When your application needs to much time on the main thread when processing an event other events may already be received which are put on a backlog. Notes: As soon as your main thread has some spare time this backlog is processed and may flood your delegate with calls. Backlog processing is turned off by default. (Read and Write property)

7.1.18 RemoteAvailable as boolean

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: Whether the needed drivers are installed to handle the device. Notes: True if driver was found. (Read only property)

7.1.19 remoteId as Integer

Plugin Version: 7.1, Platform: macOS, Targets: Desktop only. Function: The device ID. Notes: (Read only property)

7.1.20 SimulatesPlusMinusHold as Boolean

Plugin Version: 15.0, Platform: macOS, Targets: Desktop only. 7.1. CLASS APPLEREMOTEMBS 43 Function: Simulating plus/minus hold does deactivate sending of individual requests for plus/minus pressed down/released. Notes: Instead special hold events are being triggered when the user is pressing and holding plus/minus for a small period. With simulating enabled the plus/minus buttons do behave as the left/right buttons. (Read and Write property)

7.1.21 Events

7.1.22 ButtonPressed(ButtonID as Integer, PressedDown as boolean, click- Count as Integer)

Plugin Version: 7.1, Platform: macOS, Targets: . Function: The event being called whenever a button is pressed or released. Notes: ButtonID is one of the kRemote* constants in this class. PressedDown is true if the button was pressed down. If false the button is now no longer pressed after holding it.

7.1.23 Constants

7.1.24 kRemoteButtonFullscreen2009 = 32768

Plugin Version: 15.0. Function: The constant for the fullscreen button (older modell).

7.1.25 kRemoteButtonLeft = 64

Plugin Version: 7.1. Function: The constant for the left button.

7.1.26 kRemoteButtonLeftHold = 256

Plugin Version: 7.1. 44 CHAPTER 7. APPLE REMOTE Function: The constant for the left button being hold.

7.1.27 kRemoteButtonMenu = 8

Plugin Version: 7.1. Function: The constant for the menu button.

7.1.28 kRemoteButtonMenuHold = 512

Plugin Version: 7.1. Function: The constant for the menu button being hold.

7.1.29 kRemoteButtonPlay = 16

Plugin Version: 7.1. Function: The constant for the play button.

7.1.30 kRemoteButtonPlay2009 = 16384

Plugin Version: 15.0. Function: The constant for the play button (older model).

7.1.31 kRemoteButtonPlaySleep = 1024

Plugin Version: 7.1. Function: The constant for the play button being hold.

7.1.32 kRemoteButtonRight = 32

Plugin Version: 7.1. Function: The constant for the right button. 7.1. CLASS APPLEREMOTEMBS 45 7.1.33 kRemoteButtonRightHold = 128

Plugin Version: 7.1. Function: The constant for the right button being hold.

7.1.34 kRemoteButtonVolumeMinus = 4

Plugin Version: 7.1. Function: The constant for the volume minus button.

7.1.35 kRemoteButtonVolumeMinus_Hold = 8192

Plugin Version: 15.0. Function: The constant for the volume minus button (hold).

7.1.36 kRemoteButtonVolumePlus = 2

Plugin Version: 7.1. Function: The constant for the volume plus button.

7.1.37 kRemoteButtonVolumePlus_Hold = 4096

Plugin Version: 15.0. Function: The constant for the volume plus button (hold).

7.1.38 kRemoteControlSwitched = 2048

Plugin Version: 7.1. Function: The constant for the device switch event. 46 CHAPTER 7. APPLE REMOTE Chapter 8

Apple Script

8.1 class OSALanguageInstanceMBS

8.1.1 class OSALanguageInstanceMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The class for a language instance.

8.1.2 Methods

8.1.3 Constructor(language as OSALanguageMBS)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates a new language instance with given language.

8.1.4 languageInstanceWithLanguage(language as OSALanguageMBS) as OS- ALanguageInstanceMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates a new language instance with given language.

47 48 CHAPTER 8. APPLE SCRIPT 8.1.5 richTextFromDescriptor(descriptor as NSAppleEventDescriptorMBS) as NSAttributedStringMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Get source text for a descriptor using the language instance for context.

8.1.6 Properties

8.1.7 componentInstance as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The component instance handle. Notes: If this is the shared instance for the language, this is the same as the language’s component instance. (Read only property)

8.1.8 defaultTarget as NSAppleEventDescriptorMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The default target application for Apple event sending. Notes: It also establishes the default target from which terminologies come. It is effectively like having an Apple- Script ”tell” statement around the entire program. When nil, the default target is the current application. (Read and Write property)

8.1.9 Handle as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The internal object handle. Notes: (Read and Write property)

8.1.10 language as OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. 8.1. CLASS OSALANGUAGEINSTANCEMBS 49 Function: The language for this instance. Notes: (Read only property) 50 CHAPTER 8. APPLE SCRIPT 8.2 class OSALanguageMBS

8.2.1 class OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The class for a language.

8.2.2 Methods

8.2.3 availableLanguages as OSALanguageMBS()

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Queries available languages. Notes: For 32-bit apps this is just AppleScript, but 64-bit apps see more entries.

8.2.4 Constructor(ComponentHandle as Integer)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates a new object with given component handle.

8.2.5 defaultLanguage as OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The default language. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.Name+EndOfLine+l.Manufacturer+EndOfLine+l.Info

8.2.6 languageForName(name as String) as OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Finds language for given name. Example: 8.2. CLASS OSALANGUAGEMBS 51 dim l as OSALanguageMBS = OSALanguageMBS.languageForName(”AppleScript”) MsgBox l.Name

8.2.7 languageForScriptDataDescriptor(Descriptor as NSAppleEventDescriptorMBS) as OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Queries language for an Apple Event descriptor.

8.2.8 setDefaultLanguage(Language as OSALanguageMBS)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: sets the default language.

8.2.9 Properties

8.2.10 componentInstance as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Queries component instance handle. Notes: (Read only property)

8.2.11 Features as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The language features. Notes: (Read only property)

8.2.12 Handle as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The internal object reference. Notes: (Read and Write property) 52 CHAPTER 8. APPLE SCRIPT

8.2.13 Info as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Queries info string. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.Name+EndOfLine+l.Manufacturer+EndOfLine+l.Info

Notes: (Read only property)

8.2.14 isThreadSafe as Boolean

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Whether this language is thread safe. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox str(l.isThreadSafe)

Notes: (Read only property)

8.2.15 Manufacturer as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The manufacturer of the language. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.Name+EndOfLine+l.Manufacturer+EndOfLine+l.Info

Notes: (Read only property) 8.2. CLASS OSALANGUAGEMBS 53 8.2.16 Name as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The name of the language. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.Name+EndOfLine+l.Manufacturer+EndOfLine+l.Info

Notes: (Read only property)

8.2.17 sharedLanguageInstance as OSALanguageInstanceMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The shared language instance if available. Notes: (Read only property)

8.2.18 SubType as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The subtype. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.type+EndOfLine+l.SubType

Notes: (Read only property)

8.2.19 Type as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The type code. Example: dim l as OSALanguageMBS = OSALanguageMBS.defaultLanguage MsgBox l.type+EndOfLine+l.SubType 54 CHAPTER 8. APPLE SCRIPT

Notes: (Read only property)

8.2.20 version as String

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The version of this language. Example: dim l as OSALanguageMBS = OSALanguageMBS.languageForName(”AppleScript”) MsgBox l.version

Notes: (Read only property)

8.2.21 Constants

8.2.22 OSASupportsAECoercion = 8

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Apple Event coercion

8.2.23 OSASupportsAESending = 16

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Apple Event sending

8.2.24 OSASupportsCompiling = 2

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Compiling 8.2. CLASS OSALANGUAGEMBS 55 8.2.25 OSASupportsConvenience = 64

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Convenience

8.2.26 OSASupportsDialects = 128

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Dialects

8.2.27 OSASupportsEventHandling = 256

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Event handling

8.2.28 OSASupportsGetSource = 4

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports getting source

8.2.29 OSASupportsRecording = 32

Plugin Version: 15.3. Function: One of the feature constants. Notes: Supports Recording 56 CHAPTER 8. APPLE SCRIPT 8.3 class OSAScriptControllerMBS

8.3.1 class OSAScriptControllerMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The script controller.

8.3.2 Methods

8.3.3 compileScript

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Compiles the script.

8.3.4 Constructor

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The constructor.

8.3.5 recordScript

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Records a script.

8.3.6 runScript

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Runs current script.

8.3.7 stopScript

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. 8.3. CLASS OSASCRIPTCONTROLLERMBS 57 Function: Stops the current script.

8.3.8 Properties

8.3.9 Handle as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The internal object reference. Notes: (Read and Write property)

8.3.10 isCompiling as Boolean

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Whether the view is currently compiling a script. Notes: (Read only property)

8.3.11 language as OSALanguageMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The language to use. Notes: (Read and Write property)

8.3.12 resultView as NSTextViewMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The view to show result of script run. Notes: (Read and Write property)

8.3.13 script as OSAScriptMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The current script. Notes: (Read and Write property) 58 CHAPTER 8. APPLE SCRIPT 8.3.14 scriptState as Integer

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The current script state. Notes: Can be OSAScriptStopped, OSAScriptRunning or OSAScriptRecording. (Read only property)

8.3.15 scriptView as OSAScriptViewMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The script view for this controller. Notes: (Read and Write property)

8.3.16 Constants

8.3.17 OSAScriptRecording = 2

Plugin Version: 15.3. Function: The script state. Notes: Script is recording.

8.3.18 OSAScriptRunning = 1

Plugin Version: 15.3. Function: The script state. Notes: Script is running.

8.3.19 OSAScriptStopped = 0

Plugin Version: 15.3. Function: The script state. Notes: Script is stopped. 8.4. CONTROL OSASCRIPTCONTROLMBS 59 8.4 control OSAScriptControlMBS

8.4.1 control OSAScriptControlMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The Xojo control for a OSAScriptView. Notes: This control embeds a special OSAScriptView subclass. Designed for Xojo 2013r1 and newer. May work on Xojo 2012, but not perfectly. Please use view property to access the underlaying object and set properties.

8.4.2 Properties

8.4.3 AcceptTabs as Boolean

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Whether the control should accept tab keys. Notes: If true, the plugin will not forward the tab keydown/keyup events to Xojo, because Xojo would do switch to next control. (Read and Write property)

8.4.4 Scrollview as Variant

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The scrollview for this textview. Notes: (Read only property)

8.4.5 View as OSAScriptViewMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The view used in the control. Notes: Use this object to set more options on the control. (Read only property) 60 CHAPTER 8. APPLE SCRIPT 8.4.6 Events

8.4.7 BoundsChanged

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The event called when the bounds, but not the frame, changed.

8.4.8 EnableMenuItems

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The event where you can enable menu items.

8.4.9 FrameChanged

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The event called when the frame changed. Notes: This event notifies you, that the control changed it’s bounding frame, which is position and/or size.

8.4.10 GotFocus

Plugin Version: 16.5, Platform: macOS, Targets: . Function: The control itself got focus. Notes: This only fires if the control itself got focus and not a sub control.

8.4.11 LostFocus

Plugin Version: 16.5, Platform: macOS, Targets: . Function: The control lost focus. Notes: This only fires if the control itself lost focus and not a sub control.

8.4.12 MenuAction(HitItem as MenuItem) As Boolean

Plugin Version: 17.1, Platform: macOS, Targets: . 8.4. CONTROL OSASCRIPTCONTROLMBS 61 Function: Called when a menuitem is choosen. Notes: This allows the control to react on its relevant menu items. Please return true if you handled it or false to give others a chance.

8.4.13 MouseDown(x as Integer, y as Integer, Modifiers as Integer) As Boolean

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The mouse button was pressed inside the control’s region at the location passed in to x, y. Notes: The coordinates x and y are local to the control, i.e. they represent the position of the mouse click relative to the upper-left corner or the Control. Return True if you are going to handle the MouseDown. In such a case:

• The Action event, if any, will not execute and the state of the object will not change.

• You will receive the MouseDrag and MouseUp events.

If you return False, the system handles the MouseDown so the above event handlers do not get called.

8.4.14 MouseDrag(x as Integer, y as Integer)

Plugin Version: 17.1, Platform: macOS, Targets: . Function: This event fires continuously after the mouse button was pressed inside the Control. Notes: Mouse location is local to the control passed in to x, y. As this event is fired continuously (hundreds of time per second), it is your responsibility to determine ifthe mouse has really moved.

8.4.15 MouseUp(x as Integer, y as Integer)

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The mouse button was released. Notes: Use the x and y parameters to determine if the mouse button was released within the control’s boundaries. 62 CHAPTER 8. APPLE SCRIPT 8.4.16 ScaleFactorChanged(NewFactor as Double)

Plugin Version: 17.1, Platform: macOS, Targets: . Function: The backing store scale factor has changed. Notes: Please invalidate any cached bitmaps or other relevant state.

8.4.17 shouldChangeTextInRange(affectedCharRange as NSRangeMBS, replace- mentString as string) as boolean

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Sent when a text view needs to determine if text in a specified range should be changed. Notes: affectedCharRange: The range of characters to be replaced. replacementString: The characters that will replace the characters in affectedCharRange; nil if only text attributes are being changed.

Return true to allow the replacement, or false to reject the change.

8.4.18 textDidBeginEditing

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Informs you that the text object has begun editing (that the user has begun changing it).

8.4.19 textDidChange

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Informs you that the text object has changed its characters or formatting attributes.

8.4.20 textDidEndEditing

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Informs you that the text object has finished editing (that it has resigned first responder status). 8.4. CONTROL OSASCRIPTCONTROLMBS 63 8.4.21 textShouldBeginEditing as boolean

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Invoked when a text object begins to change its text, this method requests permission to begin editing. Notes: If the delegate returns false, the text object proceeds to make changes. If the delegate returns true, the text object abandons the editing operation. This method is also invoked when the user drags and drops a file onto the text object.

8.4.22 textShouldEndEditing as boolean

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Invoked from a text object’s implementation of resignFirstResponder, this method requests permission to end editing. Notes: If the delegate returns false, the text object proceeds to finish editing and resign first responder status. If the delegate returns true, the text object selects all of its text and remains the first responder.

8.4.23 textViewDidChangeSelection

Plugin Version: 15.3, Platform: macOS, Targets: . Function: Sent when the selection changes in the text view. 64 CHAPTER 8. APPLE SCRIPT 8.5 class OSAScriptMBS

8.5.1 class OSAScriptMBS

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: The class for Open Scripting Architecture.

8.5.2 Methods

8.5.3 compile(byref error as dictionary) as boolean

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Compiles the script.

8.5.4 compiledDataForType(type as string, options as Integer, byref error as dictionary) as MemoryBlock

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Compile data for a given type and options.

8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from compiled data. See also:

• 8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as Integer, byref error as NSEr- rorMBS) 65

• 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OS- ALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65

• 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66

• 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67

• 8.5.11 Constructor(Source as String) 68

• 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69 8.5. CLASS OSASCRIPTMBS 65 • 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69

• 8.5.14 Constructor(URL as String, byref error as dictionary) 70

• 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70

• 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71

8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as In- teger, byref error as NSErrorMBS)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from compiled data. See also:

• 8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary) 64

• 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OS- ALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65

• 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66

• 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67

• 8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, storageOp- tions as Integer, byref error as NSErrorMBS) 67

• 8.5.11 Constructor(Source as String) 68

• 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69

• 8.5.14 Constructor(URL as String, byref error as dictionary) 70

• 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70

• 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71

8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, Lan- guageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from data. See also: 66 CHAPTER 8. APPLE SCRIPT • 8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary) 64 • 8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as Integer, byref error as NSEr- rorMBS) 65 • 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66 • 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67 • 8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, storageOp- tions as Integer, byref error as NSErrorMBS) 67 • 8.5.11 Constructor(Source as String) 68 • 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69 • 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69 • 8.5.14 Constructor(URL as String, byref error as dictionary) 70 • 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71

8.5.8 Constructor(File as FolderItem, byref error as dictionary)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from file. See also:

• 8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as Integer, byref error as NSEr- rorMBS) 65 • 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OS- ALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65 • 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67 • 8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, storageOp- tions as Integer, byref error as NSErrorMBS) 67 • 8.5.11 Constructor(Source as String) 68 • 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69 • 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69 • 8.5.14 Constructor(URL as String, byref error as dictionary) 70 • 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70 • 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71 8.5. CLASS OSASCRIPTMBS 67 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from file. See also:

• 8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary) 64

• 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OS- ALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65

• 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66

• 8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageInstanceMBS, storageOp- tions as Integer, byref error as NSErrorMBS) 67

• 8.5.11 Constructor(Source as String) 68

• 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69

• 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69

• 8.5.14 Constructor(URL as String, byref error as dictionary) 70

• 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70

• 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71

8.5.10 Constructor(File as FolderItem, languageInstance as OSALanguageIn- stanceMBS, storageOptions as Integer, byref error as NSErrorMBS)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from file. See also:

• 8.5.5 Constructor(Data as MemoryBlock, byref error as dictionary) 64

• 8.5.6 Constructor(Data as MemoryBlock, url as string, storageOptions as Integer, byref error as NSEr- rorMBS) 65

• 8.5.7 Constructor(Data as NSAppleEventDescriptorMBS, URL as String, LanguageInstance as OS- ALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 65

• 8.5.8 Constructor(File as FolderItem, byref error as dictionary) 66

• 8.5.9 Constructor(File as FolderItem, language as OSALanguageMBS, byref error as dictionary) 67 68 CHAPTER 8. APPLE SCRIPT • 8.5.11 Constructor(Source as String) 68

• 8.5.12 Constructor(Source as String, Language as OSALanguageMBS) 69

• 8.5.13 Constructor(Source as String, URL as String, LanguageInstance as OSALanguageInstanceMBS, storageOptions as Integer) 69

• 8.5.15 Constructor(URL as String, language as OSALanguageMBS, byref error as dictionary) 70

• 8.5.16 Constructor(URL as String, languageInstance as OSALanguageInstanceMBS, storageOptions as Integer, byref error as NSErrorMBS) 71

8.5.11 Constructor(Source as String)

Plugin Version: 15.3, Platform: macOS, Targets: Desktop only. Function: Creates new script from source code. Example: dim s as new OSAScriptMBS(”display dialog ””Hello”””) MsgBox s.source

See also: