ドキュメント

環境設定ウインドウの表示

Mac CatalystでビルドされたMacアプリで環境設定ウインドウを表示し、設定バンドルで定義されたアプリ環境設定をユーザーが管理できるようにする方法を紹介します。

最新の英語ドキュメント

Displaying a Preferences Window

概要

Macアプリは通常、メニューバーのアプリメニューの下にある標準の「環境設定」メニュー項目からアクセス可能な環境設定ウインドウを使って、アプリごとの環境設定を表示します。

Settings.bundleファイルを含むMac CatalystでビルドしたMacアプリでは、自動的に「環境設定」メニュー項目と環境設定ウインドウが表示されます。ユーザーが「環境設定」メニュー項目を選択すると、システムにより、設定バンドルで提供したオプションに基づいてMacに適した環境設定ウインドウが表示されます。設定バンドルの詳細については、「iOS設定バンドルの実装」を参照してください。

アプリへの環境設定ウインドウの追加

Macアプリに環境設定ウインドウを含めるには、「Command + N」キーを押してiOSの下の「Resource(リソース)」セクションから「Settings Bundle(設定バンドル)」テンプレートを選択し、XcodeプロジェクトにSettings.bundleファイルを追加します。「Next(次へ)」をクリックしてプロジェクトにファイルを保存します。

Xcodeのスクリーンショット。iOSプラットフォームの選択、「Settings Bundle(設定バンドル)」テンプレートの選択、および設定バンドルを保存するためにクリックする「Next(次へ)」ボタンが表示されている。

環境設定ウインドウへのツールバータブの追加

設定バンドルに1つまたは複数の子ペインを追加して、環境設定を階層的に整理できます(「階層型の環境設定」を参照)。iOSでは、設定アプリに、子ペインが環境設定行として表示されます。ユーザーがその行をタップすると、その子ペインのプロパティリストファイルで定義された環境設定を含む新しいビューが表示されます。

macOSでは、環境設定ウインドウに、子ペインがウインドウのツールバー上のタブとして表示されます。ユーザーがタブをクリックすると、子ペインのプロパティリストファイルで提供された環境設定が表示されます。

子ペインのタブには、ペインのタイトルとシステムによって提供されるアイコンが表示されます。アイコンをカスタマイズするには、子ペインのプロパティリストファイルに以下のキーを追加します。

Icon

必要な場合のみ。環境設定ウインドウでツールバータブのアイコンとして表示する画像ファイルの名前を示す文字列。

子ペインのプロパティリストファイルを含む設定バンドルに、この画像ファイルを含める必要があります。

トグルスイッチで行った変更の確認

設定バンドルには、ユーザーが切り替えられるオン/オフを表示するトグルスイッチ要素もあります。Macアプリでは、トグルスイッチ要素に以下のキーを含めることによって、ユーザーがトグルを切り替えた時にユーザーに確認を求めることができます。

TrueConfirmationPrompt

必要な場合のみ。ユーザーがトグルをオンにしようとした時に表示するプロンプトを定義するディクショナリ。

FalseConfirmationPrompt

必要な場合のみ。ユーザーがトグルをオフにしようとした時に表示するプロンプトを定義するディクショナリ。

各ディクショナリには、プロンプトのコンテンツを定義する以下のキーが含まれます。

Type

必須。PSConfirmationPromptに設定する必要があります。

Title

必須。プロンプトのタイトルとなる文字列。一部のデバイスでは、タイトルが表示されない場合があります。

Prompt

必須。プロンプトに表示される本文テキストの文字列。

ConfirmText

必要な場合のみ。プロンプトの確認ボタンに表示されるテキストの文字列。ユーザーがこのボタンをクリックすると、トグルスイッチの値が変わります。

DenyText

必要な場合のみ。プロンプトのキャンセルボタンに表示されるテキストの文字列。ユーザーがこのボタンをクリックした場合、トグルスイッチの値は変わりません。

トグルスイッチのサブタイトルの表示

一部のiOSアプリでは、グループ項目とフッターテキストを使用して、トグルスイッチの下のサブタイトルに説明テキストを表示します。環境設定ウインドウはこのアプローチに対応していますが、Macでの外観は最適ではありません。代わりに、トグルスイッチ要素に以下のキーを含めてサブタイトルを表示します。

Description

必要な場合のみ。トグルスイッチの下に表示する、より長い説明文字列。

関連項目

ユーザー環境設定