<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::Prompt
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::Prompt";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (P)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">Prompt</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::Prompt
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd><span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span>, <span class='object_link'><a href="PromptChoose.html" title="Doing::PromptChoose (module)">PromptChoose</a></span>, <span class='object_link'><a href="PromptFZF.html" title="Doing::PromptFZF (module)">PromptFZF</a></span>, <span class='object_link'><a href="PromptInput.html" title="Doing::PromptInput (module)">PromptInput</a></span>, <span class='object_link'><a href="PromptSTD.html" title="Doing::PromptSTD (module)">PromptSTD</a></span>, <span class='object_link'><a href="PromptYN.html" title="Doing::PromptYN (module)">PromptYN</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/prompt/prompt.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Terminal Prompt methods</p>
</div>
</div>
<div class="tags">
</div>
<h2>Constant Summary</h2>
<h3 class="inherited">Constants included
from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#ATTRIBUTES-constant" title="Doing::Color::ATTRIBUTES (constant)">Color::ATTRIBUTES</a></span>, <span class='object_link'><a href="Color.html#ATTRIBUTE_NAMES-constant" title="Doing::Color::ATTRIBUTE_NAMES (constant)">Color::ATTRIBUTE_NAMES</a></span>, <span class='object_link'><a href="Color.html#COLORED_REGEXP-constant" title="Doing::Color::COLORED_REGEXP (constant)">Color::COLORED_REGEXP</a></span>, <span class='object_link'><a href="Color.html#ESCAPE_REGEX-constant" title="Doing::Color::ESCAPE_REGEX (constant)">Color::ESCAPE_REGEX</a></span></p>
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#default_answer-class_method" title="default_answer (class method)">.<strong>default_answer</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>If true, always return the default answer without prompting.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#force_answer-class_method" title="force_answer (class method)">.<strong>force_answer</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Value to return if prompt is skipped.</p>
</div></span>
</li>
</ul>
<h2>Method Summary</h2>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PromptChoose.html" title="Doing::PromptChoose (module)">PromptChoose</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PromptChoose.html#choose_from-instance_method" title="Doing::PromptChoose#choose_from (method)">choose_from</a></span>, <span class='object_link'><a href="PromptChoose.html#choose_from_items-instance_method" title="Doing::PromptChoose#choose_from_items (method)">choose_from_items</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PromptFZF.html" title="Doing::PromptFZF (module)">PromptFZF</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PromptFZF.html#fzf-instance_method" title="Doing::PromptFZF#fzf (method)">fzf</a></span>, <span class='object_link'><a href="PromptFZF.html#install_fzf-instance_method" title="Doing::PromptFZF#install_fzf (method)">install_fzf</a></span>, <span class='object_link'><a href="PromptFZF.html#uninstall_fzf-instance_method" title="Doing::PromptFZF#uninstall_fzf (method)">uninstall_fzf</a></span>, <span class='object_link'><a href="PromptFZF.html#which_fzf-instance_method" title="Doing::PromptFZF#which_fzf (method)">which_fzf</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PromptYN.html" title="Doing::PromptYN (module)">PromptYN</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PromptYN.html#yn-instance_method" title="Doing::PromptYN#yn (method)">yn</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PromptInput.html" title="Doing::PromptInput (module)">PromptInput</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PromptInput.html#enter_text-instance_method" title="Doing::PromptInput#enter_text (method)">enter_text</a></span>, <span class='object_link'><a href="PromptInput.html#read_line-instance_method" title="Doing::PromptInput#read_line (method)">read_line</a></span>, <span class='object_link'><a href="PromptInput.html#read_lines-instance_method" title="Doing::PromptInput#read_lines (method)">read_lines</a></span>, <span class='object_link'><a href="PromptInput.html#request_lines-instance_method" title="Doing::PromptInput#request_lines (method)">request_lines</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="PromptSTD.html" title="Doing::PromptSTD (module)">PromptSTD</a></span></h3>
<p class="inherited"><span class='object_link'><a href="PromptSTD.html#clear_screen-instance_method" title="Doing::PromptSTD#clear_screen (method)">clear_screen</a></span>, <span class='object_link'><a href="PromptSTD.html#restore_std-instance_method" title="Doing::PromptSTD#restore_std (method)">restore_std</a></span>, <span class='object_link'><a href="PromptSTD.html#silence_std-instance_method" title="Doing::PromptSTD#silence_std (method)">silence_std</a></span></p>
<h3 class="inherited">Methods included from <span class='object_link'><a href="Color.html" title="Doing::Color (module)">Color</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Color.html#attributes-instance_method" title="Doing::Color#attributes (method)">attributes</a></span>, <span class='object_link'><a href="Color.html#coloring%3F-class_method" title="Doing::Color.coloring? (method)">coloring?</a></span>, <span class='object_link'><a href="Color.html#rgb-instance_method" title="Doing::Color#rgb (method)">rgb</a></span>, <span class='object_link'><a href="Color.html#support%3F-instance_method" title="Doing::Color#support? (method)">support?</a></span>, <span class='object_link'><a href="Color.html#template-class_method" title="Doing::Color.template (method)">template</a></span>, <span class='object_link'><a href="Color.html#uncolor-instance_method" title="Doing::Color#uncolor (method)">uncolor</a></span></p>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="default_answer=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="default_answer-class_method">
.<strong>default_answer</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>If true, always return the default answer without prompting</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>default answer</p>
</div>
</li>
</ul>
</div>
</div>
<span id="force_answer=-class_method"></span>
<div class="method_details ">
<h3 class="signature " id="force_answer-class_method">
.<strong>force_answer</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Value to return if prompt is skipped</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Force answer value</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 06:08:17 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>