uitoggletool

ツールバーのトグルツール

構文

tt = uitoggletool

tt = uitoggletool(parent)

tt = uitoggletool(___,Name,Value)

説明

tt = uitoggletool は、現在の Figure のツールバーにトグルツールを作成し、ToggleTool オブジェクトを返します。

現在の Figure は関数 figure で作成されたものでなければなりません。現在の Figure が子ツールバーを持たない場合、MATLAB^® は親として機能する現在の Figure にこれを作成します。関数 figure を使用して作成された Figure が存在しない場合、MATLAB はこれを作成して関数 uitoolbar を呼び出し、親として機能するツールバーを作成します。

トグルツールには、'off' または 'on' の 2 つの状態があります。ボタンの状態はクリックするたびに変更されます。

例

tt = uitoggletool(parent) は、指定した親ツールバーにトグルツールを作成します。

例

tt = uitoggletool(___,Name,Value) は、1 つ以上の名前と値のペアの引数を使用して指定されたプロパティ値をもつトグルツールを作成します。前述の構文のいずれかを使用して、名前と値のペアを指定します。

例

すべて折りたたむ

Figure ツールバーのトグルツールの作成

関数 figure を呼び出し、Figure を作成します。Figure にツールバーを追加します。Figure の既定のツールバーの下に表示されます。

f = figure;
tb = uitoolbar(f);

Figure that displays the default toolbar and another empty toolbar below it.

ツールバーにトグルツールを作成します。そのアイコンとして、ゼロの 16×16×3 の配列を作成します。この配列に CData プロパティの値を設定し、トグルツールに黒の四角形のアイコンを表示させます。

tt = uitoggletool(tb);
ttImage = zeros(16,16,3);
tt.CData = ttImage;

Figure that displays the default toolbar and a custom toolbar below it. The custom toolbar displays a black square as a toggle tool.

UI Figure の色を変更するトグルツールの作成

クリックするたびに UI figure のアイコンと背景色を変えるトグルツールを作成します。

まず、toggleColor.m というプログラムファイルを作成します。プログラムファイル内で次を行います。

UI figure を作成します。
UI figure にツールバーを作成します。
ツールバーにトグルツールを追加します。
青色のトゥルーカラーイメージ配列を作成します。それにトグルツールの Icon プロパティ値を設定します。
toggleFigureColor というコールバック関数を参照する ClickedCallback プロパティを関数ハンドルに設定します。
toggleFigureColor というコールバック関数を作成します。その中で、トグルツールの State プロパティの値をクエリします。状態が 'on' の場合、Figure の背景色を青色に変更し、トグルツールを黒色にします。同様に、状態が 'off' の場合は、Figure の背景色を黒色に変更し、トグルツールを青色にします。

function toggleColor
fig = uifigure;
tb = uitoolbar(fig);
tt = uitoggletool(tb);

ttImage = zeros(16,16,3);
ttImage(:,:,3) = ones(16);
tt.Icon = ttImage;
tt.ClickedCallback = @toggleFigureColor;

    function toggleFigureColor(src,event)
        state = src.State;
        
        if strcmp(state,'on')
            fig.Color = 'blue';
            tt.Icon = zeros(16,16,3);
        else
            fig.Color = 'black';
            tt.Icon = ttImage;
        end
        
    end

end

toggleColor を実行します。トグルツールをクリックし、Figure の背景色を変更します。

toggleColor

UI figure that displays a toolbar and a toggle tool with a blue square icon.

入力引数

すべて折りたたむ

`parent` — 親ツールバー
`Toolbar` オブジェクト

親ツールバー。Toolbar オブジェクトとして指定します。このプロパティを使用して、トグルツールの作成時に親ツールバーを指定したり、既存のツールを別のツールバーに移動したりします。

親ツールバーが指定されていない場合、MATLAB はトグルツールを現在の Figure のツールバーに作成します。現在の Figure は関数 figure で作成されたものでなければなりません。現在の Figure に子ツールバーがない場合、MATLAB は親として機能する現在の Figure にこれを作成します。MATLAB は、Figure の既定のツールバーにトグルツールを作成しません。

関数 figure を使用して作成された Figure が存在しない場合、MATLAB はこれを作成して関数 uitoolbar を呼び出し、親として機能するツールバーを作成します。

複数のプッシュツールまたはトグルツールをツールバーに追加した場合、作成した順に左から右に追加されます。

名前と値の引数

引数のオプションのペアを Name1=Value1,...,NameN=ValueN として指定します。ここで Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後になければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用してそれぞれの名前と値を区切り、Name を引用符で囲みます。

例: 'Separator','on' は区切りのラインモードを 'on' に設定します。

メモ

ここでは、プロパティの一部だけを紹介しています。完全な一覧については、ToggleTool のプロパティを参照してください。

`State` — トグルツールの状態
`'off'` (既定値) | on/off logical 値

トグルボタンの状態。'off' または 'on'、もしくは数値または logical 0 (false) または 1 (true) として指定します。'on' の値は true と等価であり、'off' は false と等価です。したがって、このプロパティの値を logical 値として使用できます。値は matlab.lang.OnOffSwitchState 型の on/off logical 値として格納されます。

このプロパティ値が 'on' のとき、トグルボタンは下の (押された) 位置に表示されます。このプロパティ値が 'off' のとき、トグルボタンは上の位置に表示されます。状態を変更すると、適切な関数 OnCallback または OffCallback が実行されます。

`Icon` — アイコンのソースまたはファイル
`''` (既定値) | 文字ベクトル | string スカラー | `m`×`n`×3 のトゥルーカラーイメージ配列

アイコンのソースまたはファイル。文字ベクトル、string スカラー、または m×n×3 のトゥルーカラーイメージ配列として指定します。文字ベクトルまたは string スカラーには、MATLAB パス上のイメージファイル名、あるいはイメージファイルへの絶対パスを指定できます。他のユーザーとアプリを共有する予定の場合は、アプリのパッケージ化を容易にするためにイメージファイルを MATLAB パス上に配置します。サポートされるイメージの形式には JPEG、PNG、GIF、および SVG があります。

m×n×3 の配列を指定すると、トゥルーカラーイメージ配列として解釈されます。トゥルーカラーイメージ配列の詳細については、イメージの種類を参照してください。

指定するイメージが 16 x 16 ピクセルよりも大きい場合、Icon プロパティはそのイメージをスケールダウンしてツール内に収まるようにします。指定するイメージが 16 x 16 ピクセルよりも小さい場合、使用できるスペースに合わせるスケールアップは行われません。

Icon プロパティは App Designer と uifigure ベースのアプリでのみサポートされます。Icon プロパティと CData プロパティが共に指定されている場合、CData プロパティは無視されます。

例: 'icon.png' は MATLAB パス上のイメージファイルを指定します。

例: 'C:\Documents\icon.png' は、イメージファイルへの絶対パスを指定します。

`CData` — イメージ配列
`[]` (既定値) | `m`×`n`×3 のトゥルーカラーイメージ配列

イメージ配列。m×n×3 のトゥルーカラーイメージ配列として指定します。配列の値は以下のいずれかになります。

0.0 ～ 1.0 の倍精度値
0 ～ 255 の uint8 値

イメージがクリップされたり歪みが発生するのを避けるため、m および n が 16 以下の配列を指定します。イメージがクリップされると、配列の中央の 16 行 16 列の部分のみが使用されます。

メモ

App Designer および uifigure ベースのアプリでは、代わりに Icon プロパティを使用してプッシュツールとトグルツールのアイコンを指定します。

ヒント

Toolbar オブジェクト (およびその子 PushTool オブジェクトおよび ToggleTool オブジェクト) は、WindowStyle プロパティが 'modal' に設定されている Figure には表示されません。ツールバーの子を含む Figure の WindowStyle が 'modal' に変更された場合、ツールバーの子は Figure の Children プロパティに依然として存在します。ただし、WindowStyle が 'modal' に設定されている間、このツールバーは表示されません。