menus

Attribute Macro menus 

Source
#[menus]
Available on crate feature generic only.
Expand description

汎用プラグインのメニュー登録実装を生成するマクロ。

このマクロはimplブロックに対して適用されます。 implブロック内で定義された関数が汎用プラグインのメニューとして登録されます。

§Attributes

§import

インポートメニューとして登録します。

  • name: メニューに表示される名前を指定します。
  • error: エラー発生時のハンドリング方法を指定します。"alert""log""ignore"のいずれかを指定します。
    • "alert": エラー発生時にアラートダイアログを表示します。(デフォルト)
    • "log": エラー発生時にログにエラーメッセージを出力します。
    • "ignore": エラー発生時に何も行いません。

関数は以下のシグネチャのうちいずれかを持つ必要があります:

fn func1(edit_handle: &mut aviutl2::generic::EditSection) -> ()
fn func2(edit_handle: &mut aviutl2::generic::EditSection) -> Result<(), E>
fn func3(&self, edit_handle: &mut aviutl2::generic::EditSection) -> ()
fn func4(&self, edit_handle: &mut aviutl2::generic::EditSection) -> Result<(), E>
fn func5(&mut self, edit_handle: &mut aviutl2::generic::EditSection) -> ()
fn func6(&mut self, edit_handle: &mut aviutl2::generic::EditSection) -> Result<(), E>
where
    Box<dyn std::error::Error>: From<E>,

§export

エクスポートメニューとして登録します。 パラメーター、シグネチャはimport属性と同様です。

§layer

レイヤーメニューとして登録します。 パラメーター、シグネチャはimport属性と同様です。

§object

オブジェクトメニューとして登録します。 パラメーター、シグネチャはimport属性と同様です。

§edit

編集メニューとして登録します。 パラメーター、シグネチャはimport属性と同様です。

§config

設定メニューとして登録します。 設定メニューの登録後にウィンドウクライアントを登録するとシステムメニューに「設定」が追加されます。 関数は以下のシグネチャのうちいずれかを持つ必要があります:

fn func1(hwnd: aviutl2::Win32WindowHandle) -> ()
fn func2(hwnd: aviutl2::Win32WindowHandle) -> Result<(), E>
fn func3(&self, hwnd: aviutl2::Win32WindowHandle) -> ()
fn func4(&self, hwnd: aviutl2::Win32WindowHandle) -> Result<(), E>
fn func5(&mut self, hwnd: aviutl2::Win32WindowHandle) -> ()
fn func6(&mut self, hwnd: aviutl2::Win32WindowHandle) -> Result<(), E>
where
    Box<dyn std::error::Error>: From<E>,

§Example

#[aviutl2::plugin(GenericPlugin)]
struct MyGenericPlugin;

#[aviutl2::generic::menus]
impl MyGenericPlugin {
    #[import(name = ".txtファイルをインポート")]
    fn import_text(edit_handle: &mut aviutl2::generic::EditSection) -> aviutl2::AnyResult<()> {
        // ...
    }

    #[export(name = ".txtファイルをエクスポート")]
    fn export_text(edit_handle: &mut aviutl2::generic::EditSection) -> aviutl2::AnyResult<()> {
        // ...
    }

    #[layer(name = "レイヤーを複製")]
    fn duplicate_layer(edit_handle: &mut aviutl2::generic::EditSection) -> aviutl2::AnyResult<()> {
        // ...
    }

    #[object(name = "オブジェクトを削除")]
    fn delete_object(edit_handle: &mut aviutl2::generic::EditSection) -> aviutl2::AnyResult<()> {
        // ...
    }

    #[edit(name = "BPMグリッドを消去")]
    fn register_edit_menu(edit_handle: &mut aviutl2::generic::EditSection) -> aviutl2::AnyResult<()> {
        // ...
    }

    #[config(name = "オブジェクトを削除")]
    fn show_config(hwnd: aviutl2::Win32WindowHandle) -> aviutl2::AnyResult<()> {
        // ...
    }
}