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
|
<!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>paintlib: PLDataSource class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.2 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Compound List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Compound Members</a></div>
<h1>PLDataSource Class Reference</h1><code>#include <<a class="el" href="pldatasrc_8h-source.html">pldatasrc.h</a>></code>
<p>
<p>Inheritance diagram for PLDataSource:
<p><center><img src="classPLDataSource.png" usemap="#PLDataSource_map" border="0" alt=""></center>
<map name="PLDataSource_map">
<area href="classPLFileSource.html" alt="PLFileSource" shape="rect" coords="0,112,122,136">
<area href="classPLMemSource.html" alt="PLMemSource" shape="rect" coords="132,112,254,136">
<area href="classPLResourceSource.html" alt="PLResourceSource" shape="rect" coords="264,112,386,136">
</map>
<a href="classPLDataSource-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a0">PLDataSource</a> (<a class="el" href="classPLIProgressNotification.html">PLIProgressNotification</a> *pNotification=NULL)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a2" doxytag="PLDataSource::Open"></a>
virtual void </td><td class="memItemRight" valign=bottom><b>Open</b> (const char *pszName, int FileSize)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a3" doxytag="PLDataSource::Close"></a>
virtual void </td><td class="memItemRight" valign=bottom><b>Close</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a4" doxytag="PLDataSource::GetName"></a>
char * </td><td class="memItemRight" valign=bottom><b>GetName</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a5" doxytag="PLDataSource::GetBufferPtr"></a>
virtual PLBYTE * </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a5">GetBufferPtr</a> (int MinBytesInBuffer)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read but don't advance file pointer. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a6" doxytag="PLDataSource::ReadNBytes"></a>
virtual PLBYTE * </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a6">ReadNBytes</a> (int n)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This needs to be overridden in derived classes. <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a7" doxytag="PLDataSource::GetFileSize"></a>
int </td><td class="memItemRight" valign=bottom><b>GetFileSize</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual PLBYTE * </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a8">ReadEverything</a> ()=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a9" doxytag="PLDataSource::Read1Byte"></a>
PLBYTE * </td><td class="memItemRight" valign=bottom><b>Read1Byte</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a10" doxytag="PLDataSource::Read2Bytes"></a>
PLBYTE * </td><td class="memItemRight" valign=bottom><b>Read2Bytes</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a11" doxytag="PLDataSource::Read4Bytes"></a>
PLBYTE * </td><td class="memItemRight" valign=bottom><b>Read4Bytes</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a12" doxytag="PLDataSource::OProgressNotification"></a>
void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a12">OProgressNotification</a> (double part)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">handles progress notification from other libs <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a13" doxytag="PLDataSource::AlignToWord"></a>
void </td><td class="memItemRight" valign=bottom><b>AlignToWord</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a14" doxytag="PLDataSource::Skip"></a>
void </td><td class="memItemRight" valign=bottom><b>Skip</b> (int n)</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a15" doxytag="PLDataSource::Seek"></a>
virtual void </td><td class="memItemRight" valign=bottom><b>Seek</b> (int n)=0</td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top><a name="a16" doxytag="PLDataSource::CheckEOF"></a>
void </td><td class="memItemRight" valign=bottom><a class="el" href="classPLDataSource.html#a16">CheckEOF</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if we didn't go past the end of the file. <br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a base class for a source of picture data. It defines methods to open, close, and read from data sources. Does byte-order-conversions in the ReadByte, ReadWord, and ReadLong routines.
<p>
<p>
Definition at line <a class="el" href="pldatasrc_8h-source.html#l00031">31</a> of file <a class="el" href="pldatasrc_8h-source.html">pldatasrc.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="PLDataSource::PLDataSource"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> PLDataSource::PLDataSource </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classPLIProgressNotification.html">PLIProgressNotification</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>pNotification</em> = NULL </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs a new data source. pNotification points to an object that reacts to progress notification messages. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a8" doxytag="PLDataSource::ReadEverything"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual PLBYTE* PLDataSource::ReadEverything </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This is a legacy routine that interferes with progress notifications. Don't call it!
<p>
Implemented in <a class="el" href="classPLFileSource.html#a6">PLFileSource</a>, <a class="el" href="classPLMemSource.html#a6">PLMemSource</a>, and <a class="el" href="classPLResourceSource.html#a6">PLResourceSource</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pldatasrc_8h-source.html">pldatasrc.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Sep 13 16:16:41 2004 for paintlib by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.2 </small></address>
</body>
</html>
|
