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

« back to all changes in this revision

Viewing changes to lib/docs/latex/core_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:
 
1
\section{core.h File Reference}
 
2
\label{core_8h}\index{core.h@{core.h}}
 
3
{\bf VTCore} class definition. 
 
4
 
 
5
 
 
6
{\tt \#include $<$stdio.h$>$}\par
 
7
{\tt \#include $<$wchar.h$>$}\par
 
8
{\tt \#include \char`\"{}io.h\char`\"{}}\par
 
9
{\tt \#include \char`\"{}screen.h\char`\"{}}\par
 
10
\subsection*{Data Structures}
 
11
\begin{CompactItemize}
 
12
\item 
 
13
struct {\bf \_\-VTCore}
 
14
\end{CompactItemize}
 
15
\subsection*{Typedefs}
 
16
\begin{CompactItemize}
 
17
\item 
 
18
\index{VTCore@{VTCore}!core.h@{core.h}}\index{core.h@{core.h}!VTCore@{VTCore}}
 
19
typedef \_\-VTCore {\bf VTCore}\label{core_8h_a0}
 
20
 
 
21
\begin{CompactList}\small\item\em typedefed struct of struct \_\-VTCore\item\end{CompactList}\end{CompactItemize}
 
22
\subsection*{Enumerations}
 
23
\begin{CompactItemize}
 
24
\item 
 
25
enum \{ {\bf VTM\_\-SHIFT} =  0x0004, 
 
26
{\bf VTM\_\-META} =  0x0008, 
 
27
{\bf VTM\_\-CONTROL} =  0x0010, 
 
28
{\bf VTK\_\-LEFT} =  0x\-FF51, 
 
29
{\bf VTK\_\-UP} =  0x\-FF52, 
 
30
{\bf VTK\_\-RIGHT} =  0x\-FF53, 
 
31
{\bf VTK\_\-DOWN} =  0x\-FF54, 
 
32
{\bf VTK\_\-CR} =  0x\-FF0D, 
 
33
{\bf VTK\_\-KP\_\-0} =  0x\-FF00, 
 
34
{\bf VTK\_\-KP\_\-1} =  0x\-FF01, 
 
35
{\bf VTK\_\-KP\_\-2} =  0x\-FF02, 
 
36
{\bf VTK\_\-KP\_\-3} =  0x\-FF03, 
 
37
{\bf VTK\_\-KP\_\-4} =  0x\-FF04, 
 
38
{\bf VTK\_\-KP\_\-5} =  0x\-FF05, 
 
39
{\bf VTK\_\-KP\_\-6} =  0x\-FF06, 
 
40
{\bf VTK\_\-KP\_\-7} =  0x\-FF07, 
 
41
{\bf VTK\_\-KP\_\-8} =  0x\-FF08, 
 
42
{\bf VTK\_\-KP\_\-9} =  0x\-FF09, 
 
43
{\bf VTK\_\-KP\_\-DASH} =  0x\-FF0A, 
 
44
{\bf VTK\_\-KP\_\-COMMA} =  0x\-FF0B, 
 
45
{\bf VTK\_\-KP\_\-PERIOD} =  0x\-FF0C, 
 
46
{\bf VTK\_\-KP\_\-ENTER} =  0x\-FF0D, 
 
47
{\bf VTK\_\-KP\_\-PF1} =  0x\-FF0E, 
 
48
{\bf VTK\_\-KP\_\-PF2} =  0x\-FF0F, 
 
49
{\bf VTK\_\-KP\_\-PF3} =  0x\-FF10, 
 
50
{\bf VTK\_\-KP\_\-PF4} =  0x\-FF11, 
 
51
{\bf VTK\_\-F1} =  0x1000, 
 
52
{\bf VTK\_\-F2} =  0x1001, 
 
53
{\bf VTK\_\-F3} =  0x1002, 
 
54
{\bf VTK\_\-F4} =  0x1003, 
 
55
{\bf VTK\_\-F5} =  0x1004, 
 
56
{\bf VTK\_\-F6} =  0x1005, 
 
57
{\bf VTK\_\-F7} =  0x1006, 
 
58
{\bf VTK\_\-F8} =  0x1007, 
 
59
{\bf VTK\_\-F9} =  0x1008, 
 
60
{\bf VTK\_\-F10} =  0x1009, 
 
61
{\bf VTK\_\-F11} =  0x1010, 
 
62
{\bf VTK\_\-F12} =  0x1011, 
 
63
{\bf VTK\_\-F13} =  0x1012, 
 
64
{\bf VTK\_\-F14} =  0x1013, 
 
65
{\bf VTK\_\-F15} =  0x1014, 
 
66
{\bf VTK\_\-F16} =  0x1015, 
 
67
{\bf VTK\_\-F17} =  0x1016, 
 
68
{\bf VTK\_\-F18} =  0x1017
 
69
 \}
 
70
\end{CompactItemize}
 
71
\subsection*{Functions}
 
72
\begin{CompactItemize}
 
73
\item 
 
74
{\bf VTCore} $\ast$ {\bf VTCore\_\-new} ({\bf Terminal\-IO} $\ast$io, int num\_\-cols, int num\_\-rows, int num\_\-history)
 
75
\begin{CompactList}\small\item\em Constructor of {\bf VTCore} object.\item\end{CompactList}\item 
 
76
void {\bf VTCore\_\-destroy} ({\bf VTCore} $\ast$core)
 
77
\begin{CompactList}\small\item\em Destructor of {\bf VTCore} object.\item\end{CompactList}\item 
 
78
int {\bf VTCore\_\-write} (struct \_\-VTCore $\ast$core, char $\ast$mb, int length)
 
79
\begin{CompactList}\small\item\em method to write input data to Host.\item\end{CompactList}\item 
 
80
int {\bf VTCore\_\-send\_\-key} ({\bf VTCore} $\ast$core, int type)
 
81
\begin{CompactList}\small\item\em method to send specified key\item\end{CompactList}\item 
 
82
void {\bf VTCore\_\-redraw} ({\bf VTCore} $\ast$core, int scol, int srow, int ecol, int erow)
 
83
\begin{CompactList}\small\item\em method to request redraw to screen model.\item\end{CompactList}\item 
 
84
void {\bf VTCore\_\-set\_\-screen\_\-view} ({\bf VTCore} $\ast$core, {\bf VTScreen\-View} $\ast$view)
 
85
\begin{CompactList}\small\item\em method to set Screen\-View to Screen\-Model\item\end{CompactList}\item 
 
86
void {\bf VTCore\_\-set\_\-screen\_\-size} ({\bf VTCore} $\ast$core, int width, int height)
 
87
\begin{CompactList}\small\item\em method to set Screen size\item\end{CompactList}\item 
 
88
void {\bf VTCore\_\-start\_\-selection} ({\bf VTCore} $\ast$core, int scol, int srow, int type)
 
89
\begin{CompactList}\small\item\em Start selection.\item\end{CompactList}\item 
 
90
void {\bf VTCore\_\-extend\_\-selection} ({\bf VTCore} $\ast$core, int scol, int srow)
 
91
\begin{CompactList}\small\item\em Extend selection.\item\end{CompactList}\item 
 
92
void {\bf VTCore\_\-copy\_\-buffer} ({\bf VTCore} $\ast$core, int scol, int srow, int ecol, int erow, char $\ast$dest, int dest\_\-size)
 
93
\begin{CompactList}\small\item\em Copy multibyte characters from buffer.\item\end{CompactList}\item 
 
94
void {\bf VTCore\_\-copy\_\-selected\_\-buffer} ({\bf VTCore} $\ast$core, char $\ast$dest, int dest\_\-size)
 
95
\begin{CompactList}\small\item\em Copy multibyte characters from buffer.\item\end{CompactList}\item 
 
96
void {\bf VTCore\_\-clear\_\-selection} ({\bf VTCore} $\ast$core)
 
97
\begin{CompactList}\small\item\em Clear selection.\item\end{CompactList}\item 
 
98
void {\bf VTCore\_\-scroll} ({\bf VTCore} $\ast$core, double top)
 
99
\begin{CompactList}\small\item\em Scroll buffer.\item\end{CompactList}\item 
 
100
void {\bf VTCore\_\-set\_\-exit\_\-callback} ({\bf VTCore} $\ast$core, void($\ast$proc)({\bf VTScreen\-View} $\ast$view))
 
101
\begin{CompactList}\small\item\em set callback function when host thread finish.\item\end{CompactList}\item 
 
102
void {\bf VTCore\_\-set\_\-reverse\_\-video} ({\bf VTCore} $\ast$core, int on)
 
103
\begin{CompactList}\small\item\em set reverse video\item\end{CompactList}\item 
 
104
void {\bf VTCore\_\-scroll\_\-up} ({\bf VTCore} $\ast$core, int num\_\-line)
 
105
\begin{CompactList}\small\item\em Scroll buffer.\item\end{CompactList}\item 
 
106
void {\bf VTCore\_\-scroll\_\-down} ({\bf VTCore} $\ast$core, int num\_\-line)
 
107
\begin{CompactList}\small\item\em Scroll buffer.\item\end{CompactList}\item 
 
108
int {\bf VTCore\_\-send\_\-mouse\_\-position} ({\bf VTCore} $\ast$core, int button, int modifiers, int pressed, int col, int row)
 
109
\begin{CompactList}\small\item\em Send mouse cursor position This should be called when.\item\end{CompactList}\item 
 
110
void {\bf VTCore\_\-dispatch} ({\bf VTCore} $\ast$core)
 
111
\begin{CompactList}\small\item\em Dispatch host event; This method doesn't return until host sends bytes.\item\end{CompactList}\end{CompactItemize}
 
112
 
 
113
 
 
114
\subsection{Detailed Description}
 
115
{\bf VTCore} class definition.
 
116
 
 
117
 
 
118
 
 
119
\subsection{Enumeration Type Documentation}
 
120
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}anonymous enum}\label{core_8h_a64}
 
121
 
 
122
 
 
123
\begin{Desc}
 
124
\item[Enumeration values: ]\par
 
125
\begin{description}
 
126
\index{VTM_SHIFT@{VTM\_\-SHIFT}!core.h@{core.h}}\index{core.h@{core.h}!VTM_SHIFT@{VTM\_\-SHIFT}}\item[{\em 
 
127
{\em VTM\_\-SHIFT}\label{core_8h_a64a1}
 
128
}]Shift modifier.\index{VTM_META@{VTM\_\-META}!core.h@{core.h}}\index{core.h@{core.h}!VTM_META@{VTM\_\-META}}\item[{\em 
 
129
{\em VTM\_\-META}\label{core_8h_a64a2}
 
130
}]Meta modifier.\index{VTM_CONTROL@{VTM\_\-CONTROL}!core.h@{core.h}}\index{core.h@{core.h}!VTM_CONTROL@{VTM\_\-CONTROL}}\item[{\em 
 
131
{\em VTM\_\-CONTROL}\label{core_8h_a64a3}
 
132
}]Control modifier.\index{VTK_LEFT@{VTK\_\-LEFT}!core.h@{core.h}}\index{core.h@{core.h}!VTK_LEFT@{VTK\_\-LEFT}}\item[{\em 
 
133
{\em VTK\_\-LEFT}\label{core_8h_a64a4}
 
134
}]cursor key left\index{VTK_UP@{VTK\_\-UP}!core.h@{core.h}}\index{core.h@{core.h}!VTK_UP@{VTK\_\-UP}}\item[{\em 
 
135
{\em VTK\_\-UP}\label{core_8h_a64a5}
 
136
}]cursor key up\index{VTK_RIGHT@{VTK\_\-RIGHT}!core.h@{core.h}}\index{core.h@{core.h}!VTK_RIGHT@{VTK\_\-RIGHT}}\item[{\em 
 
137
{\em VTK\_\-RIGHT}\label{core_8h_a64a6}
 
138
}]cursor key right\index{VTK_DOWN@{VTK\_\-DOWN}!core.h@{core.h}}\index{core.h@{core.h}!VTK_DOWN@{VTK\_\-DOWN}}\item[{\em 
 
139
{\em VTK\_\-DOWN}\label{core_8h_a64a7}
 
140
}]cursor key down\index{VTK_CR@{VTK\_\-CR}!core.h@{core.h}}\index{core.h@{core.h}!VTK_CR@{VTK\_\-CR}}\item[{\em 
 
141
{\em VTK\_\-CR}\label{core_8h_a64a8}
 
142
}]Enter/Return Key.\index{VTK_KP_0@{VTK\_\-KP\_\-0}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_0@{VTK\_\-KP\_\-0}}\item[{\em 
 
143
{\em VTK\_\-KP\_\-0}\label{core_8h_a64a9}
 
144
}]Key\-Pad 0 Key.\index{VTK_KP_1@{VTK\_\-KP\_\-1}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_1@{VTK\_\-KP\_\-1}}\item[{\em 
 
145
{\em VTK\_\-KP\_\-1}\label{core_8h_a64a10}
 
146
}]Key\-Pad 1 Key.\index{VTK_KP_2@{VTK\_\-KP\_\-2}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_2@{VTK\_\-KP\_\-2}}\item[{\em 
 
147
{\em VTK\_\-KP\_\-2}\label{core_8h_a64a11}
 
148
}]Key\-Pad 2 Key.\index{VTK_KP_3@{VTK\_\-KP\_\-3}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_3@{VTK\_\-KP\_\-3}}\item[{\em 
 
149
{\em VTK\_\-KP\_\-3}\label{core_8h_a64a12}
 
150
}]Key\-Pad 3 Key.\index{VTK_KP_4@{VTK\_\-KP\_\-4}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_4@{VTK\_\-KP\_\-4}}\item[{\em 
 
151
{\em VTK\_\-KP\_\-4}\label{core_8h_a64a13}
 
152
}]Key\-Pad 4 Key.\index{VTK_KP_5@{VTK\_\-KP\_\-5}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_5@{VTK\_\-KP\_\-5}}\item[{\em 
 
153
{\em VTK\_\-KP\_\-5}\label{core_8h_a64a14}
 
154
}]Key\-Pad 5 Key.\index{VTK_KP_6@{VTK\_\-KP\_\-6}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_6@{VTK\_\-KP\_\-6}}\item[{\em 
 
155
{\em VTK\_\-KP\_\-6}\label{core_8h_a64a15}
 
156
}]Key\-Pad 6 Key.\index{VTK_KP_7@{VTK\_\-KP\_\-7}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_7@{VTK\_\-KP\_\-7}}\item[{\em 
 
157
{\em VTK\_\-KP\_\-7}\label{core_8h_a64a16}
 
158
}]Key\-Pad 7 Key.\index{VTK_KP_8@{VTK\_\-KP\_\-8}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_8@{VTK\_\-KP\_\-8}}\item[{\em 
 
159
{\em VTK\_\-KP\_\-8}\label{core_8h_a64a17}
 
160
}]Key\-Pad 8 Key.\index{VTK_KP_9@{VTK\_\-KP\_\-9}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_9@{VTK\_\-KP\_\-9}}\item[{\em 
 
161
{\em VTK\_\-KP\_\-9}\label{core_8h_a64a18}
 
162
}]Key\-Pad 9 Key.\index{VTK_KP_DASH@{VTK\_\-KP\_\-DASH}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_DASH@{VTK\_\-KP\_\-DASH}}\item[{\em 
 
163
{\em VTK\_\-KP\_\-DASH}\label{core_8h_a64a19}
 
164
}]Key\-Pad Dash/Minus/Hyphen Key.\index{VTK_KP_COMMA@{VTK\_\-KP\_\-COMMA}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_COMMA@{VTK\_\-KP\_\-COMMA}}\item[{\em 
 
165
{\em VTK\_\-KP\_\-COMMA}\label{core_8h_a64a20}
 
166
}]Key\-Pad Comma Key.\index{VTK_KP_PERIOD@{VTK\_\-KP\_\-PERIOD}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_PERIOD@{VTK\_\-KP\_\-PERIOD}}\item[{\em 
 
167
{\em VTK\_\-KP\_\-PERIOD}\label{core_8h_a64a21}
 
168
}]Key\-Pad Period Key.\index{VTK_KP_ENTER@{VTK\_\-KP\_\-ENTER}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_ENTER@{VTK\_\-KP\_\-ENTER}}\item[{\em 
 
169
{\em VTK\_\-KP\_\-ENTER}\label{core_8h_a64a22}
 
170
}]Key\-Pad Enter/Return Key.\index{VTK_KP_PF1@{VTK\_\-KP\_\-PF1}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_PF1@{VTK\_\-KP\_\-PF1}}\item[{\em 
 
171
{\em VTK\_\-KP\_\-PF1}\label{core_8h_a64a23}
 
172
}]Key\-Pad PF1 Key.\index{VTK_KP_PF2@{VTK\_\-KP\_\-PF2}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_PF2@{VTK\_\-KP\_\-PF2}}\item[{\em 
 
173
{\em VTK\_\-KP\_\-PF2}\label{core_8h_a64a24}
 
174
}]Key\-Pad PF2 Key.\index{VTK_KP_PF3@{VTK\_\-KP\_\-PF3}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_PF3@{VTK\_\-KP\_\-PF3}}\item[{\em 
 
175
{\em VTK\_\-KP\_\-PF3}\label{core_8h_a64a25}
 
176
}]Key\-Pad PF3 Key.\index{VTK_KP_PF4@{VTK\_\-KP\_\-PF4}!core.h@{core.h}}\index{core.h@{core.h}!VTK_KP_PF4@{VTK\_\-KP\_\-PF4}}\item[{\em 
 
177
{\em VTK\_\-KP\_\-PF4}\label{core_8h_a64a26}
 
178
}]Key\-Pad PF4 Key.\index{VTK_F1@{VTK\_\-F1}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F1@{VTK\_\-F1}}\item[{\em 
 
179
{\em VTK\_\-F1}\label{core_8h_a64a27}
 
180
}]F1 Key.\index{VTK_F2@{VTK\_\-F2}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F2@{VTK\_\-F2}}\item[{\em 
 
181
{\em VTK\_\-F2}\label{core_8h_a64a28}
 
182
}]F2 Key.\index{VTK_F3@{VTK\_\-F3}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F3@{VTK\_\-F3}}\item[{\em 
 
183
{\em VTK\_\-F3}\label{core_8h_a64a29}
 
184
}]F3 Key.\index{VTK_F4@{VTK\_\-F4}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F4@{VTK\_\-F4}}\item[{\em 
 
185
{\em VTK\_\-F4}\label{core_8h_a64a30}
 
186
}]F4 Key.\index{VTK_F5@{VTK\_\-F5}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F5@{VTK\_\-F5}}\item[{\em 
 
187
{\em VTK\_\-F5}\label{core_8h_a64a31}
 
188
}]F5 Key.\index{VTK_F6@{VTK\_\-F6}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F6@{VTK\_\-F6}}\item[{\em 
 
189
{\em VTK\_\-F6}\label{core_8h_a64a32}
 
190
}]F6 Key.\index{VTK_F7@{VTK\_\-F7}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F7@{VTK\_\-F7}}\item[{\em 
 
191
{\em VTK\_\-F7}\label{core_8h_a64a33}
 
192
}]F7 Key.\index{VTK_F8@{VTK\_\-F8}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F8@{VTK\_\-F8}}\item[{\em 
 
193
{\em VTK\_\-F8}\label{core_8h_a64a34}
 
194
}]F8 Key.\index{VTK_F9@{VTK\_\-F9}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F9@{VTK\_\-F9}}\item[{\em 
 
195
{\em VTK\_\-F9}\label{core_8h_a64a35}
 
196
}]F9 Key.\index{VTK_F10@{VTK\_\-F10}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F10@{VTK\_\-F10}}\item[{\em 
 
197
{\em VTK\_\-F10}\label{core_8h_a64a36}
 
198
}]F10 Key.\index{VTK_F11@{VTK\_\-F11}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F11@{VTK\_\-F11}}\item[{\em 
 
199
{\em VTK\_\-F11}\label{core_8h_a64a37}
 
200
}]F11 Key.\index{VTK_F12@{VTK\_\-F12}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F12@{VTK\_\-F12}}\item[{\em 
 
201
{\em VTK\_\-F12}\label{core_8h_a64a38}
 
202
}]F12 Key.\index{VTK_F13@{VTK\_\-F13}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F13@{VTK\_\-F13}}\item[{\em 
 
203
{\em VTK\_\-F13}\label{core_8h_a64a39}
 
204
}]F13 Key.\index{VTK_F14@{VTK\_\-F14}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F14@{VTK\_\-F14}}\item[{\em 
 
205
{\em VTK\_\-F14}\label{core_8h_a64a40}
 
206
}]F14 Key.\index{VTK_F15@{VTK\_\-F15}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F15@{VTK\_\-F15}}\item[{\em 
 
207
{\em VTK\_\-F15}\label{core_8h_a64a41}
 
208
}]F15 Key.\index{VTK_F16@{VTK\_\-F16}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F16@{VTK\_\-F16}}\item[{\em 
 
209
{\em VTK\_\-F16}\label{core_8h_a64a42}
 
210
}]F16 Key.\index{VTK_F17@{VTK\_\-F17}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F17@{VTK\_\-F17}}\item[{\em 
 
211
{\em VTK\_\-F17}\label{core_8h_a64a43}
 
212
}]F17 Key.\index{VTK_F18@{VTK\_\-F18}!core.h@{core.h}}\index{core.h@{core.h}!VTK_F18@{VTK\_\-F18}}\item[{\em 
 
213
{\em VTK\_\-F18}\label{core_8h_a64a44}
 
214
}]F18 Key.\end{description}
 
215
\end{Desc}
 
216
 
 
217
 
 
218
 
 
219
\subsection{Function Documentation}
 
220
\index{core.h@{core.h}!VTCore_clear_selection@{VTCore\_\-clear\_\-selection}}
 
221
\index{VTCore_clear_selection@{VTCore\_\-clear\_\-selection}!core.h@{core.h}}
 
222
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-clear\_\-selection ({\bf VTCore} $\ast$ {\em core})}\label{core_8h_a56}
 
223
 
 
224
 
 
225
Clear selection.
 
226
 
 
227
\begin{Desc}
 
228
\item[Parameters:]
 
229
\begin{description}
 
230
\item[{\em core}]reference to {\bf VTCore} object \end{description}
 
231
\end{Desc}
 
232
\index{core.h@{core.h}!VTCore_copy_buffer@{VTCore\_\-copy\_\-buffer}}
 
233
\index{VTCore_copy_buffer@{VTCore\_\-copy\_\-buffer}!core.h@{core.h}}
 
234
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-copy\_\-buffer ({\bf VTCore} $\ast$ {\em core}, int {\em scol}, int {\em srow}, int {\em ecol}, int {\em erow}, char $\ast$ {\em dest}, int {\em dest\_\-size})}\label{core_8h_a54}
 
235
 
 
236
 
 
237
Copy multibyte characters from buffer.
 
238
 
 
239
\par
 
240
 Caller must allocate dest before calling this method \begin{Desc}
 
241
\item[Parameters:]
 
242
\begin{description}
 
243
\item[{\em core}]reference to {\bf VTCore} object \item[{\em scol}]start column \item[{\em srow}]start row \item[{\em ecol}]end column inclusive \item[{\em erow}]end row inclusive \item[{\em dest}]destination \item[{\em dest\_\-size}]size of destination \end{description}
 
244
\end{Desc}
 
245
\index{core.h@{core.h}!VTCore_copy_selected_buffer@{VTCore\_\-copy\_\-selected\_\-buffer}}
 
246
\index{VTCore_copy_selected_buffer@{VTCore\_\-copy\_\-selected\_\-buffer}!core.h@{core.h}}
 
247
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-copy\_\-selected\_\-buffer ({\bf VTCore} $\ast$ {\em core}, char $\ast$ {\em dest}, int {\em dest\_\-size})}\label{core_8h_a55}
 
248
 
 
249
 
 
250
Copy multibyte characters from buffer.
 
251
 
 
252
\par
 
253
 Caller must allocate dest before calling this method and specfy selection by {\bf VTCore\_\-start\_\-selection }/{\bf VTCore\_\-extend\_\-selection } method. \begin{Desc}
 
254
\item[Parameters:]
 
255
\begin{description}
 
256
\item[{\em core}]reference to {\bf VTCore} object \item[{\em dest}]destination \item[{\em dest\_\-size}]size of destination \end{description}
 
257
\end{Desc}
 
258
\index{core.h@{core.h}!VTCore_destroy@{VTCore\_\-destroy}}
 
259
\index{VTCore_destroy@{VTCore\_\-destroy}!core.h@{core.h}}
 
260
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-destroy ({\bf VTCore} $\ast$ {\em core})}\label{core_8h_a46}
 
261
 
 
262
 
 
263
Destructor of {\bf VTCore} object.
 
264
 
 
265
\begin{Desc}
 
266
\item[Parameters:]
 
267
\begin{description}
 
268
\item[{\em core}]reference to {\bf VTCore} object \end{description}
 
269
\end{Desc}
 
270
\index{core.h@{core.h}!VTCore_dispatch@{VTCore\_\-dispatch}}
 
271
\index{VTCore_dispatch@{VTCore\_\-dispatch}!core.h@{core.h}}
 
272
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-dispatch ({\bf VTCore} $\ast$ {\em core})}\label{core_8h_a63}
 
273
 
 
274
 
 
275
Dispatch host event; This method doesn't return until host sends bytes.
 
276
 
 
277
Caller must detect host event before calling this method. \begin{Desc}
 
278
\item[Parameters:]
 
279
\begin{description}
 
280
\item[{\em core}]reference to {\bf VTCore} object \end{description}
 
281
\end{Desc}
 
282
\index{core.h@{core.h}!VTCore_extend_selection@{VTCore\_\-extend\_\-selection}}
 
283
\index{VTCore_extend_selection@{VTCore\_\-extend\_\-selection}!core.h@{core.h}}
 
284
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-extend\_\-selection ({\bf VTCore} $\ast$ {\em core}, int {\em col}, int {\em row})}\label{core_8h_a53}
 
285
 
 
286
 
 
287
Extend selection.
 
288
 
 
289
\begin{Desc}
 
290
\item[Parameters:]
 
291
\begin{description}
 
292
\item[{\em core}]reference to {\bf VTCore} object \item[{\em col}]end column \item[{\em row}]end row \end{description}
 
293
\end{Desc}
 
294
\index{core.h@{core.h}!VTCore_new@{VTCore\_\-new}}
 
295
\index{VTCore_new@{VTCore\_\-new}!core.h@{core.h}}
 
296
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf VTCore}$\ast$ VTCore\_\-new ({\bf Terminal\-IO} $\ast$ {\em io}, int {\em num\_\-cols}, int {\em num\_\-rows}, int {\em num\_\-history})}\label{core_8h_a45}
 
297
 
 
298
 
 
299
Constructor of {\bf VTCore} object.
 
300
 
 
301
\begin{Desc}
 
302
\item[Parameters:]
 
303
\begin{description}
 
304
\item[{\em io}]reference to {\bf Terminal\-IO} object which {\bf VTCore} connect to \item[{\em num\_\-cols}]number of columns \item[{\em num\_\-rows}]number of rows \item[{\em num\_\-history}]number of saved rows, should be num\_\-rows $<$ \end{description}
 
305
\end{Desc}
 
306
\index{core.h@{core.h}!VTCore_redraw@{VTCore\_\-redraw}}
 
307
\index{VTCore_redraw@{VTCore\_\-redraw}!core.h@{core.h}}
 
308
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-redraw ({\bf VTCore} $\ast$ {\em core}, int {\em scol}, int {\em srow}, int {\em ecol}, int {\em erow})}\label{core_8h_a49}
 
309
 
 
310
 
 
311
method to request redraw to screen model.
 
312
 
 
313
\begin{Desc}
 
314
\item[Parameters:]
 
315
\begin{description}
 
316
\item[{\em core}]reference to {\bf VTCore} object \item[{\em scol}]top left column \item[{\em srow}]top left row \item[{\em ecol}]bottom right column exclusively \item[{\em erow}]bottom right row exclusively \end{description}
 
317
\end{Desc}
 
318
\index{core.h@{core.h}!VTCore_scroll@{VTCore\_\-scroll}}
 
319
\index{VTCore_scroll@{VTCore\_\-scroll}!core.h@{core.h}}
 
320
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-scroll ({\bf VTCore} $\ast$ {\em core}, double {\em top})}\label{core_8h_a57}
 
321
 
 
322
 
 
323
Scroll buffer.
 
324
 
 
325
\begin{Desc}
 
326
\item[Parameters:]
 
327
\begin{description}
 
328
\item[{\em core}]reference to {\bf VTCore} object \item[{\em top}]0.0 is a beginning of buffer \par
 
329
 NOTE: top must be 0.0 - 1.0 \end{description}
 
330
\end{Desc}
 
331
\index{core.h@{core.h}!VTCore_scroll_down@{VTCore\_\-scroll\_\-down}}
 
332
\index{VTCore_scroll_down@{VTCore\_\-scroll\_\-down}!core.h@{core.h}}
 
333
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-scroll\_\-down ({\bf VTCore} $\ast$ {\em core}, int {\em num\_\-line})}\label{core_8h_a61}
 
334
 
 
335
 
 
336
Scroll buffer.
 
337
 
 
338
\begin{Desc}
 
339
\item[Parameters:]
 
340
\begin{description}
 
341
\item[{\em core}]reference to {\bf VTCore} object \item[{\em num\_\-line}]number of line to scroll down \end{description}
 
342
\end{Desc}
 
343
\index{core.h@{core.h}!VTCore_scroll_up@{VTCore\_\-scroll\_\-up}}
 
344
\index{VTCore_scroll_up@{VTCore\_\-scroll\_\-up}!core.h@{core.h}}
 
345
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-scroll\_\-up ({\bf VTCore} $\ast$ {\em core}, int {\em num\_\-line})}\label{core_8h_a60}
 
346
 
 
347
 
 
348
Scroll buffer.
 
349
 
 
350
\begin{Desc}
 
351
\item[Parameters:]
 
352
\begin{description}
 
353
\item[{\em core}]reference to {\bf VTCore} object \item[{\em num\_\-line}]number of line to scroll up \end{description}
 
354
\end{Desc}
 
355
\index{core.h@{core.h}!VTCore_send_key@{VTCore\_\-send\_\-key}}
 
356
\index{VTCore_send_key@{VTCore\_\-send\_\-key}!core.h@{core.h}}
 
357
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int VTCore\_\-send\_\-key ({\bf VTCore} $\ast$ {\em core}, int {\em type})}\label{core_8h_a48}
 
358
 
 
359
 
 
360
method to send specified key
 
361
 
 
362
\begin{Desc}
 
363
\item[Parameters:]
 
364
\begin{description}
 
365
\item[{\em core}]reference to {\bf VTCore} object \item[{\em type}]key type \end{description}
 
366
\end{Desc}
 
367
\index{core.h@{core.h}!VTCore_send_mouse_position@{VTCore\_\-send\_\-mouse\_\-position}}
 
368
\index{VTCore_send_mouse_position@{VTCore\_\-send\_\-mouse\_\-position}!core.h@{core.h}}
 
369
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int VTCore\_\-send\_\-mouse\_\-position ({\bf VTCore} $\ast$ {\em core}, int {\em button}, int {\em modifiers}, int {\em pressed}, int {\em col}, int {\em row})}\label{core_8h_a62}
 
370
 
 
371
 
 
372
Send mouse cursor position This should be called when.
 
373
 
 
374
\begin{Desc}
 
375
\item[Parameters:]
 
376
\begin{description}
 
377
\item[{\em core}]reference to VTScreen object. \item[{\em button}]button number 0 =$<$ \item[{\em modifiers}]modifiers of key(VTM\_\-SHIFT, VTM\_\-META or VTM\_\-CONTROL) \item[{\em pressed}]1 if this button is pressed, 0 if released \item[{\em col}]mouse column \item[{\em row}]mouse row \end{description}
 
378
\end{Desc}
 
379
\begin{Desc}
 
380
\item[Returns:]if send to the host return 1, else 0. Caller should NOT do anything after this returns 1; \end{Desc}
 
381
\index{core.h@{core.h}!VTCore_set_exit_callback@{VTCore\_\-set\_\-exit\_\-callback}}
 
382
\index{VTCore_set_exit_callback@{VTCore\_\-set\_\-exit\_\-callback}!core.h@{core.h}}
 
383
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-set\_\-exit\_\-callback ({\bf VTCore} $\ast$ {\em core}, void($\ast$ {\em proc})({\bf VTScreen\-View} $\ast$view))}\label{core_8h_a58}
 
384
 
 
385
 
 
386
set callback function when host thread finish.
 
387
 
 
388
\begin{Desc}
 
389
\item[Parameters:]
 
390
\begin{description}
 
391
\item[{\em core}]reference to {\bf VTCore} object \item[{\em proc}]reference to function to be called. Function Prototype is void proc(VTScreen\-View $\ast$view), but may be changed ;-) \end{description}
 
392
\end{Desc}
 
393
\index{core.h@{core.h}!VTCore_set_reverse_video@{VTCore\_\-set\_\-reverse\_\-video}}
 
394
\index{VTCore_set_reverse_video@{VTCore\_\-set\_\-reverse\_\-video}!core.h@{core.h}}
 
395
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-set\_\-reverse\_\-video ({\bf VTCore} $\ast$ {\em core}, int {\em on})}\label{core_8h_a59}
 
396
 
 
397
 
 
398
set reverse video
 
399
 
 
400
\begin{Desc}
 
401
\item[Parameters:]
 
402
\begin{description}
 
403
\item[{\em core}]reference to {\bf VTCore} object \item[{\em on}]0 will unset reverse video, 1 is opposite \end{description}
 
404
\end{Desc}
 
405
\index{core.h@{core.h}!VTCore_set_screen_size@{VTCore\_\-set\_\-screen\_\-size}}
 
406
\index{VTCore_set_screen_size@{VTCore\_\-set\_\-screen\_\-size}!core.h@{core.h}}
 
407
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-set\_\-screen\_\-size ({\bf VTCore} $\ast$ {\em core}, int {\em width}, int {\em height})}\label{core_8h_a51}
 
408
 
 
409
 
 
410
method to set Screen size
 
411
 
 
412
\begin{Desc}
 
413
\item[Parameters:]
 
414
\begin{description}
 
415
\item[{\em core}]reference to {\bf VTCore} object \item[{\em width}]new number of cols \item[{\em height}]new number of rows \end{description}
 
416
\end{Desc}
 
417
\index{core.h@{core.h}!VTCore_set_screen_view@{VTCore\_\-set\_\-screen\_\-view}}
 
418
\index{VTCore_set_screen_view@{VTCore\_\-set\_\-screen\_\-view}!core.h@{core.h}}
 
419
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-set\_\-screen\_\-view ({\bf VTCore} $\ast$ {\em core}, {\bf VTScreen\-View} $\ast$ {\em view})}\label{core_8h_a50}
 
420
 
 
421
 
 
422
method to set Screen\-View to Screen\-Model
 
423
 
 
424
\begin{Desc}
 
425
\item[Parameters:]
 
426
\begin{description}
 
427
\item[{\em core}]reference to {\bf VTCore} object \item[{\em view}]reference to Screen\-View object \end{description}
 
428
\end{Desc}
 
429
\index{core.h@{core.h}!VTCore_start_selection@{VTCore\_\-start\_\-selection}}
 
430
\index{VTCore_start_selection@{VTCore\_\-start\_\-selection}!core.h@{core.h}}
 
431
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void VTCore\_\-start\_\-selection ({\bf VTCore} $\ast$ {\em core}, int {\em col}, int {\em row}, int {\em type})}\label{core_8h_a52}
 
432
 
 
433
 
 
434
Start selection.
 
435
 
 
436
\begin{Desc}
 
437
\item[Parameters:]
 
438
\begin{description}
 
439
\item[{\em core}]reference to {\bf VTCore} object \item[{\em col}]start column \item[{\em row}]start row \item[{\em type}]selection type \end{description}
 
440
\end{Desc}
 
441
\index{core.h@{core.h}!VTCore_write@{VTCore\_\-write}}
 
442
\index{VTCore_write@{VTCore\_\-write}!core.h@{core.h}}
 
443
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int VTCore\_\-write (struct \_\-VTCore $\ast$ {\em core}, char $\ast$ {\em mb}, int {\em length})}\label{core_8h_a47}
 
444
 
 
445
 
 
446
method to write input data to Host.
 
447
 
 
448
\begin{Desc}
 
449
\item[Parameters:]
 
450
\begin{description}
 
451
\item[{\em core}]reference to {\bf VTCore} object \item[{\em mb}]reference to multibyte character \item[{\em length}]of character to write \end{description}
 
452
\end{Desc}