← Back to branch summary

~ubuntu-branches/ubuntu/karmic/iterm/karmic

« back to all changes in this revision

Viewing changes to lib/docs/latex/screen_8h.tex

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Fok
  • Date: 2004-02-27 04:13:16 UTC
  • Revision ID: james.westby@ubuntu.com-20040227041316-q0jn37sia8mt0t9u
Tags: upstream-0.5
Import upstream version 0.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/docs/latex/screen_8h.tex
 
1
\section{screen.h File Reference}
 
2
\label{screen_8h}\index{screen.h@{screen.h}}
 
3
VTScreen\-View interface definition. 
 
4
 
 
5
 
 
6
\subsection*{Data Structures}
 
7
\begin{CompactItemize}
 
8
\item 
 
9
struct {\bf \_\-VTScreen\-View}
 
10
\begin{CompactList}\small\item\em VTScreen\-View interface.\item\end{CompactList}\end{CompactItemize}
 
11
\subsection*{Defines}
 
12
\begin{CompactItemize}
 
13
\item 
 
14
\index{UK_CHARSET@{UK\_\-CHARSET}!screen.h@{screen.h}}\index{screen.h@{screen.h}!UK_CHARSET@{UK\_\-CHARSET}}
 
15
\#define {\bf UK\_\-CHARSET}\ 'A'\label{screen_8h_a0}
 
16
 
 
17
\begin{CompactList}\small\item\em Macro of UK Character set specfied by set\_\-rendition.\item\end{CompactList}\item 
 
18
\index{ASCII_CHARSET@{ASCII\_\-CHARSET}!screen.h@{screen.h}}\index{screen.h@{screen.h}!ASCII_CHARSET@{ASCII\_\-CHARSET}}
 
19
\#define {\bf ASCII\_\-CHARSET}\ 'B'\label{screen_8h_a1}
 
20
 
 
21
\begin{CompactList}\small\item\em Macro of ASCII Character set specfied by set\_\-rendition.\item\end{CompactList}\item 
 
22
\index{SPECIAL_GRAPHICS@{SPECIAL\_\-GRAPHICS}!screen.h@{screen.h}}\index{screen.h@{screen.h}!SPECIAL_GRAPHICS@{SPECIAL\_\-GRAPHICS}}
 
23
\#define {\bf SPECIAL\_\-GRAPHICS}\ '0'\label{screen_8h_a2}
 
24
 
 
25
\begin{CompactList}\small\item\em Macro of special graphics set specfied by set\_\-rendition.\item\end{CompactList}\item 
 
26
\#define {\bf VTScreen\-View\_\-init}(view)
 
27
\begin{CompactList}\small\item\em utility macro to initialize VTScreen\-View\item\end{CompactList}\end{CompactItemize}
 
28
\subsection*{Typedefs}
 
29
\begin{CompactItemize}
 
30
\item 
 
31
\index{VTScreenView@{VTScreenView}!screen.h@{screen.h}}\index{screen.h@{screen.h}!VTScreenView@{VTScreenView}}
 
32
typedef {\bf \_\-VTScreen\-View} {\bf VTScreen\-View}\label{screen_8h_a4}
 
33
 
 
34
\begin{CompactList}\small\item\em typedefed struct of struct {\bf \_\-VTScreen\-View}\item\end{CompactList}\end{CompactItemize}
 
35
\subsection*{Enumerations}
 
36
\begin{CompactItemize}
 
37
\item 
 
38
enum \{ {\bf OFF}, 
 
39
{\bf ON}
 
40
 \}
 
41
\begin{CompactList}\small\item\em Type definition of On/Off.\item\end{CompactList}\item 
 
42
enum \{ {\bf MOUSE\_\-OFF}, 
 
43
{\bf X10\_\-MOUSE}, 
 
44
{\bf VT200\_\-MOUSE}
 
45
 \}
 
46
\begin{CompactList}\small\item\em Type definition of sending mouse position \par
 
47
 MOUSE\_\-OFF - not send mouse cursor position \par
 
48
 X10\_\-MOUSE - send X10 compatibility mouse cursor position \par
 
49
 VT200\_\-MOUSE - send VT200 compatibility mouse cursor position \par
 
50
.\item\end{CompactList}\item 
 
51
enum \{ {\bf SELECTION\_\-CHAR}, 
 
52
{\bf SELECTION\_\-WORD}, 
 
53
{\bf SELECTION\_\-LINE}
 
54
 \}
 
55
\begin{CompactList}\small\item\em Type definition of selecting character \par
 
56
 SELECTION\_\-CHAR - Character oriented selection SELECTION\_\-WORD - Word oriented selection SELECTION\_\-LINE - Line oriented selection.\item\end{CompactList}\end{CompactItemize}
 
57
 
 
58
 
 
59
\subsection{Detailed Description}
 
60
VTScreen\-View interface definition.
 
61
 
 
62
 
 
63
 
 
64
\subsection{Define Documentation}
 
65
\index{screen.h@{screen.h}!VTScreenView_init@{VTScreenView\_\-init}}
 
66
\index{VTScreenView_init@{VTScreenView\_\-init}!screen.h@{screen.h}}
 
67
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}\#define VTScreen\-View\_\-init(view)}\label{screen_8h_a3}
 
68
 
 
69
 
 
70
{\bf Value:}
 
71
 
 
72
\footnotesize\begin{verbatim}do \
 
73
{ \
 
74
  view->object = NULL; \
 
75
  view->draw_text = NULL; \
 
76
  view->clear_rect = NULL; \
 
77
  view->set_rendition = NULL; \
 
78
  view->swap_video = NULL; \
 
79
  view->resize_request = NULL; \
 
80
  view->update_cursor_position = NULL; \
 
81
  view->ring = NULL; \
 
82
  view->notify_osc = NULL; \
 
83
  view->update_scrollbar = NULL; \
 
84
  view->scroll_view = NULL; \
 
85
} while(0)
 
86
\end{verbatim}\normalsize 
 
87
utility macro to initialize VTScreen\-View
 
88
 
 
89
\begin{Desc}
 
90
\item[Parameters:]
 
91
\begin{description}
 
92
\item[{\em view}]reference to VTScreen\-View Object. \end{description}
 
93
\end{Desc}