Technical Note TN2179

Cocoaアプリケーションの「About」パネル作成

Cocoaアプリケーションの「About」メニュー項目は、orderFrontStandardAboutPanel:メッセージを送ることで作成されます。そのメッセージは、レスポンダチェーンの下位から上位へ送られ、結果的にNSApplicationに渡されます。NSApplicationがそのメッセージを受け取ると、Info.plistファイルおよびアプリケーションバンドル内のResourcesフォルダから集めたさまざまな情報で「About」パネルを作成します。 Xcodeプロジェクトに必要な情報を指定しておけば、標準「About」パネルを使用する際に、ほかの作業は必要ありません。 しかし、orderFrontStandardAboutPanelWithOptions:メッセージを使用して、プログラミングによって実行時に決まる値を持つ標準「About」パネルを作成および表示することもできます。もう1つの方法は、標準「About」パネルの動作を完全にオーバーライドすることで、独自の「About」パネルを作成します。

「About」パネルのプロパティリスト値 バージョン表示フォーマット 'orderFrontStandardAboutPanelWithOptions'を使用した「About」パネル 独自の'NSView'を使用した「About」パネル 技術文書 ドキュメント改訂履歴

「About」パネルのプロパティリスト値

情報プロパティリストファイルには、バンドルされている実行可能ファイルの基本的な設定情報が含まれています。ほとんどのバンドルには、この種類のファイル（通常、ファイル名はInfo.plist）が少なくとも1つはあります。その情報の一部を使ってアプリケーションの「About」パネルが作成されます。

orderFrontStandardAboutPanelWithOptions:を使用して「About」パネルを表示する場合、オプションディクショナリの定義に使用する、さまざまな属性およびキーについてよく理解している必要があります。

表1：次のキー文字列は、オプションディクショナリで使用できるキーです。

先頭に戻る

バージョン表示フォーマット

「About」パネルのバージョン文字列を作成するアルゴリズムは、マーケティングバージョン(MV)およびビルドバージョン(BV)があるかどうかに応じて、次のように「About」パネルに表示します。

Version MV (BV)

Version MV

Version BV

上記の表の繰り返しになりますが、MVはディクショナリのApplicationVersionに由来し、ディクショナリにない場合は、Info.plistファイルのCFBundleShortVersionStringに基づきます。BVは、ディクショナリのVersionに由来し、ディクショナリにない場合は、Info.plistファイルのCFBundleVersionに基づきます。

Tiger以降のシステムでは、単語「Version」を追加します。Tiger以前のシステムでは、「v」をその代わりとして使用しています。

先頭に戻る

'orderFrontStandardAboutPanelWithOptions'を使用した「About」パネル

この例では、オプションのディクショナリを用いて標準「About」パネルを使用する方法を示します。クレジットセクションを実装するかどうか（すなわち、使用しているプロジェクトに「Credits.rtf」ファイルを入れるかどうか）は、任意です。クレジットセクションが特定の著作権表示も提供するならば、文字列「NSHumanReadableCopyright」がある場合は、その文字列をInfoPlist.stringsファイルから削除する必要があります。

リスト1：'orderFrontStandardAboutPanelWithOptions'を使用したサンプル

#import "Controller.h"

@implementation Controller

- (IBAction)openAboutPanel:(id)sender
{
    NSDictionary *options;
    NSImage *img;

    img = [NSImage imageNamed: @"Picture 1"];
    options = [NSDictionary dictionaryWithObjectsAndKeys:
          @"1.1", @"Version",
          @"Super App", @"ApplicationName",
          img, @"ApplicationIcon",
          @"Copyright 2005-2006, My Great Company", @"Copyright",
          @"Super App v1.1", @"ApplicationVersion",
          nil];

    [[NSApplication sharedApplication] orderFrontStandardAboutPanelWithOptions:options];
}

@end

図1：リスト1による「About」パネルのサンプル

先頭に戻る

独自の'NSView'を使用した「About」パネル

独自の「About」パネルを作成するには、使用しているアプリケーションのバンドル情報を直接読み、自分のパネルやウインドウもしくはNSViewにそのバンドル情報を表示できます。リスト2では、InterfaceBuilder IBOutletsを使用していないことに注目してください。その代わりに、埋め込まれた各NSViewがそのタグにより参照されます。また、InfoPlist.stringsエントリがInfo.plistエントリに優先することに留意してください。

リスト2：独自のNSViewで「About」パネルの使用法を示すサンプル

@interface AboutView : NSView
{}
@end

@implementation AboutView

-(id)infoValueForKey:(NSString*)key
{
    if ([[[NSBundle mainBundle] localizedInfoDictionary] objectForKey:key])
        return [[[NSBundle mainBundle] localizedInfoDictionary] objectForKey:key];

    return [[[NSBundle mainBundle] infoDictionary] objectForKey:key];
}

- (void)drawRect:(NSRect)rect
{
    [super drawRect: rect];

    // 背景を白に描画する
    [[NSColor whiteColor] set];
    [NSBezierPath fillRect:rect];

    // NSBundle情報を表示する
    NSString* nameStr = [self infoValueForKey:@"CFBundleName"];
    NSTextField* field = [self viewWithTag: 1];
    [field setStringValue: nameStr];

    NSString* versionStr = [self infoValueForKey:@"CFBundleVersion"];
    field = [self viewWithTag: 2];
    [field setStringValue: versionStr];

    NSString* copyrightStr = [self infoValueForKey:@"NSHumanReadableCopyright"];
    field = [self viewWithTag: 3];
    [field setStringValue: copyrightStr];

    // アプリケーションのアイコンを描画する
    NSImage* iconImage = nil;
    NSImageView* imageView = [self viewWithTag: 0];
    NSString* iconFileStr = [self infoValueForKey:@"CFBundleIconFile"];
    if ([iconFileStr length] > 0)
    {
        // アイコンの実体が存在する
        iconImage = [NSImage imageNamed: iconFileStr];
    }
    else
    {
        // アプリケーションアイコンが定義されていないので、デフォルトのシステムアイコンを使用する
        iconImage = [NSImage imageNamed: @"NSApplicationIcon"];
        // もしくは
        //NSString* appIconType = NSFileTypeForHFSTypeCode(kGenericApplicationIcon);
        //iconImage = [[NSWorkspace sharedWorkspace] iconForFileType:appIconType];
    }
    [imageView setImage: iconImage];
}

@end

先頭に戻る

技術文書

• 「orderFrontStandardAboutPanelWithOptions:」の詳細については、

  NSApplication Class Referenceを参照してください。

• 'plist'もしくはプロパティリストの詳細については、

  Technote TN2013を参照してください。

• XMLベースの情報プロパティリストファイルの詳しい技術情報については、

  Runtime Configuration Guidelinesを参照してください。

• Property List Key Referenceについては、

  Introduction to Runtime Configuration Guidelinesを参照してください。

• 手のこんだ「About」パネルを使用したCocoaサンプルを見るには、

  FancyAboutを参照してください。

先頭に戻る

ドキュメント改訂履歴

掲載日： 2007-01-22