?lang_form? ?lang_select? ?lang_submit? ?lang_endform?
{HEADER END}
{BLAME START}

library

?curdirlinks? -

Blame information for rev 6

Line No. Rev Author Line
1 6 kaklik <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3 <title>Procyon AVRlib: vt100.h Source File</title>
4 <link href="dox.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.4.2 -->
7 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
8 <h1>vt100.h</h1><a href="vt100_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*! \file vt100.h \brief VT100 terminal function library. */</span>
9 00002 <span class="comment">//*****************************************************************************</span>
10 00003 <span class="comment">//</span>
11 00004 <span class="comment">// File Name : 'vt100.h'</span>
12 00005 <span class="comment">// Title : VT100 terminal function library</span>
13 00006 <span class="comment">// Author : Pascal Stang - Copyright (C) 2002</span>
14 00007 <span class="comment">// Created : 2002.08.27</span>
15 00008 <span class="comment">// Revised : 2002.08.27</span>
16 00009 <span class="comment">// Version : 0.1</span>
17 00010 <span class="comment">// Target MCU : Atmel AVR Series</span>
18 00011 <span class="comment">// Editor Tabs : 4</span>
19 00012 <span class="comment">//</span>
20 00013 <span class="comment">// NOTE: This code is currently below version 1.0, and therefore is considered</span>
21 00014 <span class="comment">// to be lacking in some functionality or documentation, or may not be fully</span>
22 00015 <span class="comment">// tested. Nonetheless, you can expect most functions to work.</span>
23 00016 <span class="comment">//</span><span class="comment"></span>
24 00017 <span class="comment">/// \ingroup general</span>
25 00018 <span class="comment">/// \defgroup vt100 VT100 Terminal Function Library (vt100.c)</span>
26 00019 <span class="comment">/// \code #include "vt100.h" \endcode</span>
27 00020 <span class="comment">/// \par Overview</span>
28 00021 <span class="comment">/// This library provides functions for sending VT100 escape codes to</span>
29 00022 <span class="comment">/// control a connected VT100 or ANSI terminal.  Commonly useful functions</span>
30 00023 <span class="comment">/// include setting the cursor position, clearing the screen, setting the text</span>
31 00024 <span class="comment">/// attributes (bold, inverse, blink, etc), and setting the text color.  This</span>
32 00025 <span class="comment">/// library will slowly be expanded to include support for codes as needed and</span>
33 00026 <span class="comment">/// may eventually receive VT100 escape codes too.</span>
34 00027 <span class="comment"></span><span class="comment">//</span>
35 00028 <span class="comment">// This code is distributed under the GNU Public License</span>
36 00029 <span class="comment">// which can be found at http://www.gnu.org/licenses/gpl.txt</span>
37 00030 <span class="comment">//</span>
38 00031 <span class="comment">//*****************************************************************************</span>
39 00032
40 00033 <span class="preprocessor">#ifndef VT100_H</span>
41 00034 <span class="preprocessor"></span><span class="preprocessor">#define VT100_H</span>
42 00035 <span class="preprocessor"></span>
43 00036 <span class="preprocessor">#include "<a class="code" href="global_8h.html">global.h</a>"</span>
44 00037
45 00038 <span class="comment">// constants/macros/typdefs</span>
46 00039 <span class="comment">// text attributes</span>
47 00040 <span class="preprocessor">#define VT100_ATTR_OFF 0</span>
48 00041 <span class="preprocessor"></span><span class="preprocessor">#define VT100_BOLD 1</span>
49 00042 <span class="preprocessor"></span><span class="preprocessor">#define VT100_USCORE 4</span>
50 00043 <span class="preprocessor"></span><span class="preprocessor">#define VT100_BLINK 5</span>
51 00044 <span class="preprocessor"></span><span class="preprocessor">#define VT100_REVERSE 7</span>
52 00045 <span class="preprocessor"></span><span class="preprocessor">#define VT100_BOLD_OFF 21</span>
53 00046 <span class="preprocessor"></span><span class="preprocessor">#define VT100_USCORE_OFF 24</span>
54 00047 <span class="preprocessor"></span><span class="preprocessor">#define VT100_BLINK_OFF 25</span>
55 00048 <span class="preprocessor"></span><span class="preprocessor">#define VT100_REVERSE_OFF 27</span>
56 00049 <span class="preprocessor"></span>
57 00050 <span class="comment">// functions</span>
58 00051 <span class="comment"></span>
59 00052 <span class="comment">//! vt100Init() initializes terminal and vt100 library</span>
60 00053 <span class="comment">/// Run this init routine once before using any other vt100 function.</span>
61 00054 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="vt100_8c.html#a0">vt100Init</a>(<span class="keywordtype">void</span>);
62 00055 <span class="comment"></span>
63 00056 <span class="comment">//! vt100ClearScreen() clears the terminal screen</span>
64 00057 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="vt100_8c.html#a1">vt100ClearScreen</a>(<span class="keywordtype">void</span>);
65 00058 <span class="comment"></span>
66 00059 <span class="comment">//! vt100SetAttr() sets the text attributes like BOLD or REVERSE</span>
67 00060 <span class="comment">/// Text written to the terminal after this function is called will have</span>
68 00061 <span class="comment">/// the desired attribuutes.</span>
69 00062 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="vt100_8c.html#a2">vt100SetAttr</a>(u08 attr);
70 00063 <span class="comment"></span>
71 00064 <span class="comment">//! vt100SetCursorMode() sets the cursor to visible or invisible</span>
72 00065 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="vt100_8c.html#a3">vt100SetCursorMode</a>(u08 visible);
73 00066 <span class="comment"></span>
74 00067 <span class="comment">//! vt100SetCursorPos() sets the cursor position</span>
75 00068 <span class="comment">/// All text which is written to the terminal after a SetCursorPos command</span>
76 00069 <span class="comment">/// will begin at the new location of the cursor.</span>
77 00070 <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="vt100_8c.html#a4">vt100SetCursorPos</a>(u08 line, u08 col);
78 00071
79 00072 <span class="preprocessor">#endif</span>
80 </pre></div><hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by&nbsp;
81 <a href="http://www.doxygen.org/index.html">
82 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address>
83 </body>
84 </html>
{BLAME END}
{FOOTER START}

Powered by WebSVN v2.8.3