User API

Collaboration diagram for User API:

Classes
class	libnebular::Blob
	Binary Long OBject. More...
class	libnebular::Error
	Main error-reporting class. More...
class	libnebular::Core
	Core library services More...
class	libnebular::LogListener
	Facility allowing to listen messages that come to "log" (emitted by Log class). More...
class	libnebular::PicturePropContainer
	Property map container for use in Picture. More...
class	libnebular::PicturePropContainer::PropKeyIterator
	C++ iterator, ForwardIterator, iterating through PicturePropContainer key names. More...
class	libnebular::PictureProps
	Picture data and operations that are independent of file format, but more complex that just container access More...
class	libnebular::Picture
	Patch for documentation generator malfunction. More...
Namespaces
namespace	libnebular
	All ⟨libnebular⟩ identifiers which are exposed to public.
namespace	libnebular::bits
	Routines to work with integers as with "bit vectors".
Files
file	libnebular.hpp
	LibNebular, user API.
Typedefs
typedef long long int	libnebular::Integer
	This Integer is so big that can even hold number of pixels in huge bitmap (and all other integer computations in realization).
typedef std::string	libnebular::String
	String type that will be used in property names and values.
Functions
template<class PicturePropContainerBased >
boost::shared_ptr < PicturePropContainerBased >	libnebular::createSubtreeProxy (PicturePropContainer &realSubject, const String &subTreePrefix)
	Allows to work with property subtree given by subTreePrefix as with arbitrary object based on PicturePropContainer.

---

Detailed Description

See also:

Properties

---

Typedef Documentation

typedef long long int libnebular::Integer

This Integer is so big that can even hold number of pixels in huge bitmap (and all other integer computations in realization).

Note:

long long int is type from C99 and C++0x

Definition at line 97 of file libnebular.hpp.

typedef std::string libnebular::String

String type that will be used in property names and values.

Note:

Can have small problems with internationalization. Use ⟨UTF-8⟩.

Definition at line 105 of file libnebular.hpp.

---

Function Documentation

template<class PicturePropContainerBased >

boost::shared_ptr< PicturePropContainerBased > libnebular::createSubtreeProxy	(	PicturePropContainer &	realSubject,
		const String &	subTreePrefix
	)			[inline]

Allows to work with property subtree given by subTreePrefix as with arbitrary object based on PicturePropContainer.

Specialized for PicturePropContainer, PictureProps, Picture.

If extracted subtree "can be seen" as "real" Picture (as in "bm/palette"), that's recommended to extract it as Picture or PictureProps. Otherwise (case when subtree is "arbitrary", doesn't have enough properties that every Picture "should" have), extract that as PicturePropContainer.

Definition at line 709 of file picture-prop-container.cpp.