xbot.app.dialog

この記事の内容
  1. show_alert()
  2. show_confirm()
  3. show_custom_dialog()
  4. show_message_box()
  5. show_workbook_dialog()
  6. show_notifycation()

各種ダイアログを呼び出して、Dr.Roboのロボットと対話します。メッセージダイアログやカスタムダイアログなどがあります。

show_alert()

メッセージダイアログを開きます。

show_alert(message, title='提示')

パラメータ

message:メッセージダイアログに表示する内容です。

title:メッセージダイアログのタイトルです。省略時のデフォルト値は「提示」(お知らせ)です。

戻り値

なし

例1

from xbot import app
def main(args):
    app.dialog.show_alert('hello world', 'お知らせ')

表示結果の図:

この例の実行ロジック: メッセージダイアログを開き、ダイアログのタイトルを「お知らせ」、内容を「hello world」に設定します。

show_confirm()

確認ダイアログを開きます。

show_confirm(message, title='请确认')

パラメータ

message:確認ダイアログに表示する内容です。

title:確認ダイアログのタイトルです。デフォルト値は「请确认」(確認してください)です。

戻り値

bool:確認ダイアログでの選択結果を返します。確認を選択するとTrue、それ以外の場合はFalseを返します。

例1

from xbot import app
def main(args):
    is_confirm = app.dialog.show_confirm('hello world')
    print(is_confirm)

表示結果:

この例の実行ロジック: 内容が「hello world」の確認ダイアログを開きます。 --> ダイアログでの操作結果を出力します。

show_custom_dialog()

カスタムダイアログを開きます。

show_custom_dialog(settings)

入力パラメータ

settings :カスタムダイアログ設定のJSON文字列です。JSONには主にダイアログのタイトルとカスタムコントロールの設定を含めます。JSONの構造は次のとおりです。

{
            "dialog_title": "ページタイトル",
            "default_btn": "确定",
            "use_wait_timeout":True,
            "timeout":10,
            "settings":
            {
                "editors":[{"type":"CheckBox"},{"label":"チェックボックス"},...]
            }
        }
  • dialog_title:ダイアログのタイトルです。空にできます。
  • default_btn、use_wait_timeout:ダイアログの表示時間がタイムアウトしたときに、デフォルトでクリックするボタンを指定します。
  • timeout:タイムアウト時の自動クリックを有効にした場合のタイムアウト時間です。0に設定すると「待機しない」、-1に設定すると「無期限に待機する」ことを意味します。
  • editors:カスタムダイアログに具体的なコントロールを設定します。パラメータの構造は「リスト+辞書」です。1つの辞書が1つのカスタムコントロールを表します。現在サポートされているカスタムコントロールのタイプは次のとおりです。
パラメータ名 カスタムコントロール
TextBox 入力ボックス
Number 数値ボックス
Password パスワードボックス
TextArea テキストエリア(複数行テキスト)
Label テキストラベル
CheckBox チェックボックス
Select ドロップダウンリスト
MultiSelect 複数選択ドロップダウンリスト
Date 日付コントロール
File ファイル選択コントロール
List リスト
MultiList 複数選択リスト
DataGrid データテーブル

各カスタムコントロールに対応する辞書には、次のパラメータを渡せます。

パラメータ 説明
type カスタムコントロールのタイプです。
label カスタムコントロールのタイトルです。
nullText 空欄時の案内メッセージです。コントロールにデフォルト値がない場合に表示します。主に入力ボックス、パスワードボックス、テキストエリア などの入力コントロールで使用します。空にできます。
value プログラム実行時のコントロールのデフォルト値です。空にできます。

コントロールの辞書に必須の上記4つのパラメータに加えて、一部の特殊なカスタムコントロールには固有のパラメータもあります。以下にそれぞれ示します。

ドロップダウンリストコントロールの固有のパラメータは次のとおりです。

パラメータ 説明
kind ファイル選択コントロールの種類です。OpenFile(ファイルを選択)、SaveFile(ファイルを保存)、SelectFolder(フォルダーを保存)から選択できます。

戻り値

object_dict:カスタムダイアログの処理結果を辞書型で返します。

例1

from xbot import app


def main(args):
    value = app.dialog.show_custom_dialog({"dialog_title": "hello", 
                                           "default": "确定",
                                           "use_wait_timeout":True,
                                           "timeout": 10,
                                           "settings": 
                                           {
                                               "editors": [
                                                {
                                                    "type": "TextBox", 
                                                    "label": "入力ボックス", 
                                                    "nullText": None, 
                                                    "value": "hello world"
                                                }]
                                            }
                                          })
    print(value)

この例の実行ロジック: カスタムダイアログを開いて「入力ボックス」を表示し、ユーザーの操作を待機します。10秒を超えてもユーザーが操作しない場合は、デフォルトで「确定」(確認)ボタンを押して処理します。 --> カスタムダイアログが返した処理結果を出力します。

例2

from xbot import app
def main(args):
    value = app.dialog.show_custom_dialog({"dialog_title":"hello",
                                        "settings":{
                                            "editors":[
                                                {
                                                    "type":"CheckBox",
                                                    "label":"チェックボックス",
                                                    "value":True
                                                }
                                            ]
                                        }
                                       })
    print(value)

この例の実行ロジック: カスタムダイアログを開いて「チェックボックス」を表示し、デフォルトでチェックボックスにチェックを入れます。 --> カスタムダイアログが返した処理結果を出力します。

例3

from xbot import app
def main(args):
    value = xbot.app.dialog.show_custom_dialog({"dialog_title":"hello",
                                        "settings":{
                                            "editors":[
                                                {
                                                    "type":"Select",
                                                    "label":"ドロップダウンリスト",
                                                    "value":"2",
                                                    "options":[
                                                        {
                                                            "display":"選択肢1",
                                                            "value":"1"
                                                        },
                                                        {
                                                            "display":"選択肢2",
                                                            "value":"2"
                                                        }
                                                    ]
                                                }
                                            ]
                                        }
                                       })

この例の実行ロジック: カスタムダイアログを開いてドロップダウンリストを表示し、デフォルトで「選択肢2」の項目を選択します。 --> カスタムダイアログが返した処理結果を出力します。

例4

from xbot import app
def main(args):
    value = app.dialog.show_custom_dialog({"dialog_title":"hello",
                                        "settings":{
                                            "editors":[
                                                {
                                                    "type":"Password",
                                                    "label":"パスワードボックス",
                                                    "nullText":None,
                                                    "value":"123"
                                                },
                                                {
                                                    "type":"TextArea",
                                                    "label":"テキストエリア",
                                                    "nullText":"hello world",
                                                    "value":None                                                    
                                                },
                                                {
                                                    "type":"Date",
                                                    "label":"日時",
                                                    "value":"2020/04/18",
                                                },
                                                {
                                                    "type":"File",
                                                    "label":"ファイル選択コントロール",
                                                    "nullText":"ファイルを選択してください",
                                                    "kind":"OpenFile"
                                                }
                                            ]
                                        }
                                       })
    print(value)

この例の実行ロジック: カスタムダイアログを開いて、パスワードボックス、テキストエリア入力ボックス、日時選択ボックス、ファイル選択ボックスを表示します。 --> カスタムダイアログが返した処理結果を出力します。

show_message_box()

メッセージダイアログを開きます。

show_message_box(title, message, button='ok', * , timeout=-1, default_button=None)

パラメータ

title:メッセージダイアログのタイトルです。

message:メッセージダイアログに表示する情報です。

dialog_result:メッセージダイアログのボタンです。組み合わせは、'ok'(OK)、'okcancel(OK/キャンセル)、'yesno'(はい/いいえ)、'yesnocancel'(はい/いいえ/キャンセル)の4種類です。

time_out:ダイアログでクリックを待機するタイムアウト時間です。この時間を超えてもダイアログがクリックされない場合は、デフォルトのボタンを自動的にクリックします。このパラメータを省略すると、デフォルトで無期限に待機します。timeoutが0の場合、ダイアログは待機しません。

default_result:タイムアウト時にデフォルトでクリックするボタンです。タイムアウト時間が0より大きい場合にのみ有効です。

戻り値

str:メッセージダイアログでの操作結果を返します。例:ok、cancelなどです。

例1

from xbot import app
def main(args):
    button_result = app.dialog.show_message_box('お知らせ','メッセージダイアログを開きました','okcancel', timeout=10, 
                                  default_button='cancel')
    print(button_result)

この例の実行ロジック: メッセージダイアログを開き、タイトルを「お知らせ」、表示内容を「メッセージダイアログを開きました」、ダイアログの操作ボタンを「OK/キャンセル」に設定します。10秒後に何も操作されていない場合は、デフォルトで「キャンセル」をクリックします。 --> メッセージダイアログが返した処理結果を出力します。

show_workbook_dialog()

データテーブルダイアログを開きます。

show_workbook_dialog(title, message)

パラメータ

title:データテーブルダイアログのタイトルです。データテーブルダイアログを起動すると、左上にtitleで指定した値が表示されます。

message:データテーブルダイアログの案内メッセージです。

戻り値

str:データテーブルダイアログの処理結果を返します。例:ok、cancelなどです。

例1

from xbot import app
def main(args):
    result = app.dialog.show_workbook_dialog('データテーブル', 'データテーブルにデータを入力してください')
    print(result)

結果の図:

この例の実行ロジック: タイトルが「データテーブル」、案内メッセージが「データテーブルにデータを入力してください」のデータテーブルダイアログを開きます。 --> データテーブルダイアログが返した処理結果を出力します。

show_notifycation()

メッセージ通知ボックスを開きます。

show_notifycation(message, placement='rightbottom' , level='info', timeout=3)

パラメータ

message:メッセージ通知ボックスの通知内容です。

placement:通知メッセージを画面に表示する位置です。画面上部(top)、画面下部(bottom)、画面右下(rightbottom)に表示できます。省略すると、デフォルトで画面右下に表示します。

level:通知メッセージのレベルです。デフォルトは情報レベル(info)です。情報のほかに、警告(warning)とエラー(error)も設定できます。

timeout:メッセージ通知ボックスの表示時間です。省略すると、デフォルトで3秒間表示します。

戻り値

なし

例1

from xbot import app
def main(args):
    app.dialog.show_notifycation('hello',placement='top',level='info')

この例の実行ロジック: 画面上部にメッセージ通知ボックスを表示します。内容はhello、通知タイプは情報レベル、表示時間は3秒です。

APIリファレンスの記事一覧ページの先頭へ ↑