The free and open productivity suite

How to Use this Reference Document

The Main Navigationbar

On top of every page, there is a main navigationbar on a lightly coloured background with the following items:

• Overview - the start page for this document,
• Namespace - the lowest/deepest namespace of the language objects, described on the current page,
• Class - the class, struct or union, which owns the methods or data, described on the current page,
• Index - the global alphabetical index,
• Help - this page.

Each item in this  bar can be in three different states:

• Link - the item is valid and you can get there,
• Simple - the item does not apply (if this page described a namespace, there would be no owning class),
• Reversed (white text on dark background) - this is the current page.

Lower Navigationbars

Just below the main navigation bar, there may be zero to three lower navigationbars on white background.

Their items are dependent of the context, but they always link to paragraphs on the same, current page.
Available items appear as links. Unavailable items appear as simple text.

Namespace Descriptions

Parent namespaces

In front of the namespace title, there is a linked list of the parent namespaces. The global namespace is linked with the first "::",

the namespaces between the global and the current one are linked by their names.

After the title, the documentation of the namespace follows (which is often missing, because the namespace name may be self-explaining).

Below are the lists of nested namspaces and of the classes, functions and other program objects, that belong within this namespace.
Each of this lists is accessible by the lower navigationbar on top of the page.

Class Descriptions

Parent namespaces and classes

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 "::",

the namespaces between the global and the current one are linked by their names. Parent classes are linked as well, but appear in green color. 

So you see on the first glance, that this is a parent class, no namespace.

After the title, the bases and derivations of the class follow.
Base classes are displayed as a graph. The text around base classes can appear in different styles and colours:

• Green - public inherited,
• Orange - protected inherited,
• Red - private inherited,
• italic - a (public inherited) virtual base class.
• Bold and black without a link - the placeholder for the currently described class.
  

There may be many derivations of a class, but only the known ones, which are described within this document also, are listed.

Below the derivations is a little table with some properties of the class:

• virtual - the class owns at least one virtual method,
• abstract - the class owns at least one abstract method,
• 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,
• template - the class is a template class.
  

Next comes further documentation of the class itself.

Lastly, there are listed all members of the class. Public members come first, then protected, at last the private ones.
All member lists are accessible by the lower navigationbars on top of the page.

Macros and Defines

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.
These may be documented, too. Those comments you find here or from the "Overview" start page.

Links to IDL-Documentation

Some types, which appear as links, may refer to classes, enums or other entities, which are direct mappings of UNO-IDL entities.
In those cases the link doesn't lead to the C++ class, enum or whatever, but to the description of the IDL entity.

How to Link From Extern Documents

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:

<RootDirectory-of-this-Document>/names/<Namespace-A>/<Namespace-XY>/ParentClass-nn>/<TypePreFix>-<MyTypeName>.html

<TypePreFix> can have the following values:

• c - class, struct or union
• e - enum
• t - typedef

If this document would be located in directory  "/doc/cpp/ref", examples would look like this:

<a href="/doc/cpp/ref/names/osl/c-File.html">class File</a>
<a href="/doc/cpp/ref/names/osl/FileBase/e-RC.html">enum FileBase::RC</a>
<a href="/doc/cpp/ref/names/t-oslMutex.html">typedef oslMutex</a>

Namespaces are described in the index.html file within their directory:

<a href="/doc/cpp/ref/names/cppu/index.html">namespace cppu</a>