ダイアログボックスのコントロールの無効化および非表示

コントロールの無効化と非表示について

大部分の Simulink^® ダイアログボックスには、テキストフィールドやボタンなどコントロール ("ウィジェット" と呼ぶこともある) を無効にしたり非表示にするカスタマイズ API があります。カスタマイズ API によって、複数のダイアログボックス (たとえば、一度のメソッド呼び出しによって複数のパラメーターダイアログボックス) の全クラスのコントロールを無効化または非表示にすることができます。

Simulink ダイアログボックスまたはダイアログボックスのクラスをカスタマイズする前に、まず、ダイアログボックスやダイアログボックスのクラスがカスタマイズできるか確認します。モデルエクスプローラーのダイアログペインに現れるダイアログボックスは、カスタマイズすることができます。さらに、ダイアログおよびウィジェット ID をもつダイアログボックスはカスタマイズすることができます。ダイアログボックスがカスタマイズできるかどうかを判別するには、ダイアログボックスを開いて、ダイアログおよびウィジェット ID 表示を有効にし (ウィジェット IDを参照)、ウィジェットの上にカーソルを合わせます。ウィジェット ID が表示されたら、ダイアログボックスをカスタマイズできます。

ダイアログボックスまたはダイアログボックスのクラスがカスタマイズ可能であると判別できたら、ダイアログボックスをカスタマイズする MATLAB^® コードを記述します。これには、特定のダイアログボックスやダイアログボックスのクラスに対するコントロールを無効化または非表示にするコールバック関数を記述すること (コントロールカスタマイズコールバック関数の記述を参照) とカスタマイズマネージャーを使用してコールバック関数を登録すること (コントロールカスタマイズコールバック関数の登録を参照) が必要になります。その後、Simulink は、当該ダイアログボックスを開くときはいつでも、コントロールを無効化または非表示にするコールバック関数を実行します。

ダイアログボックスのボタンを無効にする

この sl_customization.m ファイルは、名前に engine を含むモデルに対し、[コンフィギュレーションパラメーター] ダイアログボックスの [コード生成] ペインの [参照] ボタンを無効にします。

function sl_customization(cm)

% Disable for standalone Configuration Parameters dialog box 
configset.dialog.Customizer.addCustomization(@disableRTWBrowseButton,cm);

end

function disableRTWBrowseButton(dialogH)
  hSrc   = dialogH.getSource;  % Simulink.RTWCC
  hModel = hSrc.getModel;
  modelName   = get_param(hModel,'Name');

  if ~isempty(strfind(modelName,'engine'))
    % Takes a cell array of widget Factory ID.
    dialogH.disableWidgets({'STF_Browser'})
  end

end

このカスタマイズをテストするには、以下のようにします。

MATLAB パス上に sl_customization.m ファイルを保存します。
コマンドラインで「sl_refresh_customizations」を入力するか、MATLAB を再起動して、カスタマイズを更新します (Simulink でのカスタマイズの登録を参照)。
Triggered Subsystem を使用したエンジンタイミングのモデル化の例で sldemo_engine モデルを開きます。
[コンフィギュレーションパラメーター] ダイアログボックスを開き、[コード生成] ペインを調べて [参照] ボタンが無効になっているかどうかを確認します。

コントロールカスタマイズコールバック関数の記述

ダイアログボックス上のコントロールを無効化または非表示にするためのコールバック関数は、1 つの引数 (無効または非表示にするコントロールを含むダイアログボックスオブジェクトに対するハンドル) を受け入れます。ダイアログボックスオブジェクトは、ダイアログボックスが含むコントロールを無効にしたり非表示にするために、コールバック関数が使用できるメソッドを提供します。

ダイアログボックスオブジェクトは、現在のモデルについての情報を含むオブジェクトへのアクセスも提供します。ユーザーのコールバック関数はこれらのオブジェクトを使用して、コントロールを無効化または非表示にするかどうかを決めることができます。たとえば、このコールバック関数は、これらのオブジェクトを使用して、名前に engine を含むモデルに対し、[コンフィギュレーションパラメーター] ダイアログボックスの [コード生成] ペインの [参照] ボタンを無効にします。

function disableRTWBrowseButton(dialogH)

  hSrc = dialogH.getSource;  % Simulink.RTWCC
  hModel = hSrc.getModel;
  modelName = get_param(hModel,'Name');

  if ~isempty(strfind(modelName,'engine'))
     % Takes a cell array of widget Factory ID.
     dialogH.disableWidgets({'STF_Browser'})
  end

ダイアログボックスメソッド

ダイアログボックスオブジェクトは、コントロールの有効化、無効化、非表示化のために、次のメソッドを提供します。

disableWidgets(widgetIDs)
hideWidgets(widgetIDs)

ここで、widgetIDs は、無効または非表示にするウィジェットを指定するウィジェット ID の cell 配列 (ウィジェット IDを参照) です。

ウィジェット ID

ウィジェット ID は、Simulink ダイアログボックスのコントロールを識別します。特定のコントロールに対するウィジェット ID を決めるためには、コマンドラインで次のコードを実行します。

cm = sl_customization_manager;
cm.showWidgetIdAsToolTip = true

コントロールを含むダイアログボックスを開いて、コントロールの上にカーソルを合わせ、ウィジェット ID を一覧表示するツールヒントを表示します。たとえば、[コンフィギュレーションパラメーター] の [ソルバー] ペインの [開始時間] フィールドの上にカーソルを合わせると、[開始時間] フィールドの widget ID が StartTime であると表示されます。

In the Configuration Parameters dialog box, the pointer is paused on the Start time text box. A tooltip lists the widget ID as StartTime and the tag as Tag_ConfigSet_Solver_StartTime.

メモ

カスタマイズできないコントロールの場合は、ツールヒントに not customizable と表示されます。

コントロールカスタマイズコールバック関数の登録

Simulink のインストールに対して、コントロールカスタマイズコールバック関数を登録するには、コールバックで configset.dialog.Customizer.addCustomization メソッドを呼び出すインストールの sl_customization.m ファイル (Simulink でのカスタマイズの登録を参照) のコードを含めます。

このメソッドは登録するコールバック関数へのポインターを引数として取ります。このメソッドを呼び出すと、ダイアログボックスが開く前に登録された関数が呼び出されます。

この例では、[コンフィギュレーションパラメーター] ダイアログボックスの [コード生成] ペインの [参照] ボタンを無効にするコールバックを登録します (コントロールカスタマイズコールバック関数の記述を参照)。

function sl_customization(cm)  

% Disable for standalone Configuration Parameters dialog box 
configset.dialog.Customizer.addCustomization(@disableRTWBrowseButton,cm);

end

メモ

カスタマイズコールバックを登録することにより、Simulink は、メソッドのダイアログボックス ID 引数によって指定されるダイアログボックスのクラスの各インスタンスについてコールバックを起動します。したがって、1 つのコールバックを使用して、ダイアログボックスの全クラスに対するコントロールを無効または非表示にすることができます。特に、1 つのコールバックを使用して、大部分の組み込みブロックに共通するパラメーターのコントロールを無効または非表示にすることができます。大部分の組み込みブロックダイアログボックスが、同じダイアログボックスのスーパークラスのインスタンスです。