Windows リボンフレームワークライブラリ for Delphiのクィックスタート
このドキュメントは、Windows リボンフレームワークライブラリ for Delphiのこちらのページの抄訳です。
概要
Windowsリボンフレームワークは、一般的なWindowsアプリケーションの階層化されたメニュー、ツールバー、および作業ウィンドウに新しいオプションを実装した素晴らしいコマンドプレゼンテーションシステムです。
Delphi向けにWindowsリボンフレームワークが提供されており、このライブラリを使用すると、Delphi開発者はDelphiアプリケーションでネイティブのWindowsリボンフレームワークライブラリを使用して、リボン機能を実装することができます。他のDelphiコンポーネントセットのようにリボンユーザーインターフェイスをエミュレートしていないため、ネイティブなWindowsリボンフレームワークライブラリを利用したい場合には最良のソリューションの一つとなります。
Windowsリボンフレームワークの機能
このDelphiライブラリは、単なるヘッダー翻訳(変換)に留まらず、以下のような機能を持っています。
- UIリボンのヘッダーファイルとの完全互換:UIリボンのヘッダーファイルをDelphiユニットへ完全なユニット翻訳(変換)をサポートしています。これによってリボンAPIを直接(低レベルでの)のアクセスが可能。ただし、 DelphiのWindowsリボンフレームワークライブラリには、はるかに使いやすいクラスライブラリが付属しているため、おそらく低レベルでのアクセスの必要はありません。
- リボンAPIへの卓越したアクセス:リボンAPIをラッピングした高レベルのアクセスを提供するクラスライブラリで、リボンAPIを直接操作するよりも遥かに簡単となり、厄介な実装の詳細のほとんどが処理されます。
- リボンコマンドの自動マッピング:既存のVCLフォームにドロップすることで、自動的にリボンを読み込み、リボンのコマンドを同じ名前のVCLアクションへ自動的にマッピングされます。
- デモプログラム:Windows SDKで提供しているUIリボンのサンプルプログラムのDelphi版で、リボンAPIを直接使用する低レベルアクセスのサンプルと、Delphiのリボンクラスライブラリを使用する高レベルアクセスのサンプルが用意しています。
- リボンデザイナ:非常に機能が充実したセミビジュアルのリボンデザイナを提供しています。この機能を使用すると、XMLを記述せずにリボンXMLファイルを作成でき、リボンのデザインとテストを完全に行うことができます。また、リボンをリソースファイルにコンパイルし、リボンコマンドにアクセスするために必要な定数を使用してDelphiソースファイルを作成します。
- WordPADテンプレート:リボンデザイナにはWordPadのテンプレートが付属しており、Windows 7などの古いバージョンに付属するWordPadのアクセサリとほぼ同じ外観のリボンを素早く作成することができます。
インストール手順
Windows リボンフレームワークライブラリ for Delphiは、VCL専用のコンポーネントで、RAD Studio / Delphi XE3 以降のバージョンに対応しています。
インストール手順は、以下の通りです。
(1) GitHubでホストされているhttps://github.com/JAM-Software/RibbonFrameworkのURLからライブラリをダウンロードする
(2) ダウンロードしたファイル(例えば、RibbonFramework-master.zip)を任意のパスへ展開する
(3)"Package\UIRibbonPackage.dproj"のプロジェクトを開く
(4)プロジェクトマネージャで"UIRibbonPackage.bpl"を選択して右クリックし 、 "インストール"をクリック
UIRibbonPackageが正常にインストールされると、以下のようなダイアログが表示されます。
(5)IDEメニューの「ツール」>「オプション」>「言語」>「Delphi」>「ライブラリ」>「ライブラリパス」の「[...]」で、このフレームワークの「Lib」フォルダを参照し、追加してください。下図はWindows 32のDelphiライブラリパスの設定例です。
ライブラリを利用する
既存のフォームにリボンを作成して、追加する手順は以下の通りです。
(1)"Designer\Bin\RibbonDesigner.exe" をダブルクリックし、デザイナを起動してください。
リボルコントロールをビルドするためにはリボルコンパイラ(UICC.exe)が必要です。このファイルは、Windows SDKの一部として付属されています。
例えば、Windows 10 SDKの場合はC:\Program Files (x86)\Windows Kits\10\bin¥<バージョン>以下に配置されていますので、UICC.exeがどこに配置されているを検索し、そのパスを設定ください。下図はその例です。
(2)リボンデザイナを利用してリボンを作成し、リボン用のXMLファイルをプロジェクトフォルダに任意のファイル名で保存してください。
下図はこちらのサンプルプロジェクトの例では、RibbonMarkup.xmlという名前で保存しています。
CommnadsのNameは任意の名前をつけることができ、指定した名前はVCLのActionManagerに紐づけることができます。詳しくは手順(6)を参照ください。
(3)リボンデザイナの”Project” > "Build "ボタンを押すと、Delphi用のリボンユニットに翻訳(変換)されます。ビルド時のメッセージの情報は画面下のメッセージペインに表示されます。
(4)ビルドが成功すると、xmlファイルを保存した同じフォルダ内にDelphi用のリボンユニットの.pasファイルが作成されます。その.pasファイルをプロジェクトに追加してください。
(5)RAD Studioのツールパレットの[Windows Ribbon Framework for Delphi]からTUIRibbonコントロールをフォーム上にドラッグします。
(6)TUIRibbonコントロールを配置すると、自動的にリボンを読み込み、リボンのコマンドを同じ名前のVCLアクションへ自動的にマッピングされます。またTActionListを配置し、TUIRibbonコントロールのActionManagerプロパティに手動で割り当てることもできます。
(7) リボンプロジェクトを実行する
下図はこちらのサンプルプロジェクトを実行した例です。
詳しくは、Windows Ribbon Tutorial(英語)を参照してください。
このライブラリについて
Windowsリボンフレームワークライブラリ for Delphiは、Eric Bilsenによって開発されており、ライセンス規約はこちらを参照ください。この製品のサポートは、Windowsリボンフレームワークライブラリ for Delphiの最新バージョンをご使用のうえ、stackoverflow.comへ投稿ください。