YBDesktop plug-in I/F詳細情報

　YBDestopがplug-inをロードする際にはpluginフォルダを*.DLLで検索しますので、各plug-inが専用の.iniやフォルダをpluginフォルダに配置することも可能です。また、検索されたDLLが実装必須なI/F(インターフェース)を備えていない場合にはプラグインとして認識しませんので、プラグイン用DLLをプラグインフォルダに配置することも可能です。

　初期化ファイル(iniファイル)はpluginフォルダ等に専用の物を用意するのはもちろん、YBDesktop本体の初期化ファイル(YBDesktop.ini)に追記することも可能です。

I/F一覧

I/F名	機能
初期化	初期化処理を行います
メニュー名設定	plug-inメニューに表示する名称を設定します
メニュー通知	plug-inメニューからの選択時に呼び出されます
切替前通知	デスクトップ切替前に通知されます
切替中止通知	デスクトップ切替中止時に通知されます
切替後通知	デスクトップ切替後に通知されます
終了通知	YBDesktop終了時に通知されます
バージョン設定	呼出し元にバージョン情報を設定します
作者名設定	呼出し元に作者名を設定します
作者HP設定	呼出し元に作者ホームページURLを設定します
作者連絡先設定	呼出し元に作者連絡先を設定します
最新版ファイルURL設定	呼出し元に最新バージョンのダウンロード先URLを設定します

I/F詳細

初期化

関数名	YBD_PlgInit
型	int
引数	なし
実装義務	必須
呼出しタイミング	YBDesktop起動時のplug-in検索後
機能	DLL初期化処理などを行う。特に必要がない場合にもI/Fを用意し、returnする必要がある。
備考	・戻り値「0」を正常終了とします。それ以外は異常終了とみなし、次のplug-inのLoad処理に移ります。・YBDesktopは各plug-inの初期化処理が終了するのを直列に待ちます(並列処理は行わない)ので、初期化に時間がかかる場合には別途作成したスレッドにて処理を行い、早めにYBDesktopに制御を返すようにしてください。

メニュー名設定

関数名	YBD_TopMenuInfo
型	int
引数	char **
実装義務	必須
呼出しタイミング	ユーザーによるメニュー表示実行時
機能	plug-inメニューからplug-inを選択した際に表示する名称を、引数にて受け取ったポインタに設定します。
備考	・plug-in名称最大長は共通ヘッダに定義されています(PLGINNAME_MAXLEN)。・ここでメニュー名称を設定しても、以下のYBD_TopMenu()I/Fを実装していない場合にはplug-inメニューに表示されません。

メニュー通知

関数名	YBD_TopMenu
型	int
引数	なし
実装義務	任意
呼出しタイミング	ユーザーがplug-inメニューから該当plug-inを選択した時
機能	plug-in設定処理など、ユーザーが選択した時に実行する処理を記述します。
備考	・当I/Fを実装していない場合にはplug-inメニューに名称が表示されません。 ※1.0.1よりも古いバージョンでは実装が必須です。

切替前通知

関数名	YBD_BfDskChg
型	int
引数	char *
実装義務	任意
呼出しタイミング	ユーザーがデスクトップ切替えを要求した際の切替える直前
機能	切替え先デスクトップ名称を引数にて受け取り、切替前処理を行うことができます。
備考	・切替えを許可する場合には0を、拒否する場合には0以外を返却してください。・すべてのplug-inが切替えを許可した場合(return 0)のみデスクトップの切替えが行われます。・YBDesktopは各plug-inの切替前処理が終了するのを直列に待ちます(並列処理は行わない)ので、処理に時間がかかる場合には別途作成したスレッドにて処理を行い、早めにYBDesktopに制御を返すようにしてください。

切替中止通知

関数名	YBD_DskChgCancelNotice
型	int
引数	なし
実装義務	任意
呼出しタイミング	ユーザーがデスクトップ切替えを要求した際のplug-inへの切替前処理にて、1つ以上のplug-inが正常終了(return 0)しなかった場合
機能	切替キャンセル処理を行うことができます。
備考	・YBDesktopは各plug-inの切替キャンセル処理が終了するのを直列に待ちます(並列処理は行わない)ので、処理に時間がかかる場合には別途作成したスレッドにて処理を行い、早めにYBDesktopに制御を返すようにしてください。

切替後通知

関数名	YBD_AfDskChg
型	int
引数	なし
実装義務	任意
呼出しタイミング	デスクトップ切替が行われた直後
機能	切替後処理を行うことができます。
備考	・YBDesktopは各plug-inの切替後処理が終了するのを直列に待ちます(並列処理は行わない)ので、処理に時間がかかる場合には別途作成したスレッドにて処理を行い、早めにYBDesktopに制御を返すようにしてください。

終了通知

関数名	YBD_EndNotice
型	int
引数	なし
実装義務	任意
呼出しタイミング	メニューから終了が選択された時
機能	終了時処理を行うことができます。
備考	・YBDesktopはメニューから終了が選択されると、既定のデスクトップに移動した後、当I/Fにより終了通知を行います。・YBDesktopは各plug-inの切替後処理が終了するのを直列に最大2秒だけ待ちます(並列処理は行わない)。最大待ち時間を超えると次のplug-inの終了通知処理を行います。 ※バージョン1.0.1より実装

バージョン設定

関数名	YBD_Version
型	int
引数	char **
実装義務	任意
呼出しタイミング	なし
機能	引数にて受け取ったポインタにバージョン情報を設定し、呼び出し側が参照できるようにします。
備考	・YBDesktopからの呼び出しはありません。・バージョン情報最大長は共通ヘッダに定義されています(VERSION_MAXLEN)。

作者名設定

関数名	YBD_Author
型	int
引数	char **
実装義務	任意
呼出しタイミング	なし
機能	引数にて受け取ったポインタに作者名情報を設定し、呼び出し側が参照できるようにします。
備考	・YBDesktopからの呼び出しはありません。・作者名情報最大長は共通ヘッダに定義されています(AUTHOR_MAXLEN)。

作者HP設定

関数名	YBD_AuthorUrl
型	int
引数	char **
実装義務	任意
呼出しタイミング	なし
機能	引数にて受け取ったポインタに作者ホームページURL情報を設定し、呼び出し側が参照できるようにします。
備考	・YBDesktopからの呼び出しはありません。・作者ホームページURL情報最大長は共通ヘッダに定義されています(AUTHORURL_MAXLEN)。

作者連絡先設定

関数名	YBD_AuthorMail
型	int
引数	char **
実装義務	任意
呼出しタイミング	なし
機能	引数にて受け取ったポインタに作者連絡先情報を設定し、呼び出し側が参照できるようにします。
備考	・YBDesktopからの呼び出しはありません。・作者連絡先情報最大長は共通ヘッダに定義されています(AUTHORMAIL_MAXLEN)。

最新版ファイルURL設定

関数名	YBD_FileUrl
型	int
引数	char **
実装義務	任意
呼出しタイミング	なし
機能	引数にて受け取ったポインタに最新版ファイルURL情報を設定し、呼び出し側が参照できるようにします。
備考	・YBDesktopからの呼び出しはありません。・最新版ファイルURL情報最大長は共通ヘッダに定義されています(FILEURL_MAXLEN)。

各種定義

　種々の値がヘッダに定義されています。以下からダウンロードして御利用ください。

共通ヘッダ(2003/08/14 / size:545b)

定義値	用途
DESKTOP_NAME_MAX	追加作成するデスクトップ名称の最大長
YBDESKTOPINI	YBDesktop本体の初期化ファイル名称
PLGINNAME_MAXLEN	plug-in名称最大長
VERSION_MAXLEN	plug-inバージョン情報最大長
AUTHOR_MAXLEN	plug-in作者名最大長
AUTHORURL_MAXLEN	plug-in作者ホームページ最大長
AUTHORMAIL_MAXLEN	plug-in作者連絡先最大長
FILEURL_MAXLEN	plug-in最新版ファイルURL最大長

plug-inサンプル

　Cにて作成されているplug-inのサンプルをダウンロードできます。すべてのI/Fを実装していますので、不要なI/Fを削除し、必要な機能を記述していくだけでplug-inを作成できます。

plug-inサンプル(2003/08/18 / size:6kb)

YBDesktop.ini仕様

　YBDesktopの初期化ファイルにplug-inによる追記が可能です。YBDesktopの初期化ファイルは以下の仕様になっています。

セクション	キー	用途
SKey	MENU	メニュー表示ショートカットキーを設定します。以下の「MENU_CTRL」、「MENU_ALT」、「MENU_SHIFT」と組合せるキーコードを指定します。 0以下の時にはショートカットキー登録を行いません。
	MENU_CTRL	「MENU」で指定したキーコードをCtrlキーと組み合わせるかを指定します。 0 : Ctrlキーを組み合わせません 1 : Ctrlキーを組み合わせます
	MENU_ALT	「MENU」で指定したキーコードをAltキーと組み合わせるかを指定します。 0 : Altキーを組み合わせません 1 : Altキーを組み合わせます
	MENU_SHIFT	「MENU」で指定したキーコードをShiftキーと組み合わせるかを指定します。 0 : Shiftキーを組み合わせません 1 : Shiftキーを組み合わせます
	DMV	既定デスクトップ移動ショートカットキーを設定します。以下の「DMV_CTRL」、「DMV_ALT」、「DMV_SHIFT」と組合せるキーコードを指定します。 0以下の時にはショートカットキー登録を行いません。
	DMV_CTRL	「DMV」で指定したキーコードをCtrlキーと組み合わせるかを指定します。 0 : Ctrlキーを組み合わせません 1 : Ctrlキーを組み合わせます
	DMV_ALT	「DMV」で指定したキーコードをAltキーと組み合わせるかを指定します。 0 : Altキーを組み合わせません 1 : Altキーを組み合わせます
	DMV_SHIFT	「DMV」で指定したキーコードをShiftキーと組み合わせるかを指定します。 0 : Shiftキーを組み合わせません 1 : Shiftキーを組み合わせます
ExecFactor	WAITFACT	explorer起動待ち係数を指定します。数字を大きくすることによりexplorer起動遅延時のタイムアウトを防止できます。 ※システムに重大な影響を及ぼしますので、必要なとき以外は変更しないで下さい。
ExecFactor	WAITCANCEL	explorer起動タイムアウトをキャンセルできます。 0 : 起動タイムアウトを行います 1 : 起動タイムアウトを行いませんただし、｢1｣に設定しても、システム全体の起動タイムアウトは行います。 ※システムに重大な影響を及ぼしますので、必要なとき以外は変更しないで下さい。
Desktop	MAX	追加するデスクトップの数を指定します。
	NAMEx	追加するx番目(xには1～99の数字が入ります)のデスクトップの名称を設定します。
	RESOLWx	追加するx番目(xには1～99の数字が入ります)のデスクトップの横方向解像度を設定します。 0以下が設定されている場合には既定のデスクトップに準じます。
	RESOLHx	追加するx番目(xには1～99の数字が入ります)のデスクトップの縦方向解像度を設定します。 0以下が設定されている場合には既定のデスクトップに準じます。
	COLORx	追加するx番目(xには1～99の数字が入ります)のデスクトップの色数を設定します。 0以下が設定されている場合には既定のデスクトップに準じます。
	FREQx	追加するx番目(xには1～99の数字が入ります)のデスクトップの周波数を設定します。 0以下が設定されている場合には既定のデスクトップに準じます。
	EXPLORERFLGx	追加するx番目(xには1～99の数字が入ります)のデスクトップにexplorerを起動するかを設定します。 0 : explorerを起動しません 1 : explorerを起動します
	WINDOWFLGx	追加するx番目(xには1～99の数字が入ります)のデスクトップにツールバーを表示するかを設定します。 0 : ツールバーを表示しません 1 : ツールバーを右上に表示します(座標基準は画面右上からツールバー右上です) 2 : ツールバーを右下に表示します(座標基準は画面右下からツールバー右下です) 3 : ツールバーを左下に表示します(座標基準は画面左下からツールバー左下です) 4 : ツールバーを左上に表示します(座標基準は画面左上からツールバー左上です)
	WINDOWPOSIXx	追加するx番目(xには1～99の数字が入ります)のデスクトップにツールバーを表示する際のX座標を設定します。
	WINDOWPOSIYx	追加するx番目(xには1～99の数字が入ります)のデスクトップにツールバーを表示する際のY座標を設定します。