| <html> |
| <head> |
| <title>How This Reference Document Is Organized</title> |
| <style> h1 { font-size:20pt; margin-top:3pt; margin-bottom:7pt; } |
| h2 { font-family:"Arial"; font-size:16pt; margin-top:3pt; margin-bottom:5pt; } |
| h3 { font-size:13pt; margin-top:2pt; margin-bottom:3pt; } |
| h4 { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dl { margin-top:1pt; margin-bottom:1pt; } |
| dl.member { margin-top:1pt; margin-bottom:1pt; background-color:#eeeeff; } |
| dt { font-size:10pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.member { font-size:13pt; font-weight:bold; margin-top:2pt; margin-bottom:1pt; } |
| dt.simple { font-size:10pt; font-weight:normal; margin-top:2pt; margin-bottom:1pt; } |
| dd { font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| dd.member { font-size:10pt; margin-top:1pt; margin-bottom:1pt; background-color:#ffffff; } |
| p { font-size:10pt; margin-top:3pt; margin-bottom:1pt; } |
| pre { font-family: Times, serif; font-size:10pt; margin-top:1pt; margin-bottom:1pt; } |
| tr { font-size:10pt; } |
| td { font-size:10pt; } |
| </style> |
| |
| <meta HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8"> |
| </head> |
| <body bgcolor="#ffffff"> |
| <a name="_top_"> </a> |
| <table border="0" cellpadding="1" cellspacing="0"> |
| <tr align="center" valign="top"> |
| <td bgcolor="#eeeeff"> <a href="index.html" alt><font family="Arial" color="#000000" size="+1"><b>Overview</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <a href="names/index.html" alt><font family="Arial" color="#000000" size="+1"><b>Namespace</b></font></a> </td> |
| <td bgcolor="#eeeeff"> <font family="Arial" color="#000000" size="+1">Class</font> </td> |
| <td bgcolor="#eeeeff"> <a href="index-files/index-1.html" alt><font family="Arial" color="#000000" size="+1"><b>Index</b></font></a> </td> |
| <td bgcolor="#2222ad"> <font family="Arial" color="#ffffff" size="+1"><b>Help</b></font> </td> |
| </tr> |
| </table> |
| <table cellpadding="0" cellspacing="3"></table> |
| <hr> |
| <div align="center" style="background-color:#ccccff; line-height:26pt;"><h2>How to Use this Reference Document</h2> |
| </div><div style="font-size:10pt;"> |
| <h3 style="background-color: rgb(238,238,255); ">The Main Navigationbar</h3> |
| <p> On top of every page, there is a main navigationbar on a lightly coloured |
| background with the following items:<br> |
| </p> |
| <ul> |
| <li>Overview - the start page for this document,</li> |
| <li>Namespace - the lowest/deepest namespace of the language objects, described |
| on the current page,</li> |
| <li>Class - the class, struct or union, which owns the methods or data, |
| described on the current page,</li> |
| <li>Index - the global alphabetical index,</li> |
| <li>Help - this page.</li> |
| </ul> |
| Each item in this bar can be in three different states:<br> |
| <ul> |
| <li>Link - the item is valid and you can get there,</li> |
| <li>Simple - the item does not apply (if this page described a namespace, |
| there would be no owning class),</li> |
| <li>Reversed (white text on dark background) - this is the current page.</li> |
| </ul> |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">Lower Navigationbars</h3> |
| Just below the main navigation bar, there may be zero to three lower navigationbars |
| on white background.<br> |
| <br> |
| Their items are dependent of the context, but they always link to paragraphs |
| on the same, current page.<br> |
| Available items appear as links. Unavailable items appear as simple text.<br> |
| |
| |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">Namespace Descriptions</h3> |
| |
| <dl> |
| <dt class="simple">Parent namespaces</dt> |
| </dl> |
| <dl> |
| <dd>In front of the namespace title, there is a linked list of the parent |
| namespaces. The global namespace is linked with the first "::",</dd> |
| <dd>the namespaces between the global and the current one are linked |
| by their names.<br> |
| </dd> |
| <dd> </dd> |
| </dl> |
| After the title, the documentation of the namespace follows (which is often |
| missing, because the namespace name may be self-explaining).<br> |
| <br> |
| Below are the lists of nested namspaces and of the classes, functions and |
| other program objects, that belong within this namespace.<br> |
| Each of this lists is accessible by the lower navigationbar on top of the |
| page.<br> |
| |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">Class Descriptions</h3> |
| |
| <dl> |
| <dt class="simple">Parent namespaces and classes</dt> |
| </dl> |
| <dl> |
| <dd>In front of the class title, there is a linked list of the |
| parent namespaces or classes. The global namespace is linked with the first |
| "::",</dd> |
| <dd>the namespaces between the global and the current one are |
| linked by their names. Parent classes are linked as well, but appear in <font color="#33cc00"> |
| green</font> color. </dd> |
| <dd>So you see on the first glance, that this is a parent class, |
| no namespace.<br> |
| </dd> |
| <dd><br> |
| </dd> |
| </dl> |
| After the title, the bases and derivations of the class follow. <br> |
| Base classes are displayed as a graph. The text around base classes can appear |
| in different styles and colours:<br> |
| <ul> |
| <li><font color="#33ff33">Green</font> - public inherited,</li> |
| <li><font color="#ffcc00">Orange</font> - protected inherited,</li> |
| <li><font color="#ff0000">Red </font>- private inherited,</li> |
| <li><font color="#33ff33"><i>italic </i></font>- a (public inherited) virtual base class.</li> |
| <li><b>Bold and black</b> without a link - the placeholder |
| for the currently described class.<br> |
| </li> |
| </ul> |
| There may be many derivations of a class, but only the known ones, which |
| are described within this document also, are listed.<br> |
| <br> |
| Below the derivations is a little table with some properties of the class:<br> |
| <ul> |
| <li>virtual - the class owns at least one virtual method,</li> |
| <li>abstract - the class owns at least one abstract method,</li> |
| <li>interface - the class may or may be not abstract, |
| but it is intended by its author to be used only as an interface and never |
| to be instantiated,</li> |
| <li>template - the class is a template class.<br> |
| </li> |
| </ul> |
| Next comes further documentation of the class itself.<br> |
| <br> |
| Lastly, there are listed all members of the class. Public members come first, |
| then protected, at last the private ones.<br> |
| All member lists are accessible by the lower navigationbars on top of the |
| page.<br> |
| |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">Macros |
| and Defines</h3> |
| In C++ and C, there are also program constructs, which do not fit into the |
| name tree, because they are #define'd: macros and definitions.<br> |
| These may be documented, too. Those comments you find <a href="def-all.html"> |
| here</a> |
| or from the "Overview" start page. |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">Links |
| to IDL-Documentation</h3> |
| Some types, which appear as links, may refer to classes, enums or other |
| entities, which are direct mappings of UNO-IDL entities.<br> |
| In those cases the link doesn't lead to the C++ class, enum or whatever, |
| but to the description of the IDL entity. |
| <h3 style="background-color: rgb(238,238,255); margin-top:12pt;">How to |
| Link From Extern Documents</h3> |
| If you wish to write an extern html document, which links to types within |
| this C++ reference, you can do so, if your links have the following format:<br> |
| <br> |
| <RootDirectory-of-this-Document>/names/<Namespace-A>/<Namespace-XY>/ParentClass-nn>/<TypePreFix>-<MyTypeName>.html<br> |
| <br> |
| <TypePreFix> can have the following values:<br> |
| <ul> |
| <li>c - class, struct or union</li> |
| <li>e - enum</li> |
| <li>t - typedef</li> |
| </ul> |
| If this document would be located in directory "/doc/cpp/ref", examples |
| would look like this:<br> |
| <br> |
| <a href="/doc/cpp/ref/names/osl/c-File.html">class File</a><br> |
| <a href="/doc/cpp/ref/names/osl/FileBase/e-RC.html">enum FileBase::RC</a><br> |
| <a href="/doc/cpp/ref/names/t-oslMutex.html">typedef oslMutex</a><br> |
| <br> |
| Namespaces are described in the index.html file within their directory:<br> |
| <br> |
| <a href="/doc/cpp/ref/names/cppu/index.html">namespace cppu</a><br> |
| </div><hr> |
| <a href="#_top_" class="objchapter">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.</p> |
| </body> |
