MBS Cocoaextras Plugin Documentation
Total Page:16
File Type:pdf, Size:1020Kb
MBS CocoaExtras Plugin Documentation Christian Schmitz July 16, 2017 2 0.1 Introduction This is the PDF version of the documentation for the Xojo (Real Studio) Plug-in from Monkeybread Software Germany. Plugin part: MBS CocoaExtras Plugin 0.2 Content • 1 List of all topics 3 • 2 List of all classes 31 • 3 List of all controls 33 • 4 List of all modules 35 • 5 List of all global methods 37 • 6 All items in this plugin 39 • 20 List of Questions in the FAQ 223 • 21 The FAQ 233 Chapter 1 List of Topics • 6 Apple Remote 39 { 6.1.1 class AppleRemoteMBS 39 ∗ 6.1.3 startListening 39 ∗ 6.1.4 stopListening 39 ∗ 6.1.6 ClickCountEnabledButtons as Integer 40 ∗ 6.1.7 ClickCountingEnabled as Boolean 40 ∗ 6.1.8 Handle as Integer 40 ∗ 6.1.9 ListeningOnAppActivate as Boolean 40 ∗ 6.1.10 ListeningToRemote as boolean 41 ∗ 6.1.11 MaximumClickCountTimeDifference as Double 41 ∗ 6.1.12 OpenInExclusiveMode as boolean 41 ∗ 6.1.13 ProcessesBacklog as Boolean 41 ∗ 6.1.14 RemoteAvailable as boolean 41 ∗ 6.1.15 remoteId as Integer 42 ∗ 6.1.16 SimulatesPlusMinusHold as Boolean 42 ∗ 6.1.18 ButtonPressed(ButtonID as Integer, PressedDown as boolean, clickCount as Integer) 42 ∗ 6.1.20 kRemoteButtonFullscreen2009 = 32768 42 ∗ 6.1.21 kRemoteButtonLeft = 64 43 ∗ 6.1.22 kRemoteButtonLeftHold = 256 43 ∗ 6.1.23 kRemoteButtonMenu = 8 43 ∗ 6.1.24 kRemoteButtonMenuHold = 512 43 ∗ 6.1.25 kRemoteButtonPlay = 16 43 ∗ 6.1.26 kRemoteButtonPlay2009 = 16384 43 ∗ 6.1.27 kRemoteButtonPlaySleep = 1024 43 ∗ 6.1.28 kRemoteButtonRight = 32 43 ∗ 6.1.29 kRemoteButtonRightHold = 128 44 3 4 CHAPTER 1. LIST OF TOPICS ∗ 6.1.30 kRemoteButtonVolumeMinus = 4 44 ∗ 6.1.31 kRemoteButtonVolumeMinus Hold = 8192 44 ∗ 6.1.32 kRemoteButtonVolumePlus = 2 44 ∗ 6.1.33 kRemoteButtonVolumePlus Hold = 4096 44 ∗ 6.1.34 kRemoteControlSwitched = 2048 44 5 • 13 Growl 111 { 13.1.1 class GrowlApplicationBridgeMBS 111 ∗ 13.1.3 bestRegistrationDictionary as Dictionary 111 ∗ 13.1.4 Constructor 112 ∗ 13.1.5 Destructor 112 ∗ 13.1.6 frameworkInfoDictionary as Dictionary 112 ∗ 13.1.7 IsFrameworkLoaded as boolean 113 ∗ 13.1.8 isGrowlRunning as boolean 113 ∗ 13.1.9 isMistEnabled as boolean 113 ∗ 13.1.10 LoadFramework(path as folderitem) as boolean 114 ∗ 13.1.11 notificationDictionaryByFillingInDictionary(notifDict as dictionary) as Dictionary 114 ∗ 13.1.12 notifyWithDictionary(userInfo as dictionary) 114 ∗ 13.1.13 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.14 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) 115 ∗ 13.1.15 registerWithDictionary(regDict as dictionary = nil) as boolean 116 ∗ 13.1.16 registrationDictionaryByFillingInDictionary(regDict as dictionary) as Dictionary 117 ∗ 13.1.17 registrationDictionaryByFillingInDictionary(regDict as dictionary, restrictToKeys() as string) as Dictionary 117 ∗ 13.1.18 registrationDictionaryFromBundle(bundle as Variant = nil) as Dictionary 118 ∗ 13.1.19 registrationDictionaryFromDelegate as Dictionary 119 ∗ 13.1.20 reregisterGrowlNotifications 119 ∗ 13.1.21 shouldUseBuiltInNotifications as boolean 119 ∗ 13.1.22 willRegisterWhenGrowlIsReady as boolean 120 ∗ 13.1.24 Handle as Integer 120 ∗ 13.1.26 applicationIconDataForGrowl as Memoryblock 120 ∗ 13.1.27 applicationIconForGrowl as Variant 121 ∗ 13.1.28 applicationNameForGrowl as string 121 ∗ 13.1.29 growlIsReady 121 ∗ 13.1.30 growlNotificationTimedOut(clickContext as Variant) 122 ∗ 13.1.31 growlNotificationWasClicked(clickContext as Variant) 122 ∗ 13.1.32 hasNetworkClientEntitlement as boolean 122 ∗ 13.1.33 registrationDictionaryForGrowl as dictionary 122 ∗ 13.1.35 kApplicationIcon = "ApplicationIcon" 123 ∗ 13.1.36 kApplicationId = "ApplicationId" 123 ∗ 13.1.37 kApplicationName = "ApplicationName" 124 ∗ 13.1.38 kApplicationPID = "ApplicationPID" 124 ∗ 13.1.39 kGrowlNotificationIdentifier = "GrowlNotificationIdentifier” 124 6 CHAPTER 1. LIST OF TOPICS ∗ 13.1.40 kNotificationAppIcon = ”NotificationAppIcon” 125 ∗ 13.1.41 kNotificationClickContext = ”NotificationClickContext" 125 ∗ 13.1.42 kNotificationDescription = ”NotificationDescription” 125 ∗ 13.1.43 kNotificationIcon = ”NotificationIcon” 125 ∗ 13.1.44 kNotificationName = ”NotificationName” 126 ∗ 13.1.45 kNotificationPriority = ”NotificationPriority" 126 ∗ 13.1.46 kNotificationProgress = ”NotificationProgress” 126 ∗ 13.1.47 kNotificationsAll = ”AllNotifications” 126 ∗ 13.1.48 kNotificationsDefault = ”DefaultNotifications” 127 ∗ 13.1.49 kNotificationsDescriptions = ”NotificationDescriptions” 127 ∗ 13.1.50 kNotificationsHumanReadableNames = "HumanReadableNames" 127 ∗ 13.1.51 kNotificationSticky = ”NotificationSticky" 127 ∗ 13.1.52 kNotificationTitle = ”NotificationTitle” 128 ∗ 13.1.53 kTicketVersion = "TicketVersion" 128 7 • 14 iMedia 129 { 14.1.1 class iMediaBrowserMBS 129 ∗ 14.1.3 Constructor 129 ∗ 14.1.4 infoWindowIsVisible as boolean 129 ∗ 14.1.5 isLoading as boolean 130 ∗ 14.1.6 LoadAPI(framework as folderitem) as boolean 130 ∗ 14.1.7 showMediaBrowser(browserClassName as string) 130 ∗ 14.1.8 showWindow 130 ∗ 14.1.10 toolbarDisplayMode as Integer 130 ∗ 14.1.11 toolbarIsSmall as boolean 130 ∗ 14.1.13 didChangeBrowser(browserClassname as string) 131 ∗ 14.1.14 didLoadBrowser(browserClassname as string) 131 ∗ 14.1.15 horizontalSplitViewForMediaBrowser as boolean 131 ∗ 14.1.16 SelectionChanged(selection as iMediaBrowserSelectionMBS) 131 ∗ 14.1.17 willChangeBrowser(browserClassname as string) 131 ∗ 14.1.18 willLoadBrowser(browserClassname as string) as boolean 131 { 14.2.1 class iMediaBrowserSelectionMBS 132 ∗ 14.2.3 Item(index as Integer) as dictionary 132 ∗ 14.2.5 Count as Integer 132 ∗ 14.2.6 Handle as Integer 132 8 CHAPTER 1. LIST OF TOPICS • 15 iTunes 133 { 15.1.1 class iTunesLibraryAlbumMBS 133 ∗ 15.1.3 Constructor 133 ∗ 15.1.5 AlbumArtist as String 133 ∗ 15.1.6 Artist as iTunesLibraryArtistMBS 134 ∗ 15.1.7 Compilation as Boolean 134 ∗ 15.1.8 DiscCount as Integer 134 ∗ 15.1.9 DiscNumber as Integer 134 ∗ 15.1.10 Gapless as Boolean 134 ∗ 15.1.11 Handle as Integer 134 ∗ 15.1.12 Rating as Integer 135 ∗ 15.1.13 RatingComputed as Boolean 135 ∗ 15.1.14 SortAlbumArtist as String 135 ∗ 15.1.15 SortTitle as String 135 ∗ 15.1.16 Title as String 135 ∗ 15.1.17 TrackCount as Integer 135 { 15.2.1 class iTunesLibraryArtistMBS 136 ∗ 15.2.3 Constructor 136 ∗ 15.2.5 Handle as Integer 136 ∗ 15.2.6 name as String 136 ∗ 15.2.7 sortName as String 136 { 15.3.1 class iTunesLibraryArtworkMBS 137 ∗ 15.3.3 Constructor 137 ∗ 15.3.5 Handle as Integer 137 ∗ 15.3.6 image as NSImageMBS 137 ∗ 15.3.7 imageData as Memoryblock 137 ∗ 15.3.8 imageDataFormat as Integer 138 ∗ 15.3.10 ITLibArtworkFormatBitmap = 1 138 ∗ 15.3.11 ITLibArtworkFormatBMP = 6 138 ∗ 15.3.12 ITLibArtworkFormatGIF = 4 138 ∗ 15.3.13 ITLibArtworkFormatJPEG = 2 138 ∗ 15.3.14 ITLibArtworkFormatJPEG2000 = 3 138 ∗ 15.3.15 ITLibArtworkFormatNone = 0 139 ∗ 15.3.16 ITLibArtworkFormatPICT = 8 139 ∗ 15.3.17 ITLibArtworkFormatPNG = 5 139 ∗ 15.3.18 ITLibArtworkFormatTIFF = 7 139 { 15.4.1 class iTunesLibraryMBS 140 ∗ 15.4.3 allMediaItems as iTunesLibraryMediaItemMBS() 140 ∗ 15.4.4 allPlaylists as iTunesLibraryPlaylistMBS() 140 ∗ 15.4.5 artworkForMediaFile(mediaFile as folderitem) as iTunesLibraryArtworkMBS 140 9 ∗ 15.4.6 artworkForMediaFile(mediaFileURL as string) as iTunesLibraryArtworkMBS 140 ∗ 15.4.7 Constructor(requestedAPIVersion as string, byref error as NSErrorMBS) 141 ∗ 15.4.8 libraryWithAPIVersion(requestedAPIVersion as string, byref error as NSErrorMBS) as iTunesLibraryMBS 141 ∗ 15.4.10 apiMajorVersion as Integer 142 ∗ 15.4.11 apiMinorVersion as Integer 142 ∗ 15.4.12 applicationVersion as String 142 ∗ 15.4.13 features as Integer 142 ∗ 15.4.14 Handle as Integer 142 ∗ 15.4.15 musicFolderLocation as String 142 ∗ 15.4.16 showContentRating as Boolean 143 ∗ 15.4.18 ITLibExportFeatureNone = 0 143 { 15.5.1 class iTunesLibraryMediaEntityMBS 144 ∗ 15.5.3 Constructor 144 ∗ 15.5.4 enumerateValuesExceptForProperties(propertyNames() as string) as dictionary 144 ∗ 15.5.5 enumerateValuesForAllProperties as dictionary 144 ∗ 15.5.6 enumerateValuesForProperties(propertyNames() as string) as dictionary 144 ∗ 15.5.7 ITLibMediaEntityPropertyPersistentID as string 144 ∗ 15.5.8 valueForProperty(PropertyName as string) as Variant 145 ∗ 15.5.10 Handle as Integer 145 ∗ 15.5.11 persistentID as Integer 145 { 15.6.1 class iTunesLibraryMediaItemMBS 146 ∗ 15.6.3 Constructor 146 ∗ 15.6.4 ITLibMediaItemPropertyAddedDate as string 146 ∗ 15.6.5 ITLibMediaItemPropertyAlbumArtist as string 146 ∗ 15.6.6 ITLibMediaItemPropertyAlbumDiscCount as string 146 ∗ 15.6.7 ITLibMediaItemPropertyAlbumDiscNumber as string 147 ∗ 15.6.8 ITLibMediaItemPropertyAlbumIsCompilation as string 147 ∗ 15.6.9 ITLibMediaItemPropertyAlbumIsGapless as string 147 ∗ 15.6.10 ITLibMediaItemPropertyAlbumRating as string 147 ∗ 15.6.11 ITLibMediaItemPropertyAlbumRatingComputed as string 147 ∗ 15.6.12 ITLibMediaItemPropertyAlbumTitle as string 147 ∗ 15.6.13 ITLibMediaItemPropertyAlbumTrackCount as string 147 ∗ 15.6.14 ITLibMediaItemPropertyArtistName as string 148 ∗ 15.6.15 ITLibMediaItemPropertyArtwork as string 148 ∗ 15.6.16 ITLibMediaItemPropertyBeatsPerMinute as string 148 ∗ 15.6.17 ITLibMediaItemPropertyBitRate as string 148 ∗ 15.6.18 ITLibMediaItemPropertyCategory as string 148 ∗ 15.6.19 ITLibMediaItemPropertyComments as string 148 ∗ 15.6.20 ITLibMediaItemPropertyComposer as string 148 ∗ 15.6.21 ITLibMediaItemPropertyContentRating