Updated documentation
[libs.git] / docs / html / _common_8h.html
blobf4d4202e4cef90fee56ddbb81615e4e56efbfa54
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>LibSylph: Sylph/Core/Common.h File Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.5.8 -->
7 <div class="navigation" id="top">
8 <div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12 <li><a href="classes.html"><span>Classes</span></a></li>
13 <li class="current"><a href="files.html"><span>Files</span></a></li>
14 <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 </ul>
16 </div>
17 <div class="tabs">
18 <ul>
19 <li><a href="files.html"><span>File&nbsp;List</span></a></li>
20 </ul>
21 </div>
22 </div>
23 <div class="contents">
24 <h1>Sylph/Core/Common.h File Reference</h1>This file is a shortcut to include many commonly used headers.
25 <a href="#_details">More...</a>
26 <p>
27 <code>#include &quot;Any.h&quot;</code><br>
28 <code>#include &quot;Array.h&quot;</code><br>
29 <code>#include &quot;Dictionary.h&quot;</code><br>
30 <code>#include &quot;File.h&quot;</code><br>
31 <code>#include &quot;Primitives.h&quot;</code><br>
32 <code>#include &quot;Range.h&quot;</code><br>
33 <code>#include &quot;String.h&quot;</code><br>
34 <code>#include &quot;Exception.h&quot;</code><br>
36 <p>
37 <div class="dynheader">
38 Include dependency graph for Common.h:</div>
39 <div class="dynsection">
40 <p><center><img src="_common_8h__incl.png" border="0" usemap="#Sylph/Core/Common.h_map" alt=""></center>
41 <map name="Sylph/Core/Common.h_map">
42 <area shape="rect" id="node3" href="_any_8h-source.html" title="Any.h" alt="" coords="134,469,190,499"><area shape="rect" id="node9" href="_exception_8h-source.html" title="Exception.h" alt="" coords="930,547,1032,576"><area shape="rect" id="node14" href="_primitives_8h-source.html" title="Primitives.h" alt="" coords="192,624,290,653"><area shape="rect" id="node27" href="_array_8h-source.html" title="Array.h" alt="" coords="1021,315,1088,344"><area shape="rect" id="node47" href="_range_8h-source.html" title="Range.h" alt="" coords="1297,392,1372,421"><area shape="rect" id="node58" href="_dictionary_8h-source.html" title="Dictionary.h" alt="" coords="578,83,680,112"><area shape="rect" id="node82" href="_string_8h-source.html" title="String.h" alt="" coords="425,237,497,267"><area shape="rect" id="node100" href="_file_8h-source.html" title="File.h" alt="" coords="1548,160,1604,189"><area shape="rect" id="node5" href="_object_8h-source.html" title="Object.h" alt="" coords="842,701,922,731"><area shape="rect" id="node21" href="_current_function_8h-source.html" title="CurrentFunction.h" alt="" coords="945,624,1089,653"><area shape="rect" id="node29" href="_iterable_8h-source.html" title="Iterable.h" alt="" coords="1598,392,1684,421"><area shape="rect" id="node32" href="_iterator_8h-source.html" title="Iterator.h" alt="" coords="1504,469,1589,499"><area shape="rect" id="node43" href="_comparable_8h.html" title="Include this file if you want your objects to be comparable with operator&lt; ,…..." alt="" coords="673,392,785,421"><area shape="rect" id="node39" href="_foreach_8h-source.html" title="Foreach.h" alt="" coords="1521,624,1609,653"><area shape="rect" id="node60" href="_hash_map_8h-source.html" title="HashMap.h" alt="" coords="726,160,820,189"><area shape="rect" id="node63" href="_hash_8h-source.html" title="Hash.h" alt="" coords="458,469,525,499"><area shape="rect" id="node68" href="_equals_8h-source.html" title="Equals.h" alt="" coords="1205,237,1280,267"><area shape="rect" id="node73" href="_util_8h-source.html" title="Util.h" alt="" coords="885,237,941,267"><area shape="rect" id="node88" href="_bool_convertible_8h-source.html" title="BoolConvertible.h" alt="" coords="529,547,668,576"><area shape="rect" id="node92" href="_i18_n_8h-source.html" title="I18N.h" alt="" coords="249,315,313,344"></map>
43 </div>
45 <p>
46 <div class="dynheader">
47 This graph shows which files directly or indirectly include this file:</div>
48 <div class="dynsection">
49 <p><center><img src="_common_8h__dep__incl.png" border="0" usemap="#Sylph/Core/Common.hdep_map" alt=""></center>
50 <map name="Sylph/Core/Common.hdep_map">
51 <area shape="rect" id="node3" href="_byte_buffer_8h-source.html" title="Sylph/Core/ByteBuffer.h" alt="" coords="5,83,189,112"><area shape="rect" id="node5" href="_sylph_8h-source.html" title="Sylph.h" alt="" coords="213,83,280,112"></map>
52 </div>
54 <p>
55 <a href="_common_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
56 <tr><td></td></tr>
57 </table>
58 <hr><a name="_details"></a><h2>Detailed Description</h2>
59 This file is a shortcut to include many commonly used headers.
60 <p>
61 Actually, it will include the following headers (relative to <code>Sylph/Core</code>): <code><ul>
62 <li>
63 <a class="el" href="_any_8h-source.html">Any.h</a> </li>
64 <li>
65 <a class="el" href="_array_8h-source.html">Array.h</a> </li>
66 <li>
67 <a class="el" href="_dictionary_8h-source.html">Dictionary.h</a> </li>
68 <li>
69 <a class="el" href="_file_8h-source.html">File.h</a> </li>
70 <li>
71 <a class="el" href="_primitives_8h-source.html">Primitives.h</a> </li>
72 <li>
73 <a class="el" href="_range_8h-source.html">Range.h</a> </li>
74 <li>
75 <a class="el" href="_string_8h-source.html">String.h</a> </li>
76 <li>
77 <a class="el" href="_exception_8h-source.html">Exception.h</a> </li>
78 </ul>
79 </code> It also has 'using' statements for following classes: <code><ul>
80 <li>
81 <a class="el" href="class_sylph_1_1_array.html" title="Array provides a safe array.">Sylph::Array</a> </li>
82 <li>
83 <a class="el" href="namespace_sylph.html#0c7b0200d7ae06e1607829fc737e1c9a" title="A Dictionary is a HashMap that maps Strings to Anys.">Sylph::Dictionary</a> </li>
84 <li>
85 <a class="el" href="class_sylph_1_1_string.html" title="The String class represents character strings.">Sylph::String</a> </li>
86 <li>
87 Sylph::range </li>
88 </ul>
89 </code> You can turn this of by defining the macro <code>SYLPH_NO_COMMON_USING</code> before inclusion. </div>
90 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
91 Documentation for LibSylph by Doxygen
92 </body>
93 </html>