libbobcat-dev 3.19.01-1ubuntu1 / usr / share / doc / libbobcat3-dev / man / onekey.3.html

This file is indexed.

/usr/share/doc/libbobcat3-dev/man/onekey.3.html is in libbobcat-dev 3.19.01-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
<html><head>
<title>FBB::OneKey</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::OneKey</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz</h2>
<h2>2005-2013</h2>

<html><head>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>

<html><head>
<title>FBB::OneKey(3bobcat)</title>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::OneKey(3bobcat)</h1>
<h2>libbobcat-dev_3.19.01-x.tar.gz One keystroke input</h2>
<h2>2005-2013</h2>


<p>
<h2>NAME</h2>FBB::OneKey - Single keystroke input, not requiring `Return'
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/onekey&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
    <strong>OneKey</strong> objects may be used to realize `direct keyboard input': a
pressed key becomes available without the need for pressing <em>Enter</em>. The
characters are obtained from the standard input stream. Direct key entry
remains in effect for as long as the <strong>OneKey</strong> object exists. Once the object
is destroyed the standard input stream will return to its default mode of
operation, in which input is `confirmed' by a newline character.
<p>
<h2>NAMESPACE</h2>
    <strong>FBB</strong><br>
    All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
    -
<p>
<h2>ENUMERATION</h2>
    The <strong>OneKey::Mode</strong> enumeration is used to control echoing of returned
characters. It has two values:
    <ul>
    <li> <strong>OFF</strong>: returned characters are <em>not</em> echoed to the standard
output stream;
    <li> <strong>ON</strong>: returned characters <em>are</em> echoed to the standard output
stream. 
    </ul>
<h2>CONSTRUCTORS</h2>
    <ul>
    <li> <strong>OneKey(OneKey::Mode state = OneKey::OFF)</strong>:<br> 
        This constructor initializes the <strong>OneKey</strong> input object. By
        default, entered characters are not echoed. By constructing the object
        with the <strong>OneKey::ON</strong> argument, entered characters are echoed to
        the standard output stream. 
<p>
This construct throws an <em>Exception</em> exception if it not properly
        complete. The constructor may fail for the following reasons:
            <ul>
            <li> the standard input stream is not a tty (e.g., when the
             standard input stream is redirected to a file);
            <li> the current state of the standard input stream can't be
             determined;
            <li> the standard input stream's state can't be changed to the
             `direct keyboard input' mode.
            </ul>
    </ul>
        The copy constructor (and the overloaded assignement operator) are not
        available. 
<p>
<h2>MEMBER FUNCTIONS</h2>
    <ul>
    <li> <strong>int get() const</strong>:<br> 
        Returns the next character from the standard input stream, without the
        need for pressing <em>Enter</em>. 
    <li> <strong>void setEcho(OneKey::Mode state)</strong>:<br> 
        Changes the echo-state of the <strong>OneKey</strong> object. The argument may be
        either <strong>OneKey::ON</strong> or <strong>OneKey::OFF</strong>.
    <li> <strong>void verify() const</strong>:<br>
        Obsoleted, will be removed in a future Bobcat release.
    </ul>
<p>
<h2>EXAMPLE</h2>
    <pre>
/*
                              driver.cc
*/

#include &lt;iostream&gt;
#include &lt;string&gt;
#include &lt;bobcat/onekey&gt;

using namespace std;
using namespace FBB;

int main()
{
    try
    {
        OneKey onekey;
        onekey.verify();

        cout &lt;&lt; "Usage: 1: next chars are echoed, 0: no echo, q: quits\n";

        while (true)
        {
            char c;
    
            cout &lt;&lt; "ready...\n";
            cout &lt;&lt; "Got character '" &lt;&lt; (c = onekey.get()) &lt;&lt; "'\n";

            switch (c)
            {
                case '1':    
                    onekey.setEcho(OneKey::ON);
                break;

                case '0':    
                    onekey.setEcho(OneKey::OFF);
                break;

                case 'q':
                return 0;    
            }
        }
    }
    catch (Errno const &amp;e)
    {
        cout &lt;&lt; e.why() &lt;&lt; endl;
        return e.which();
    }
}

</pre>

<p>
<h2>FILES</h2>
    <em>bobcat/onekey</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>bobcat</strong>(7)
<p>
<h2>BUGS</h2>
    None Reported.
<p>

<h2>DISTRIBUTION FILES</h2>
    <ul>
    <li> <em>bobcat_3.19.01-x.dsc</em>: detached signature;
    <li> <em>bobcat_3.19.01-x.tar.gz</em>: source archive;
    <li> <em>bobcat_3.19.01-x_i386.changes</em>: change log;
    <li> <em>libbobcat1_3.19.01-x_*.deb</em>: debian package holding the
            libraries;
    <li> <em>libbobcat1-dev_3.19.01-x_*.deb</em>: debian package holding the
            libraries, headers and manual pages;
    <li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
    </ul>
<p>
<h2>BOBCAT</h2>
    Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
    This is free software, distributed under the terms of the 
    GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
    Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>

APT Browse - Built by Thomas Orozco.