File: C:/Ruby27-x64/share/doc/ruby/html/Gem/DefaultUserInteraction.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module Gem::DefaultUserInteraction - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Text.html">Gem::Text</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-ui">::ui</a>
<li ><a href="#method-c-ui-3D">::ui=</a>
<li ><a href="#method-c-use_ui">::use_ui</a>
<li ><a href="#method-i-ui">#ui</a>
<li ><a href="#method-i-ui-3D">#ui=</a>
<li ><a href="#method-i-use_ui">#use_ui</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-Gem::DefaultUserInteraction">
<h1 id="module-Gem::DefaultUserInteraction" class="module">
module Gem::DefaultUserInteraction
</h1>
<section class="description">
<p>When rubygems/test_case is required the default user interaction is a <a href="MockGemUi.html"><code>MockGemUi</code></a>.</p>
<p><a href="../Module.html"><code>Module</code></a> that defines the default <a href="UserInteraction.html"><code>UserInteraction</code></a>. Any class including this module will have access to the <code>ui</code> method that returns the default UI.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-ui" class="method-detail ">
<div class="method-heading">
<span class="method-name">ui</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return the default UI.</p>
<div class="method-source-code" id="ui-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 29</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">ui</span>
<span class="ruby-ivar">@ui</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">ConsoleUI</span>.<span class="ruby-identifier">new</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-ui-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">ui=</span><span
class="method-args">(new_ui)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p><a href="../Set.html"><code>Set</code></a> the default UI. If the default UI is never explicitly set, a simple console based <a href="UserInteraction.html"><code>UserInteraction</code></a> will be used automatically.</p>
<div class="method-source-code" id="ui-3D-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">ui=</span>(<span class="ruby-identifier">new_ui</span>)
<span class="ruby-ivar">@ui</span> = <span class="ruby-identifier">new_ui</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-c-use_ui" class="method-detail ">
<div class="method-heading">
<span class="method-name">use_ui</span><span
class="method-args">(new_ui) { || ... }</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Use <code>new_ui</code> for the duration of <code>block</code>.</p>
<div class="method-source-code" id="use_ui-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 44</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">use_ui</span>(<span class="ruby-identifier">new_ui</span>)
<span class="ruby-identifier">old_ui</span> = <span class="ruby-ivar">@ui</span>
<span class="ruby-ivar">@ui</span> = <span class="ruby-identifier">new_ui</span>
<span class="ruby-keyword">yield</span>
<span class="ruby-keyword">ensure</span>
<span class="ruby-ivar">@ui</span> = <span class="ruby-identifier">old_ui</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-ui" class="method-detail ">
<div class="method-heading">
<span class="method-name">ui</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="DefaultUserInteraction.html#method-c-ui"><code>DefaultUserInteraction::ui</code></a></p>
<div class="method-source-code" id="ui-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 55</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ui</span>
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DefaultUserInteraction</span>.<span class="ruby-identifier">ui</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ui-3D" class="method-detail ">
<div class="method-heading">
<span class="method-name">ui=</span><span
class="method-args">(new_ui)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="DefaultUserInteraction.html#method-c-ui-3D"><code>DefaultUserInteraction::ui=</code></a></p>
<div class="method-source-code" id="ui-3D-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 62</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ui=</span>(<span class="ruby-identifier">new_ui</span>)
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DefaultUserInteraction</span>.<span class="ruby-identifier">ui</span> = <span class="ruby-identifier">new_ui</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-use_ui" class="method-detail ">
<div class="method-heading">
<span class="method-name">use_ui</span><span
class="method-args">(new_ui, &block)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>See <a href="DefaultUserInteraction.html#method-c-use_ui"><code>DefaultUserInteraction::use_ui</code></a></p>
<div class="method-source-code" id="use_ui-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 69</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">use_ui</span>(<span class="ruby-identifier">new_ui</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">DefaultUserInteraction</span>.<span class="ruby-identifier">use_ui</span>(<span class="ruby-identifier">new_ui</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>