/core/sdk-objc/Documentation/GMAppleDouble/Classes/GMAppleDouble_/CompositePage.html
HTML | 166 lines | 163 code | 3 blank | 0 comment | 0 complexity | 0fa57f9ea0a2adef90b751975d7f4aa0 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/1998/REC-html40-19980424/loose.dtd"> 2<html> 3<head> 4<title>GMAppleDouble </title> 5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 6<meta name="generator" content="HeaderDoc"> 7<style type="text/css"><!--.keyword {background:#ffffff; color:#761550;}.template {background:#ffffff; color:#761550;}.number {background: #ffffff; color:#0000ff;}.function {background:#ffffff; color:#000000;}.string {background: #ffffff; color:#891315;}.preprocessor {background:#ffffff; color:#236e25}.comment {background:#ffffff; color:#236e25}.char {background: #ffffff; color:#0000ff;}.var {background:#ffffff; color:#000000;}.type {background:#ffffff; color:#761550;}.param {background:#ffffff; color:#000000;}a:link {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #0000ff;}a:visited:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:active {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}a:hover {text-decoration: underline; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: small; color: #ff6600;}h4 {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: tiny; font-weight: bold;}body {text-decoration: none; font-family: lucida grande, geneva, helvetica, arial, sans-serif; font-size: 10pt;}--></style> 8</head> 9<body bgcolor="#ffffff"> 10<a name="top"></a><a name="//apple_ref/doc/class/GMAppleDouble" title="GMAppleDouble "></a><hr> 11<table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 12<h1><a name="GMAppleDouble">GMAppleDouble </a></h1> 13</td></tr></table> 14<hr> 15<p><b>Superclass:</b> <!-- a logicalPath="//apple_ref/occ/cl/NSObject" -->NSObject<!-- /a --><br><b>Declared In:</b> <a href="../../index.html" target="_top">GMAppleDouble</a><br></p> 16<h5 class="tight"> 17<font face="Lucida Grande,Helvetica,Arial">Discussion</font> 18</h5> 19<p><!-- begin discussion --> This class can be used to construct raw AppleDouble data. 20 <!-- end discussion --></p> 21<p></p> 22<hr> 23<br><h2>Methods</h2> 24<a name="HeaderDoc_methods"></a><dl> 25<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDouble" target="_top">+appleDouble</a></tt></dt> 26<dd>An autoreleased empty GMAppleDouble file </dd> 27<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDoubleWithData:" target="_top">+appleDoubleWithData: </a></tt></dt> 28<dd>An autoreleased GMAppleDouble file. 29</dd> 30<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntry:" target="_top">-addEntry:</a></tt></dt> 31<dd>Adds an entry to the AppleDouble file. 32</dd> 33<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntryWithID:data:" target="_top">-addEntryWithID:data:</a></tt></dt> 34<dd>Adds an entry to the AppleDouble file with ID and data. 35</dd> 36<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntriesFromAppleDoubleData:" target="_top">-addEntriesFromAppleDoubleData: </a></tt></dt> 37<dd>Adds entries based on the provided raw AppleDouble file data. 38</dd> 39<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/entries" target="_top">-entries</a></tt></dt> 40<dd>The set of GMAppleDoubleEntry present in this GMAppleDouble. 41</dd> 42<dt><tt><a href="CompositePage.html#//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/data" target="_top">-data</a></tt></dt> 43<dd>Constructs raw data for the AppleDouble file. 44</dd> 45</dl> 46<hr> 47<!-- headerDoc=clm; uid=//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDouble; name=GMAppleDouble::appleDouble --><a name="//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDouble"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 48<h3><a name="appleDouble">appleDouble</a></h3> 49</td></tr></table> 50<hr> 51<p><!-- begin abstract -->An autoreleased empty GMAppleDouble file <!-- end abstract --></p> 52<p></p> 53<pre>+ (<a href="../../../../Documentation/GMAppleDouble/Classes/GMAppleDouble_/index.html#//apple_ref/occ/cl/GMAppleDouble" logicalPath="//apple_ref/occ/cl/GMAppleDouble" target="_top"><span class="type">GMAppleDouble</span></a> <span class="type">*</span>)<span class="var">appleDouble</span>; </pre> 54<p></p> 55<hr> 56<!-- headerDoc=clm; uid=//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDoubleWithData:; name=GMAppleDouble::appleDoubleWithData: --><a name="//apple_ref/doc/compositePage/occ/clm/GMAppleDouble/appleDoubleWithData:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 57<h3><a name="appleDoubleWithData:">appleDoubleWithData: </a></h3> 58</td></tr></table> 59<hr> 60<p><!-- begin abstract -->An autoreleased GMAppleDouble file. 61<!-- end abstract --></p> 62<p></p> 63<pre>+ (<a href="../../../../Documentation/GMAppleDouble/Classes/GMAppleDouble_/index.html#//apple_ref/occ/cl/GMAppleDouble" logicalPath="//apple_ref/occ/cl/GMAppleDouble" target="_top"><span class="type">GMAppleDouble</span></a> <span class="type">*</span>)<!-- a logicalPath="//apple_ref/occ/instm/appleDoubleWithData //apple_ref/occ/clm/appleDoubleWithData //apple_ref/occ/intfcm/appleDoubleWithData //apple_ref/occ/intfm/appleDoubleWithData //apple_ref/occ/func/appleDoubleWithData //apple_ref/occ/ftmplt/appleDoubleWithData //apple_ref/occ/defn/appleDoubleWithData //apple_ref/occ/macro/appleDoubleWithData" --><span class="function">appleDoubleWithData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSData //apple_ref/occ/tdef/NSData //apple_ref/occ/tag/NSData //apple_ref/occ/econst/NSData //apple_ref/occ/struct/NSData //apple_ref/occ/clconst/NSData //apple_ref/occ/intf/NSData" --><span class="type">NSData</span><!-- /a --> <span class="type">*</span>)<span class="var">data</span>; </pre> 64<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5> 65<dl> 66<dt><code>data </code></dt> 67<dd>Raw AppleDouble file data.</dd> 68</dl> 69<h5 class="tight"> 70<font face="Lucida Grande,Helvetica,Arial">Discussion</font> 71</h5> 72<p><!-- begin discussion -->The GMAppleDouble is pre-filled with entries from the raw 73AppleDouble file data. 74<!-- end discussion --></p> 75<p></p> 76<hr> 77<!-- headerDoc=instm; uid=//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntry:; name=GMAppleDouble::addEntry: --><a name="//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntry:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 78<h3><a name="addEntry:">addEntry:</a></h3> 79</td></tr></table> 80<hr> 81<p><!-- begin abstract -->Adds an entry to the AppleDouble file. 82<!-- end abstract --></p> 83<p></p> 84<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/addEntry //apple_ref/occ/clm/addEntry //apple_ref/occ/intfcm/addEntry //apple_ref/occ/intfm/addEntry //apple_ref/occ/func/addEntry //apple_ref/occ/ftmplt/addEntry //apple_ref/occ/defn/addEntry //apple_ref/occ/macro/addEntry" --><span class="function">addEntry</span><!-- /a -->:(<a href="../../../../Documentation/GMAppleDouble/Classes/GMAppleDoubleEntry_/index.html#//apple_ref/occ/cl/GMAppleDoubleEntry" logicalPath="//apple_ref/occ/cl/GMAppleDoubleEntry" target="_top"><span class="type">GMAppleDoubleEntry</span></a> <span class="type">*</span>)<span class="var">entry</span>; </pre> 85<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5> 86<dl> 87<dt><code>entry </code></dt> 88<dd>The entry to add</dd> 89</dl> 90<p></p> 91<hr> 92<!-- headerDoc=instm; uid=//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntryWithID:data:; name=GMAppleDouble::addEntryWithID:data: --><a name="//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntryWithID:data:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 93<h3><a name="addEntryWithID:data:">addEntryWithID:data:</a></h3> 94</td></tr></table> 95<hr> 96<p><!-- begin abstract -->Adds an entry to the AppleDouble file with ID and data. 97<!-- end abstract --></p> 98<p></p> 99<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/void //apple_ref/occ/tdef/void //apple_ref/occ/tag/void //apple_ref/occ/econst/void //apple_ref/occ/struct/void //apple_ref/occ/clconst/void //apple_ref/occ/intf/void" --><span class="type">void</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/addEntryWithID //apple_ref/occ/clm/addEntryWithID //apple_ref/occ/intfcm/addEntryWithID //apple_ref/occ/intfm/addEntryWithID //apple_ref/occ/func/addEntryWithID //apple_ref/occ/ftmplt/addEntryWithID //apple_ref/occ/defn/addEntryWithID //apple_ref/occ/macro/addEntryWithID" --><span class="function">addEntryWithID</span><!-- /a -->:(<a href="../../../../Documentation/GMAppleDouble/index.html?DataTypes/DataTypes.html#//apple_ref/c/tdef/GMAppleDoubleEntryID" logicalPath="//apple_ref/occ/cl/GMAppleDoubleEntryID //apple_ref/occ/tdef/GMAppleDoubleEntryID" target="_top"><span class="type">GMAppleDoubleEntryID</span></a>)<span class="param">entryID</span> <!-- a logicalPath="//apple_ref/occ/instm/data //apple_ref/occ/clm/data //apple_ref/occ/intfcm/data //apple_ref/occ/intfm/data //apple_ref/occ/func/data //apple_ref/occ/ftmplt/data //apple_ref/occ/defn/data //apple_ref/occ/macro/data" --><span class="function">data</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSData //apple_ref/occ/tdef/NSData //apple_ref/occ/tag/NSData //apple_ref/occ/econst/NSData //apple_ref/occ/struct/NSData //apple_ref/occ/clconst/NSData //apple_ref/occ/intf/NSData" --><span class="type">NSData</span><!-- /a --> <span class="type">*</span>)<span class="var">data</span>; </pre> 100<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5> 101<dl> 102<dt><code>entryID </code></dt> 103<dd>The ID of the entry to add</dd> 104<dt><code>data </code></dt> 105<dd>The raw data for the entry to add (retained)</dd> 106</dl> 107<p></p> 108<hr> 109<!-- headerDoc=instm; uid=//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntriesFromAppleDoubleData:; name=GMAppleDouble::addEntriesFromAppleDoubleData: --><a name="//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/addEntriesFromAppleDoubleData:"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 110<h3><a name="addEntriesFromAppleDoubleData:">addEntriesFromAppleDoubleData: </a></h3> 111</td></tr></table> 112<hr> 113<p><!-- begin abstract -->Adds entries based on the provided raw AppleDouble file data. 114<!-- end abstract --></p> 115<p></p> 116<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/BOOL //apple_ref/occ/tdef/BOOL //apple_ref/occ/tag/BOOL //apple_ref/occ/econst/BOOL //apple_ref/occ/struct/BOOL //apple_ref/occ/clconst/BOOL //apple_ref/occ/intf/BOOL" --><span class="type">BOOL</span><!-- /a -->)<!-- a logicalPath="//apple_ref/occ/instm/addEntriesFromAppleDoubleData //apple_ref/occ/clm/addEntriesFromAppleDoubleData //apple_ref/occ/intfcm/addEntriesFromAppleDoubleData //apple_ref/occ/intfm/addEntriesFromAppleDoubleData //apple_ref/occ/func/addEntriesFromAppleDoubleData //apple_ref/occ/ftmplt/addEntriesFromAppleDoubleData //apple_ref/occ/defn/addEntriesFromAppleDoubleData //apple_ref/occ/macro/addEntriesFromAppleDoubleData" --><span class="function">addEntriesFromAppleDoubleData</span><!-- /a -->:(<!-- a logicalPath="//apple_ref/occ/cl/NSData //apple_ref/occ/tdef/NSData //apple_ref/occ/tag/NSData //apple_ref/occ/econst/NSData //apple_ref/occ/struct/NSData //apple_ref/occ/clconst/NSData //apple_ref/occ/intf/NSData" --><span class="type">NSData</span><!-- /a --> <span class="type">*</span>)<span class="var">data</span>; </pre> 117<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Parameters</font></h5> 118<dl> 119<dt><code>data </code></dt> 120<dd>Raw AppleDouble file data</dd> 121<dt><code>data </code></dt> 122<dd>The raw data for the entry to add (retained)</dd> 123</dl> 124<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5> 125<p><!-- begin return value -->YES if the provided data was parsed correctly. 126 127<!-- end return value --></p> 128<h5 class="tight"> 129<font face="Lucida Grande,Helvetica,Arial">Discussion</font> 130</h5> 131<p><!-- begin discussion -->This will attempt to parse the given data as an AppleDouble file 132and add all entries found. 133<!-- end discussion --></p> 134<p></p> 135<hr> 136<!-- headerDoc=instm; uid=//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/entries; name=GMAppleDouble::entries --><a name="//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/entries"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 137<h3><a name="entries">entries</a></h3> 138</td></tr></table> 139<hr> 140<p><!-- begin abstract -->The set of GMAppleDoubleEntry present in this GMAppleDouble. 141<!-- end abstract --></p> 142<p></p> 143<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSArray //apple_ref/occ/tdef/NSArray //apple_ref/occ/tag/NSArray //apple_ref/occ/econst/NSArray //apple_ref/occ/struct/NSArray //apple_ref/occ/clconst/NSArray //apple_ref/occ/intf/NSArray" --><span class="type">NSArray</span><!-- /a --> <span class="type">*</span>)<span class="var">entries</span>; </pre> 144<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5> 145<p><!-- begin return value -->An array of GMAppleDoubleEntry. 146 147<!-- end return value --></p> 148<p></p> 149<hr> 150<!-- headerDoc=instm; uid=//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/data; name=GMAppleDouble::data --><a name="//apple_ref/doc/compositePage/occ/instm/GMAppleDouble/data"></a><table border="0" cellpadding="2" cellspacing="2" width="300"><tr><td valign="top" height="12" colspan="5"> 151<h3><a name="data">data</a></h3> 152</td></tr></table> 153<hr> 154<p><!-- begin abstract -->Constructs raw data for the AppleDouble file. 155<!-- end abstract --></p> 156<p></p> 157<pre>- (<!-- a logicalPath="//apple_ref/occ/cl/NSData //apple_ref/occ/tdef/NSData //apple_ref/occ/tag/NSData //apple_ref/occ/econst/NSData //apple_ref/occ/struct/NSData //apple_ref/occ/clconst/NSData //apple_ref/occ/intf/NSData" --><span class="type">NSData</span><!-- /a --> <span class="type">*</span>)<span class="var">data</span>; </pre> 158<h5 class="tight"><font face="Lucida Grande,Helvetica,Arial">Return Value</font></h5> 159<p><!-- begin return value -->The raw data for an AppleDouble file represented by this GMAppleDouble. 160 161<!-- end return value --></p> 162<p></p> 163<p>Last Updated: Monday, November 17, 2008 164</p> 165</body> 166</html>