Main Content

meta.event クラス

パッケージ: meta
スーパークラス: meta.MetaData

MATLAB クラスで定義されるイベントの記述

このページをすべて展開する

説明

meta.event クラスは、MATLAB® のクラス イベントについての情報を提供します。meta.event クラスのプロパティは、クラス定義で構文的に指定されているイベント属性とその他の情報に対応します。プロパティはすべて読み取り専用です。

meta.event クラスは handle クラスです。

クラスの属性

抽象型
true
ConstructOnLoad
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

meta.event オブジェクトを直接インスタンス化することはできません。meta.event オブジェクトを meta.class EventList プロパティから取得します。このプロパティには、meta.event オブジェクトの配列が含まれます。クラスで定義される各イベントに対して 1 つのオブジェクトが対応します。たとえば、ClassName をクエリするイベントのクラスの名前に置き換えます。

mco = ?ClassName;
elist = mco.EventList;
elist(1); % meta.event for first event in list

関数 metaclass を使用して、クラス インスタンスから meta.class オブジェクトを取得します。

mco = metaclass(obj);

プロパティ

すべて展開する

イベントの名前。文字ベクトルとして返されます。

イベントの簡単な説明。文字ベクトルとして返されます。ユーザー定義クラスの場合、このプロパティのテキストはイベント定義のコード コメントから取得されます。コメントがない場合、このプロパティは空の文字ベクトルを返します。クラス イベントのヘルプ テキストを含める方法の詳細については、カスタム ヘルプ テキストを参照してください。

イベントの詳細な説明。文字ベクトルとして返されます。ユーザー定義クラスの場合、このプロパティのテキストはイベント定義のコード コメントから取得されます。コメントがない場合、このプロパティは空の文字ベクトルを返します。クラス イベントのヘルプ テキストを含める方法の詳細については、カスタム ヘルプ テキストを参照してください。

イベントが非表示か。logical 値として返されます。true の場合、イベントは関数 events (またはイベントを一覧表示する他の関数またはビューアー) が返すイベントの一覧に表示されません。

このイベントをリッスンできるコード。次のいずれかとして返されます。

  • public — アクセス制限なし

  • protected — クラスまたはサブクラスのメソッドからのアクセス

  • private — (サブクラスからではなく) クラス メソッドのみによるアクセス

  • このイベントへの listen アクセスをもつクラスのリスト。次の形式の meta.class オブジェクトとして指定します。

    • 単一の meta.class オブジェクト。

    • meta.class オブジェクトの cell 配列。空の cell 配列 {} は private アクセスと同じです。

    詳細については、イベント アクセス リストを参照してください。

データ型: enumerated | meta.class

このイベントをトリガーできるコード。次のいずれかとして返されます。

  • public — どのコードでもイベントをトリガーできる

  • protected — クラスまたはサブクラスのメソッドからイベントをトリガーできる

  • private — サブクラスからではなくクラス メソッドに限り、イベントをトリガーできる

  • このイベントへの通知アクセスをもつクラスをリストします。次の形式で meta.class オブジェクトとしてクラスを指定します。

    • 単一の meta.class オブジェクト

    • meta.class オブジェクトの cell 配列。空の cell 配列 {} は private アクセスと同じです。

    詳細については、イベント アクセス リストを参照してください。

データ型: enumerated | meta.class

このイベントを定義するクラス。meta.class オブジェクトとして返されます。

データ型: meta.class

例

イベント NotifyAccess の検索

matlab.mixin.Copy クラスの ObjectBeingDestroyed イベントをトリガーできるコードを検索します。meta.event オブジェクトを使用してイベント NotifyAccess を決定します。

mc = ?matlab.mixin.Copyable;
findobj(mc.EventList,'Name','ObjectBeingDestroyed').NotifyAccess
ans =

    'private'

バージョン履歴

R2008a で導入

すべて展開する

参考

| | |

トピック