File: struct__VTScreenView.html

package info (click to toggle)
iterm 0.5-3.2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,208 kB
  • ctags: 1,934
  • sloc: sh: 12,139; ansic: 11,446; makefile: 240
file content (386 lines) | stat: -rw-r--r-- 16,269 bytes parent folder | download | duplicates (3)
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>_VTScreenView struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3-rc2 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>_VTScreenView Struct Reference</h1>VTScreenView interface. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="screen_8h-source.html">screen.h</a>&gt;</code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="m0" doxytag="_VTScreenView::object"></a>
void *&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m0">object</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>reference to platform dependent VTScreenView object</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m1">draw_text</a> )(struct _VTScreenView *view, int col, int row, char *mbstring, int length, int width)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>draw text in screen</em> <a href="#m1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m2">update_cursor_position</a> )(struct _VTScreenView *view, int col, int row)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>set cursor position</em> <a href="#m2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m3">set_rendition</a> )(struct _VTScreenView *view, int bold, int blink, int inverse, int underline, int foreground, int background, char charset)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>set graphic rendition of text</em> <a href="#m3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m4">clear_rect</a> )(struct _VTScreenView *view, int s_col, int s_row, int e_col, int e_row)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>clear specified rectangular</em> <a href="#m4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m5">swap_video</a> )(struct _VTScreenView *view)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>swap foreground and background color permanently</em> <a href="#m5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m6">ring</a> )(struct _VTScreenView *view)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>ring the bell</em> <a href="#m6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m7">resize_request</a> )(struct _VTScreenView *view, int cols, int rows)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>request new size of the screen</em> <a href="#m7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m8">notify_osc</a> )(struct _VTScreenView *view, int type, char *params, int n_params)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>notify OSC(operating system command)</em> <a href="#m8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m9">update_scrollbar</a> )(struct _VTScreenView *view, int max, int top, int shown)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>notify scrollbar event</em> <a href="#m9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void(*&nbsp;</td><td valign=bottom><a class="el" href="struct__VTScreenView.html#m10">scroll_view</a> )(struct _VTScreenView *view, int dest_row, int src_row, int num_line)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>notify scrollbar event</em> <a href="#m10"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
VTScreenView interface.
<p>
<br>
 View of VTScreen. User must create instance that implements these methods. To short, this is a set of callback functions which are called by <a class="el" href="structVTCore.html">VTCore </a> 
<p>
<hr><h2>Field Documentation</h2>
<a name="m4" doxytag="_VTScreenView::clear_rect"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::clear_rect)(struct _VTScreenView *view,int s_col, int s_row, int e_col, int e_row)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
clear specified rectangular
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>s_col</em>&nbsp;</td><td>top left column </td></tr>
    <tr><td valign=top><em>s_row</em>&nbsp;</td><td>top left row </td></tr>
    <tr><td valign=top><em>e_col</em>&nbsp;</td><td>bottom right column </td></tr>
    <tr><td valign=top><em>e_row</em>&nbsp;</td><td>bottom right row </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m1" doxytag="_VTScreenView::draw_text"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::draw_text)(struct _VTScreenView *view,int col, int row, char *mbstring, int length,int width)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
draw text in screen
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>col</em>&nbsp;</td><td>start column to draw text </td></tr>
    <tr><td valign=top><em>row</em>&nbsp;</td><td>start row to draw text </td></tr>
    <tr><td valign=top><em>mbstring</em>&nbsp;</td><td>reference multibyte string </td></tr>
    <tr><td valign=top><em>length</em>&nbsp;</td><td>length of multibyte string </td></tr>
    <tr><td valign=top><em>width</em>&nbsp;</td><td>column width of multibyte string </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m8" doxytag="_VTScreenView::notify_osc"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::notify_osc)(struct _VTScreenView *view, int type, char *params, int n_params)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
notify OSC(operating system command)
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>type</em>&nbsp;</td><td>type of OSC </td></tr>
    <tr><td valign=top><em>params</em>&nbsp;</td><td>parameter string </td></tr>
    <tr><td valign=top><em>n_params</em>&nbsp;</td><td>length of parameter string</td></tr>
  </table>
</dl>
type is usually(on xterm) decoded as <br>
 0 - change icon &amp; window title <br>
 1 - change icon title <br>
 2 - change window titile <br>
 46 - change log file <br>
 50 - change font <br>
     </td>
  </tr>
</table>
<a name="m7" doxytag="_VTScreenView::resize_request"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::resize_request)(struct _VTScreenView *view, int cols, int rows)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
request new size of the screen
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>cols</em>&nbsp;</td><td>number of request columns </td></tr>
    <tr><td valign=top><em>rows</em>&nbsp;</td><td>number of request rows </td></tr>
    <tr><td valign=top><em>cols</em>&nbsp;</td><td>number of actual new columns </td></tr>
    <tr><td valign=top><em>rows</em>&nbsp;</td><td>number of actual new rows</td></tr>
  </table>
</dl>
ScreenView must return actual rows and columns for model know if request had been accepted or not.     </td>
  </tr>
</table>
<a name="m6" doxytag="_VTScreenView::ring"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::ring)(struct _VTScreenView *view)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
ring the bell
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m10" doxytag="_VTScreenView::scroll_view"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::scroll_view)(struct _VTScreenView *view, int dest_row, int src_row, int num_line)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
notify scrollbar event
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>dest_row</em>&nbsp;</td><td>destination row position </td></tr>
    <tr><td valign=top><em>src_row</em>&nbsp;</td><td>source row position </td></tr>
    <tr><td valign=top><em>num_line</em>&nbsp;</td><td>number of line to bitblit </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m3" doxytag="_VTScreenView::set_rendition"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::set_rendition)(struct _VTScreenView *view, int bold, int blink, int inverse, int underline, int foreground, int background, char charset)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
set graphic rendition of text
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>bold</em>&nbsp;</td><td>bold text </td></tr>
    <tr><td valign=top><em>inverse</em>&nbsp;</td><td>reverse text </td></tr>
    <tr><td valign=top><em>underline</em>&nbsp;</td><td>underlined text </td></tr>
    <tr><td valign=top><em>foreground</em>&nbsp;</td><td>foreground color number(1 - 9) may change </td></tr>
    <tr><td valign=top><em>background</em>&nbsp;</td><td>background color number(1 - 9) may change </td></tr>
    <tr><td valign=top><em>charset</em>&nbsp;</td><td>graphic character sets <br>
 A - UK charset <br>
 B - ASCII charset <br>
 0 - Special Graphics <br>
 1 - Alternate Rom character set <br>
 2 - Alternate Rom Special Graphics </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m5" doxytag="_VTScreenView::swap_video"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::swap_video)(struct _VTScreenView *view)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
swap foreground and background color permanently
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object.</td></tr>
  </table>
</dl>
After calling this, whole background color will be swaped.     </td>
  </tr>
</table>
<a name="m2" doxytag="_VTScreenView::update_cursor_position"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::update_cursor_position)(struct _VTScreenView *view,int col, int row)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
set cursor position
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>col</em>&nbsp;</td><td>start column to draw text </td></tr>
    <tr><td valign=top><em>row</em>&nbsp;</td><td>start row to draw text </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<a name="m9" doxytag="_VTScreenView::update_scrollbar"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void(* _VTScreenView::update_scrollbar)(struct _VTScreenView *view, int max, int top, int shown)
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
notify scrollbar event
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>view</em>&nbsp;</td><td>reference to VTScreenView object </td></tr>
    <tr><td valign=top><em>max</em>&nbsp;</td><td>max length of scrollbar </td></tr>
    <tr><td valign=top><em>top</em>&nbsp;</td><td>point of scrollbar </td></tr>
    <tr><td valign=top><em>shown</em>&nbsp;</td><td>length of scrollbar thumb </td></tr>
  </table>
</dl>
    </td>
  </tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="screen_8h-source.html">screen.h</a></ul>
<hr><address style="align: right;"><small>Generated on Sun Dec 29 16:55:32 2002 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.3-rc2 </small></address>
</body>
</html>