Sparkle.framework/Versions/A/Headers/NSBundle+SUAdditions.h

   1 //
   2 //  NSBundle+SUAdditions.h
   3 //  Sparkle
   4 //
   5 //  Created by Andy Matuschak on 12/21/07.
   6 //  Copyright 2007 Andy Matuschak. All rights reserved.
   7 //
   8
   9 #ifndef NSBUNDLE_PLUS_ADDITIONS_H
  10 #define NSBUNDLE_PLUS_ADDITIONS_H
  11
  12 #import <Cocoa/Cocoa.h>
  13
  14 @interface NSBundle (SUAdditions)
  15 /*!
  16         @method
  17         @abstract   Returns a name for the bundle suitable for display to the user.
  18         @discussion This is performed by asking NSFileManager for the display name of the bundle.
  19 */
  20 - (NSString *)name;
  21
  22 /*!
  23         @method
  24         @abstract       Returns the current internal version of the bundle.
  25         @discussion     This uses the CFBundleVersion info value. This string is not appropriate for display to users: use -displayVersion instead.
  26 */
  27 - (NSString *)version;
  28
  29 /*!
  30         @method
  31         @abstract       Returns the bundle's version, suitable for display to the user.
  32         @discussion     If the CFBundleShortVersionString is available and different from the CFBundleVersion, this looks like CFBundleShortVersionString (CFBundleVersion). If the version strings are the same or CFBundleShortVersionString is not defined, this is equivalent to -version.
  33 */
  34 - (NSString *)displayVersion;
  35
  36 /*!
  37         @method
  38         @abstract       Returns a suitable icon for this bundle.
  39         @discussion     Uses the CFBundleIconFile icon if defined; otherwise, uses the default application icon.
  40 */
  41 - (NSImage *)icon;
  42
  43 /*!
  44         @method
  45         @abstract       Returns whether the application is running from a disk image.
  46 */
  47 - (BOOL)isRunningFromDiskImage;
  48
  49 /*!
  50         @method
  51         @abstract       Returns a profile of the users system useful for statistical purposes.
  52         @discussion Returns an array of dictionaries; each dictionary represents a piece of data and has keys "key", "visibleKey", "value", and "visibleValue".
  53 */
  54 - (NSArray *)systemProfile;
  55
  56 - (NSString *)publicDSAKey;
  57 @end
  58
  59 #endif