-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclass_book_writer.html
176 lines (166 loc) · 8.78 KB
/
class_book_writer.html
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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.11.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Book Shelf: BookWriter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">Book Shelf
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.11.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="class_book_writer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">BookWriter Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="class_book_writer.html" title="The BookWriter class is responsible for serializing a list of books to an XML file....">BookWriter</a> class is responsible for serializing a list of books to an XML file. It uses the <a class="el" href="class_file_writer.html" title="The FileWriter class is responsible for writing a string to a file.">FileWriter</a> class to handle the file writing.
<a href="#details">More...</a></p>
<p><code>#include <<a class="el" href="bookwriter_8h_source.html">bookwriter.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a01edd9b7166246fc849d22bbebe94eeb" id="r_a01edd9b7166246fc849d22bbebe94eeb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a01edd9b7166246fc849d22bbebe94eeb">BookWriter</a> (const QString &fileName)</td></tr>
<tr class="memdesc:a01edd9b7166246fc849d22bbebe94eeb"><td class="mdescLeft"> </td><td class="mdescRight">Construct a new <a class="el" href="class_book_writer.html" title="The BookWriter class is responsible for serializing a list of books to an XML file....">BookWriter</a> object. <br /></td></tr>
<tr class="separator:a01edd9b7166246fc849d22bbebe94eeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6de35666c98c2b59c044a86e55431a3c" id="r_a6de35666c98c2b59c044a86e55431a3c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6de35666c98c2b59c044a86e55431a3c">write</a> (const QList< <a class="el" href="class_book.html">Book</a> * > bookList)</td></tr>
<tr class="memdesc:a6de35666c98c2b59c044a86e55431a3c"><td class="mdescLeft"> </td><td class="mdescRight">Write a list of books to the file. <br /></td></tr>
<tr class="separator:a6de35666c98c2b59c044a86e55431a3c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="class_book_writer.html" title="The BookWriter class is responsible for serializing a list of books to an XML file....">BookWriter</a> class is responsible for serializing a list of books to an XML file. It uses the <a class="el" href="class_file_writer.html" title="The FileWriter class is responsible for writing a string to a file.">FileWriter</a> class to handle the file writing. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a01edd9b7166246fc849d22bbebe94eeb" name="a01edd9b7166246fc849d22bbebe94eeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01edd9b7166246fc849d22bbebe94eeb">◆ </a></span>BookWriter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BookWriter::BookWriter </td>
<td>(</td>
<td class="paramtype">const QString &</td> <td class="paramname"><span class="paramname"><em>fileName</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a new <a class="el" href="class_book_writer.html" title="The BookWriter class is responsible for serializing a list of books to an XML file....">BookWriter</a> object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fileName</td><td>The name of the file to write to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6de35666c98c2b59c044a86e55431a3c" name="a6de35666c98c2b59c044a86e55431a3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6de35666c98c2b59c044a86e55431a3c">◆ </a></span>write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool BookWriter::write </td>
<td>(</td>
<td class="paramtype">const QList< <a class="el" href="class_book.html">Book</a> * ></td> <td class="paramname"><span class="paramname"><em>bookList</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a list of books to the file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">bookList</td><td>The list of books to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true If the write operation was successful. </dd>
<dd>
false If the write operation failed. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/Users/mitchcampbell/Local Projects/COS3711-03/COS3711-03-01/src/<a class="el" href="bookwriter_8h_source.html">bookwriter.h</a></li>
<li>/Users/mitchcampbell/Local Projects/COS3711-03/COS3711-03-01/src/<a class="el" href="bookwriter_8cpp.html">bookwriter.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.11.0
</small></address>
</div><!-- doc-content -->
</body>
</html>