uiconfirm

確認ダイアログボックスの作成

構文

uiconfirm(fig,message,title)

uiconfirm(fig,message,title,Name,Value)

selection = uiconfirm(___)

説明

uiconfirm(fig,message,title) は、指定されたターゲット Figure にモーダルのアプリ内確認ダイアログボックスを表示します。この構文では、ユーザーが選択できるオプションとして [OK] と [キャンセル] の 2 つが表示されます。ダイアログボックスが開いている間は、ダイアログボックスの背後の Figure にはアクセスできませんが、MATLAB^® コマンドプロンプトはアクセス可能です。

uiconfirm(fig,message,title,Name,Value) は、ダイアログボックスの外観と動作をカスタマイズするための Name,Value の引数を 1 つ以上使用して、確認ダイアログボックスを表示します。たとえば、既定の [OK] と [キャンセル] の代わりに、ダイアログボックスのオプションのカスタムセットを指定することができます。

例

selection = uiconfirm(___) は、ユーザーの選択内容を文字ベクトルとして返します。前述の構文のいずれかで出力引数 selection を指定します。この構文を使用すると、ダイアログボックスが開いている間は MATLAB コマンドプロンプトにアクセスできません。

例

すべて折りたたむ

別のアイコンの指定

既定の疑問符アイコンではなく警告アイコンを表示するダイアログボックスを作成します。

fig = uifigure;
selection = uiconfirm(fig, ...
    "Close document?","Confirm Close", ...
    "Icon","warning");

ユーザーがオプションを選択すると、uiconfirm はその選択内容を文字ベクトルとして返します。

カスタムオプションの指定

次の 3 つのオプションがある確認ダイアログを作成します。[Overwrite]、[Save as new]、[Cancel]。[Save as new] を既定のオプションとして指定し、[Cancel] をキャンセル動作に対応するオプションとして指定します。

fig = uifigure;
msg = "Saving these changes will overwrite previous changes.";
title = "Confirm Save";
selection = uiconfirm(fig,msg,title, ...
    "Options",["Overwrite","Save as new","Cancel"], ...
    "DefaultOption",2,"CancelOption",3);

Figure window with a confirmation dialog box asking the user to confirm their save. There are three options. The second option, "Save as new", is highlighted in blue.

ユーザーがオプションを選択すると、uiconfirm はその選択内容を文字ベクトルとして返します。

書式設定された式の表示

PolarAxes オブジェクト、および LaTeX を使用して書式設定された式を表示する確認ダイアログボックスをもつ Figure を作成します。ユーザーが [OK] をクリックしたときに、ダイアログボックスの選択項目を処理して式をプロットするコードを含めます。

fig = uifigure;
ax = polaraxes(fig);
msg = "Do you want to plot $$r = \exp \left(\frac{\theta}{10}\right)?$$";
selection = uiconfirm(fig,msg,"Plot equation","Interpreter","latex");
switch selection
    case 'OK'
        theta = -100:0.1:0;
        r = exp(theta/10);
        polarplot(ax,theta,r);
    case 'Cancel'
        return
end

$Figure window with a polar axes and a dialog box asking if you want to plot a polar equation.$

[OK] をクリックして式をプロットします。

$Figure window with a spiral curve plotted on a polar axes.$

`CloseFcn` コールバックの定義

名前と値の引数 CloseFcn は、ダイアログボックスを閉じるときに特定のタスクを実行する場合に便利です。

MATLAB エディターで、次のコードを含むスクリプトを作成します。このコードは Figure を作成し、figcallback および dlgcallback という名前の 2 つのコールバック関数を定義します。

関数 figcallback は、ユーザーが Figure ウィンドウを閉じようとするときに実行されます。この関数は Figure ウィンドウに確認ダイアログボックスを作成し、関数 dlgcallback をダイアログボックスの CloseFcn コールバックとして指定します。
関数 dlgcallback は、ダイアログボックスを閉じるときに実行されます。この関数は、MATLAB が 2 番目の引数としてコールバック関数に渡す event という struct 内の SelectedOption フィールドにアクセスします。ユーザーが [OK] を選択すると、関数は Figure ウィンドウを閉じます。

fig = uifigure("CloseRequestFcn",@figcallback);

function figcallback(src,event)
    uiconfirm(src,"Close app?","Confirm Close", ...
        "CloseFcn",@dlgcallback);
end

function dlgcallback(src,event)
    if event.SelectedOption == "OK"
        delete(event.Source)
    end
end

スクリプトを実行し、Figure ウィンドウを閉じてみます。確認ダイアログボックスが作成されます。

Figure window with a confirmation dialog box that says "Close app?"

コールバック関数の指定の詳細については、プログラムで作成したアプリ用のコールバックの作成を参照してください。

App Designer でのダイアログボックスの作成

アプリを閉じるかユーザーに確認を求める確認ダイアログボックスを App Designer で作成します。

ユーザーが [OK] を選択したときにアプリの Figure ウィンドウを閉じる、確認ダイアログボックス用の CloseFcn コールバックを記述します。まず App Designer の [コードビュー] で、[関数] 、 [プライベート関数] を選択して、プライベート関数を作成します。次に、次のコードと一致するようにプライベート関数を記述します。

function mycallback(app,src,event)
    if event.SelectedOption == "OK"
        delete(app.UIFigure);
    end
end

最後に、ユーザーがアプリを閉じようとしたときにダイアログボックスを表示するため、Figure ウィンドウ用の CloseRequestFcn コールバックを作成します。[コールバック] をクリックし、[app.UIFigure] をコンポーネントとして、[CloseRequestFcn] をコールバックとして選択してから、[コールバックの追加] をクリックします。App Designer が作成したコールバック関数の本体を次のコードに置き換えます。

uiconfirm(app.UIFigure,'Close document?','Confirm Close', ...
            'CloseFcn',@app.mycallback);

アプリを保存して実行します。確認ダイアログボックスを作成するため、アプリウィンドウを閉じてみます。

Figure window with a confirmation dialog box that says "Close app?"

プログラムによるコンポーネントの作成およびコールバック関数の指定の詳細については、プログラムによる App Designer への UI コンポーネントの追加を参照してください。

入力引数

すべて折りたたむ

`fig` — ターゲット Figure
`Figure` オブジェクト

ターゲット Figure。Figure オブジェクトとして指定します。

`message` — 表示するメッセージ
文字ベクトル | 文字ベクトルの cell 配列 | string 配列

表示するメッセージ。文字ベクトル、文字ベクトルの cell 配列または string 配列として指定します。メッセージが複数行のテキストとなる場合は、cell 配列または string 配列を指定します。配列の各要素は、テキストの各行に対応します。

`title` — ダイアログボックスのタイトル
文字ベクトル | string スカラー

ダイアログボックスのタイトル。文字ベクトルまたは string スカラーとして指定します。

名前と値の引数

すべて折りたたむ

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

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

例: selection = uiconfirm(fig,message,title,'Options',{'Save','Delete','Quit'}) は、ダイアログボックスのカスタムオプションを 3 つ指定します。

`Options` — カスタムオプション
`{'OK','Cancel'}` (既定値) | 文字ベクトルの cell 配列 | string 配列

カスタムオプション。文字ベクトルの cell 配列または string 配列として指定します。

`Icon` — アイコン
`'question'` (既定値) | 事前定義されているアイコン | カスタムアイコン

アイコン。事前定義されているアイコンまたはカスタムアイコンとして指定します。

事前定義されているアイコン

次の表は、事前定義されているアイコンを示す値の一覧です。たとえば、チェックマークのアイコンを表示するには、名前と値のペア 'Icon','success' を指定します。

値	アイコン
`'question'` (既定)
`'info'`
`'success'`
`'warning'`
`'error'`
`''`	アイコンは表示されません。

カスタムアイコン

カスタムアイコンを次の値のいずれかとして指定します。

MATLAB パス上にある SVG、JPEG、GIF または PNG イメージのファイル名を指定する文字ベクトル。あるいは、イメージファイルの絶対パスを指定することもできます。
トゥルーカラーイメージ配列。詳細については、MATLAB でのイメージタイプの処理を参照してください。

`DefaultOption` — 既定のオプション
`1` (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

既定のオプション。文字ベクトル、string スカラー、または 0 または正の整数として指定します。既定のオプションは、既定でフォーカスされるダイアログボックスのボタンに対応します。

文字ベクトルまたは string スカラーを指定する場合、配列 Options のいずれかの要素と一致していなければなりません。ただし、Options 引数を使用せずに uiconfirm を呼び出す場合、DefaultOption は 'OK' または 'Cancel' でなければなりません。

0 または正の整数を指定する場合、[1, n] (n は配列 Options の長さ) の範囲になければなりません。Options 引数を使用せずに uiconfirm を呼び出す場合、DefaultOption は 1 または 2 でなければなりません。

`CancelOption` — キャンセルオプション
`2` (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

キャンセルオプション。文字ベクトル、string スカラー、または 0 または正の整数として指定します。キャンセルオプションは、ダイアログボックスでどのオプションがキャンセル操作に対応するかを指定します。

文字ベクトルまたは string スカラーを指定する場合、配列 Options のいずれかの要素と一致していなければなりません。ただし、Options 引数を使用せずに uiconfirm を呼び出す場合、CancelOption は 'OK' または 'Cancel' でなければなりません。

0 または正の整数を指定する場合、[1, n] (n は配列 Options の長さ) の範囲になければなりません。Options 引数を使用せずに uiconfirm を呼び出す場合、CancelOption は 1 または 2 でなければなりません。

`CloseFcn` — クローズコールバック関数
`''` (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

クローズコールバック関数。次の値のいずれかとして指定します。

関数ハンドル。
最初の要素が関数ハンドルである cell 配列。cell 配列内のその後の要素はコールバック関数に渡される引数です。
有効な MATLAB 式を含む文字ベクトル (非推奨)。MATLAB は、この式をベースワークスペースで評価します。

このコールバックは、ダイアログボックスを閉じるときに特定のタスクを実行する場合に便利です。

CloseFcn を関数ハンドル (または関数ハンドルを含む cell 配列) で指定した場合、MATLAB はイベントデータを含む struct をコールバック関数の入力引数として渡します。この struct には、次の表に示すフィールドが含まれています。

構造体フィールド	値
`Source`	ダイアログボックスに関連付けられる `Figure` オブジェクト。
`EventName`	`'ConfirmDialogClosed'`
`DialogTitle`	ダイアログボックスのタイトル。
`SelectedOptionIndex`	選択したオプションのインデックス。`n` 個のオプションに対して、インデックスは `1` から `n` までの任意の正の整数にできます。
`SelectedOption`	選択したオプションのボタンラベル。文字ベクトルとして返されます。

コールバック関数の指定の詳細については、プログラムで作成したアプリ用のコールバックの作成を参照してください。

`Interpreter` — ダイアログテキストのインタープリター
`'none'` (既定値) | `'tex'` | `'latex'` | `'html'`

ダイアログテキストのインタープリター。次のいずれかとして指定します。

'none' — リテラル文字を表示します。
'tex' — TeX マークアップのサブセットを使用してテキストを解釈します。
'latex' — LaTeX マークアップのサブセットを使用してテキストを解釈します。
'html' — HTML マークアップのサブセットを使用してテキストを解釈します。

TeX マークアップ

TeX マークアップを使用して、上付き文字や下付き文字の追加、テキストへの特殊文字の挿入を行うことができます。

修飾子の効果はテキストの末尾まで適用されます。上付き文字と下付き文字は例外であり、次の 1 文字または中かっこで囲まれた文字にのみ適用されます。インタープリターを "tex" に設定した場合にサポートされる修飾子は次のとおりです。

修飾子	説明	例
`^{ }`	上付き文字	`"text^{superscript}"`
`_{ }`	下付き文字	`"text_{subscript}"`
`\bf`	太字フォント	`"\bf text"`
`\it`	イタリックフォント	`"\it text"`
`\sl`	斜体フォント (通常はイタリックフォントと同じ)	`"\sl text"`
`\rm`	標準フォント	`"\rm text"`
`\fontname{specifier}`	フォント名 — `specifier` をフォントファミリの名前に置き換えます。これは他の修飾子と組み合わせて使用できます。	`"\fontname{Courier} text"`
`\fontsize{specifier}`	フォントサイズ — `specifier` をポイント単位の数値スカラーに置き換えます。	`"\fontsize{15} text"`
`\color{specifier}`	フォントの色 — `specifier` を、`red`、`green`、`yellow`、`magenta`、`blue`、`black`、`white`、`gray`、`darkGreen`、`orange`、`lightBlue` の色のいずれかに置き換えます。	`"\color{magenta} text"`
`\color[rgb]{specifier}`	フォントのカスタムの色 — `specifier` を RGB 3 成分に置き換えます。	`"\color[rgb]{0,0.5,0.5} text"`

次の表に、"tex" インタープリターでサポートされる特殊文字を示します。

文字列	記号	文字列	記号	文字列	記号
`\alpha`	α	`\upsilon`	υ	`\sim`	~
`\angle`	∠	`\phi`	ϕ	`\leq`	≤
`\ast`	`*`	`\chi`	χ	`\infty`	∞
`\beta`	β	`\psi`	ψ	`\clubsuit`	♣
`\gamma`	γ	`\omega`	ω	`\diamondsuit`	♦
`\delta`	δ	`\Gamma`	Γ	`\heartsuit`	♥
`\epsilon`	ϵ	`\Delta`	Δ	`\spadesuit`	♠
`\zeta`	ζ	`\Theta`	Θ	`\leftrightarrow`	↔
`\eta`	η	`\Lambda`	Λ	`\leftarrow`	←
`\theta`	θ	`\Xi`	Ξ	`\Leftarrow`	⇐
`\vartheta`	ϑ	`\Pi`	Π	`\uparrow`	↑
`\iota`	ι	`\Sigma`	Σ	`\rightarrow`	→
`\kappa`	κ	`\Upsilon`	ϒ	`\Rightarrow`	⇒
`\lambda`	λ	`\Phi`	Φ	`\downarrow`	↓
`\mu`	µ	`\Psi`	Ψ	`\circ`	º
`\nu`	ν	`\Omega`	Ω	`\pm`	±
`\xi`	ξ	`\forall`	∀	`\geq`	≥
`\pi`	π	`\exists`	∃	`\propto`	∝
`\rho`	ρ	`\ni`	∍	`\partial`	∂
`\sigma`	σ	`\cong`	≅	`\bullet`	•
`\varsigma`	ς	`\approx`	≈	`\div`	÷
`\tau`	τ	`\Re`	ℜ	`\neq`	≠
`\equiv`	≡	`\oplus`	⊕	`\aleph`	ℵ
`\Im`	ℑ	`\cup`	∪	`\wp`	℘
`\otimes`	⊗	`\subseteq`	⊆	`\oslash`	∅
`\cap`	∩	`\in`	∈	`\supseteq`	⊇
`\supset`	⊃	`\lceil`	⌈	`\subset`	⊂
`\int`	∫	`\cdot`	·	`\o`	ο
`\rfloor`	⌋	`\neg`	¬	`\nabla`	∇
`\lfloor`	⌊	`\times`	x	`\ldots`	...
`\perp`	⊥	`\surd`	√	`\prime`	´
`\wedge`	∧	`\varpi`	ϖ	`\0`	∅
`\rceil`	⌉	`\rangle`	〉	`\mid`	\|
`\vee`	∨	`\langle`	〈	`\copyright`	©

LaTeX マークアップ

LaTeX マークアップを使用して、数式、方程式、特殊文字を書式設定して表示します。ドル記号を使用してマークアップテキストを囲みます。たとえば、インラインモードでは '$\int_1^{20} x^2 dx$'、表示モードでは '$$\int_1^{20} x^2 dx$$' を使用します。

テキストは LaTeX の既定のフォントスタイルで表示され、フォントスタイルは LaTeX マークアップを使用して変更できます。

MATLAB では、大半の標準の LaTeX 数式モードコマンドがサポートされています。詳細については、サポートされる LaTeX コマンドを参照してください。

HTML マークアップ

HTML マークアップは、リンクの表示やフォントスタイルのカスタマイズに使用します。

インタープリターは HTML マークアップのサブセットをサポートします。一般的なガイドラインとして、インタープリターはテキスト関連のタグとスタイルをサポートします。サポートされないタグとスタイルは無視されます。

次の表に、サポートされる要素と要素の属性を一覧します。

HTML 要素	属性	説明
`a`	`style`, `target`, `href`, `title`	ハイパーリンク
`abbr`	`style`, `title`	略語または頭字語
`address`	`style`	連絡先情報
`article`	`style`	自己完結した単独のコンテンツ
`aside`	`style`	主な内容に間接的に関連するコンテンツ
`b`	`style`	太字フォント
`bdi`	`style`, `dir`	周囲のテキストとは異なる方向で書式設定されるコンテンツ
`bdo`	`style`, `dir`	周囲のテキストとは異なる方向で書式設定されるコンテンツ
`big`	`style`	周囲のテキストよりフォントサイズが 1 レベル大きいテキスト (HTML5 では旧式)
`blockquote`	`style`, `cite`	拡張された引用
`br`	N/A	改行
`caption`	`style`	テーブルのキャプションまたはタイトル
`center`	`style`	水平方向に中央揃えされたコンテンツ
`cite`	`style`	参照先のタイトル
`code`	`style`	コードのフラグメント
`col`	`style`, `align`, `valign`, `span`, `width`	テーブル内の列
`colgroup`	`style`, `align`, `valign`, `span`, `width`	テーブル内の列のグループ
`dd`	`style`	説明リストの用語または値
`del`	`style`, `datetime`	ドキュメントから削除されたテキスト
`details`	`style`, `open`	'開いた' 状態に切り替えた場合にのみテキストが表示される対話型ウィジェット
`dl`	`style`	説明リスト
`dt`	`style`	説明リストの用語または値
`em`	`style`	強調表示されるテキスト (通常、イタリックで表示)
`font`	`style`, `color`, `size`, `face`	指定したフォントプロパティのテキスト (HTML5 では旧式)
`footer`	`style`	フッター
`h1`. `h2`, `h3`, `h4`, `h5`, `h6`	`style`	セクション見出し — `<h1>` が見出しの最上位、`<h6>` が最下位
`header`	`style`	導入コンテンツ
`hr`	`style`	主題の区切り
`i`	`style`	周囲のコンテンツからのテキストオフセット — 既定の設定ではイタリックとしてレンダリングされる
`ins`	`style`, `datetime`	ドキュメントに挿入されたテキスト
`li`	`style`	リスト内の項目
`mark`	`style`	マークアップテキストまたは強調表示されたテキスト
`ol`	`style`	順序付きリスト
`p`	`style`	段落
`pre`	`style`	書式設定済みテキスト
`s`	`style`	取り消し線付きのテキスト
`strike`	`style`	取り消し線付きのテキスト (HTML5 では旧式)
`section`	`style`	独立したセクション
`small`	`style`	周囲のテキストよりフォントサイズが 1 レベル小さいテキスト (HTML5 では旧式)
`sub`	`style`	下付き文字
`sup`	`style`	上付き文字
`strong`	`style`	重要度が高いテキスト
`table`	`style`, `width`, `border`, `align`, `valign`	テーブル
`tbody`	`style`, `align`, `valign`	テーブル本体
`td`	`style`, `width`, `rowspan`, `colspan`, `align`, `valign`	テーブルデータセル
`tfoot`	`style`, `align`, `valign`	テーブル列をまとめる一連のテーブル行
`th`	`style`, `width`, `rowspan`, `colspan`, `align`, `valign`	セルのグループのヘッダーとして指定されたテーブルデータセル
`thead`	`style`, `align`, `valign`	列見出しを指定する一連のテーブル行
`tr`	`style`, `rowspan`, `align`, `valign`	テーブルセルの行
`tt`	`style`	固定幅テキスト (HTML5 では旧式)
`u`	`style`	非言語的注釈を使用するテキスト — 既定の設定では下線としてレンダリングされる
`ul`	`style`	順序なしリスト

これらの要素の詳細については、https://developer.mozilla.org/en-US/docs/Web/HTML/Elementを参照してください。

MATLAB コードを実行するハイパーリンクを作成するために HTML マークアップを使用するには、関数を実行するハイパーリンクの作成を参照してください。

HTML スタイル属性を使用して HTML コンテンツを書式設定できます。スタイル属性は CSS 属性とその値の文字列です。

以下の CSS 属性がサポートされています。

background-color
border-bottom
border-bottom-color
border-bottom-left-radius
border-bottom-right-radius
border-bottom-style
border-bottom-width
border-left
border-left-color
border-left-style
border-left-width
border-radius
border-right
border-right-color
border-right-style
border-right-width
border-spacing
border-style
border-top
border-top-color
border-top-left-radius
border-top-right-radius
border-top-style
border-top-width
border-width
color
direction
font-family
font-size
font-style
font-weight
height
hidden
line-height
margin
margin-bottom
margin-left
margin-right
margin-top
max-height
max-width
min-height
min-width
overflow
overflow-wrap
overflow-x
overflow-y
padding
padding-bottom
padding-left
padding-right
padding-top
text-align
text-anchor
text-decoration
text-indent
text-overflow
text-shadow
text-transform
title
translate
white-space
width

これらの属性の詳細については、https://developer.mozilla.org/en-US/docs/Web/CSS/Referenceを参照してください。

バージョン履歴

R2017b で導入

すべて展開する

R2021b: テキストのスタイル設定および方程式の表示

名前と値の引数 Interpreter を使用して、ダイアログボックスのテキストのマークアップを有効にします。インタープリターを 'html'、'latex'、'tex'、または 'none' として指定します。

参考

uialert | questdlg | uifigure | uiprogressdlg

uiconfirm

構文

説明

例

別のアイコンの指定

カスタム オプションの指定

書式設定された式の表示

CloseFcn コールバックの定義

App Designer でのダイアログ ボックスの作成

入力引数

fig — ターゲット Figure Figure オブジェクト

message — 表示するメッセージ 文字ベクトル | 文字ベクトルの cell 配列 | string 配列

title — ダイアログ ボックスのタイトル 文字ベクトル | string スカラー

名前と値の引数

Options — カスタム オプション {'OK','Cancel'} (既定値) | 文字ベクトルの cell 配列 | string 配列

Icon — アイコン 'question' (既定値) | 事前定義されているアイコン | カスタム アイコン

事前定義されているアイコン

カスタム アイコン

DefaultOption — 既定のオプション 1 (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

CancelOption — キャンセル オプション 2 (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

CloseFcn — クローズ コールバック関数 '' (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

Interpreter — ダイアログ テキストのインタープリター 'none' (既定値) | 'tex' | 'latex' | 'html'

TeX マークアップ

LaTeX マークアップ

HTML マークアップ

バージョン履歴

R2021b: テキストのスタイル設定および方程式の表示

参考

カスタムオプションの指定

`CloseFcn` コールバックの定義

App Designer でのダイアログボックスの作成

`fig` — ターゲット Figure
`Figure` オブジェクト

`message` — 表示するメッセージ
文字ベクトル | 文字ベクトルの cell 配列 | string 配列

`title` — ダイアログボックスのタイトル
文字ベクトル | string スカラー

`Options` — カスタムオプション
`{'OK','Cancel'}` (既定値) | 文字ベクトルの cell 配列 | string 配列

`Icon` — アイコン
`'question'` (既定値) | 事前定義されているアイコン | カスタムアイコン

カスタムアイコン

`DefaultOption` — 既定のオプション
`1` (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

`CancelOption` — キャンセルオプション
`2` (既定値) | 文字ベクトル | string スカラー | 0 または正の整数

`CloseFcn` — クローズコールバック関数
`''` (既定値) | 関数ハンドル | cell 配列 | 文字ベクトル

`Interpreter` — ダイアログテキストのインタープリター
`'none'` (既定値) | `'tex'` | `'latex'` | `'html'`