class Gem::StreamUI

要約

シンプルなストリームを実装したユーザインターフェイスです。

目次

特異メソッド

• new

インスタンスメソッド

• alert
• alert_error
• alert_warning
• ask
• ask_yes_no
• choose_from_list
• errs
• ins
• outs
• progress_reporter
• say
• terminate_interaction

特異メソッド

new(in_stream, out_stream, err_stream = STDERR)Ruby 1.9.3 から[permalink][rdoc][edit]

このクラスを初期化します。

[PARAM] in_stream:

入力元のストリームを指定します。

[PARAM] out_stream:

出力先のストリームを指定します。

[PARAM] err_stream:

エラー出力を指定します。

インスタンスメソッド

alert(statement, question = nil) -> String | nilRuby 1.9.3 から[permalink][rdoc][edit]

INFO レベルのアラートを表示します。

[PARAM] statement:

表示する文字列を指定します。

[PARAM] question:

必要であれば質問を指定します。

[RETURN]

question を指定した場合は、それに対する回答を返します。 question を指定しない場合は nil を返します。

[SEE_ALSO] Gem::StreamUI#ask

alert_error(statement, question = nil) -> String | nilRuby 1.9.3 から[permalink][rdoc][edit]

ERROR レベルのアラートを表示します。

[PARAM] statement:

表示する文字列を指定します。

[PARAM] question:

必要であれば質問を指定します。

[RETURN]

question を指定した場合は、それに対する回答を返します。 question を指定しない場合は nil を返します。

[SEE_ALSO] Gem::StreamUI#ask

alert_warning(statement, question = nil) -> String | nilRuby 1.9.3 から[permalink][rdoc][edit]

WARNING レベルのアラートを表示します。

[PARAM] statement:

表示する文字列を指定します。

[PARAM] question:

必要であれば質問を指定します。

[RETURN]

question を指定した場合は、それに対する回答を返します。 question を指定しない場合は nil を返します。

[SEE_ALSO] Gem::StreamUI#ask

ask(question) -> String | nilRuby 1.9.3 から[permalink][rdoc][edit]

質問をします。

[PARAM] question:

質問を指定します。

[RETURN]

入力ストリームが TTY に接続されている場合は回答を返します。そうでない場合は nil を返します。

ask_yes_no(question) -> boolRuby 1.9.3 から[permalink][rdoc][edit]

イエス、ノーで答える質問をします。

[PARAM] question:

質問を指定します。

[RETURN]

ユーザの回答がイエスの場合は真を、ノーの場合は偽を返します。

choose_from_list(question, list) -> ArrayRuby 1.9.3 から[permalink][rdoc][edit]

リストから回答を選択する質問をします。

リストは質問の上に表示されます。

[PARAM] question:

質問を指定します。

[PARAM] list:

回答の選択肢を文字列の配列で指定します。

[RETURN]

選択肢の名称と選択肢のインデックスを要素とする配列を返します。

errs -> IORuby 1.9.3 から[permalink][rdoc][edit]

この UI にセットされているエラー出力ストリームを返します。

ins -> IORuby 1.9.3 から[permalink][rdoc][edit]

この UI にセットされている入力ストリームを返します。

outs -> IORuby 1.9.3 から[permalink][rdoc][edit]

この UI にセットされてきる出力ストリームを返します。

progress_reporter(*args) -> SilentProgressReporter | SimpleProgressReporter | VerboseProgressReporterRuby 1.9.3 から[permalink][rdoc][edit]

処理の進捗を報告するためのオブジェクトを返します。

返されるオブジェクトの種類は現在の設定によります。

[PARAM] args:

返値となるオブジェクトを初期化するための引数です。

[SEE_ALSO] Gem::StreamUI::SilentProgressReporter, Gem::StreamUI::SimpleProgressReporter, Gem::StreamUI::VerboseProgressReporter

say(statement = '') -> ()Ruby 1.9.3 から[permalink][rdoc][edit]

与えられた文字列を表示します。

[PARAM] statement:

表示する文字列を指定します。

terminate_interaction(status = 0) -> ()Ruby 1.9.3 から[permalink][rdoc][edit]

アプリケーションを終了します。

[PARAM] status:

終了ステータスを指定します。デフォルトは 0 (成功) です。

[EXCEPTION] Gem::SystemExitException:

このメソッドを呼び出すと必ず発生する例外です。