libnebular Namespace Reference
[User API, Plugin API]

All ⟨libnebular⟩ identifiers which are exposed to public. More...

Namespaces
namespace	bits
	Routines to work with integers as with "bit vectors".
Classes
class	DLLibWrapper
	Dynamically Loadable Library wrapper for GNU/Linux, (?) Solaris. More...
class	PluginIteratorImpl_
class	MgrForPicHandler
	Implementation of PicHandlerMgr for CurrPictureHandler to be parametrized and inherited in each plugin implementation file. More...
class	BmpPictureHandler
	Handles Microsoft BMP. More...
class	JpegPictureHandler
class	ThrowableError
	Error class that can be thrown by plugins (Error is intended only for being catched) More...
class	Log
	Logging facilities. More...
class	NumberedStrings
	Easy conversion between indexed string values and their indices. More...
class	PicHandlerMgr
	Used to determine Picture file type and create appropriate PicHandler. More...
class	PictureHandler
	"Plugin". More...
class	PluginIterator
	C++ iterator, ForwardIterator, iterates through registered PicHandlerMgr classes. More...
class	RawCExceptionLongJmp
	Assists when you need to "throw" C++ exception from below code compiled by C compiler. More...
class	Picture
	Patch for documentation generator malfunction. More...
class	Blob
	Binary Long OBject. More...
class	Error
	Main error-reporting class. More...
class	Core
	Core library services More...
class	LogListener
	Facility allowing to listen messages that come to "log" (emitted by Log class). More...
class	PicturePropContainer
	Property map container for use in Picture. More...
class	PictureProps
	Picture data and operations that are independent of file format, but more complex that just container access More...
Typedefs
typedef MgrForPicHandler < BmpPictureHandler >	BmpPicHandlerMgr
typedef MgrForPicHandler < JpegPictureHandler >	CurrPicHandlerMgr
typedef long long int	Integer
	This Integer is so big that can even hold number of pixels in huge bitmap (and all other integer computations in realization).
typedef long double	Real
typedef std::string	String
	String type that will be used in property names and values.
Functions
PluginIterator	pluginBegin ()
PluginIterator	pluginEnd ()
void	setDefault (PicturePropContainer &p, const String &key, const String &value)
	Sets value to property key of PicturePropContainer p as default.
template<class PicturePropContainerBased >
boost::shared_ptr < PicturePropContainerBased >	createSubtreeProxy (PicturePropContainer &realSubject, const String &subTreePrefix)
	Allows to work with property subtree given by subTreePrefix as with arbitrary object based on PicturePropContainer.
template boost::shared_ptr < PicturePropContainer >	createSubtreeProxy< PicturePropContainer > (PicturePropContainer &realSubject, const String &subTreePrefix)
template boost::shared_ptr < PictureProps >	createSubtreeProxy< PictureProps > (PicturePropContainer &realSubject, const String &subTreePrefix)
template boost::shared_ptr < Picture >	createSubtreeProxy< Picture > (PicturePropContainer &realSubject, const String &subTreePrefix)
template<>
void	PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmColorsUsed > ()
template<>
void	PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmDataSize > ()
template<>
void	PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmSizeLengthUnits > ()
template<>
void	PictureProps::check< PictureProps::PropBmData > ()
template<>
void	PictureProps::check< PictureProps::PropBmPixelFormat > ()
template<>
void	PictureProps::check< PictureProps::PropBmMiscDisplayParams > ()
template<>
void	PictureProps::check< PictureProps::PropBmMiscStorageParams > ()
template<>
void	PictureProps::check< PictureProps::PropBmPixelsPerLength > ()
template<>
void	PictureProps::calculate< PictureProps::PropCalcBmSizeLengthUnits > ()
template<>
void	PictureProps::calculate< PictureProps::PropCalcBmPixelMaskMisc > ()
template<>
void	PictureProps::calculate< PictureProps::PropCalcBmColorsUsed > ()
template<>
void	PictureProps::calculate< PictureProps::PropCalcBmDataSize > ()
template<>
void	PictureProps::check< PictureProps::PropBmInfo > ()

---

Detailed Description

All ⟨libnebular⟩ identifiers which are exposed to public.

Attention:

Namespace is NOT intended to be introduced in user namespace (unlike namespaces std, boost). Instead, use using or some typedef like

 using libnebular::Picture;

or

 typedef libnebular::Picture Picture;

---

Typedef Documentation

typedef MgrForPicHandler<BmpPictureHandler> libnebular::BmpPicHandlerMgr

Definition at line 718 of file libnebular-plugin-bmp.cpp.

typedef MgrForPicHandler<JpegPictureHandler> libnebular::CurrPicHandlerMgr

Definition at line 479 of file libnebular-plugin-jpeg.cpp.

typedef long double libnebular::Real

Definition at line 99 of file libnebular.hpp.

---

Function Documentation

template boost::shared_ptr<Picture> libnebular::createSubtreeProxy< Picture >	(	PicturePropContainer &	realSubject,
		const String &	subTreePrefix
	)

Here is the caller graph for this function:

template boost::shared_ptr<PicturePropContainer> libnebular::createSubtreeProxy< PicturePropContainer >	(	PicturePropContainer &	realSubject,
		const String &	subTreePrefix
	)

Here is the caller graph for this function:

template boost::shared_ptr<PictureProps> libnebular::createSubtreeProxy< PictureProps >	(	PicturePropContainer &	realSubject,
		const String &	subTreePrefix
	)

template<>

void libnebular::PictureProps::calculate< PictureProps::PropCalcBmColorsUsed >

(

)

[inline]

template<>

void libnebular::PictureProps::calculate< PictureProps::PropCalcBmDataSize >

(

)

[inline]

template<>

void libnebular::PictureProps::calculate< PictureProps::PropCalcBmPixelMaskMisc >

(

)

[inline]

template<>

void libnebular::PictureProps::calculate< PictureProps::PropCalcBmSizeLengthUnits >

(

)

[inline]

template<>

void libnebular::PictureProps::check< PictureProps::PropBmData >

(

)

[inline]

template<>

void libnebular::PictureProps::check< PictureProps::PropBmInfo >

(

)

[inline]

template<>

void libnebular::PictureProps::check< PictureProps::PropBmMiscDisplayParams >

(

)

[inline]

template<>

void libnebular::PictureProps::check< PictureProps::PropBmMiscStorageParams >

(

)

[inline]

template<>

void libnebular::PictureProps::check< PictureProps::PropBmPixelFormat >

(

)

[inline]

Grayscale

template<>

void libnebular::PictureProps::check< PictureProps::PropBmPixelsPerLength >

(

)

[inline]

Design note:

That's good way to compare through "dpi" and not "dots-per-m" because... Hmm... "dots-per-m" -> "dpi" is unambiguous and "dpi" -> "dots-per-m" is ambiguous

template<>

void libnebular::PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmColorsUsed >

(

)

[inline]

template<>

void libnebular::PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmDataSize >

(

)

[inline]

template<>

void libnebular::PictureProps::Impl_::calculateUnchecked< PictureProps::PropCalcBmSizeLengthUnits >

(

)

[inline]

PluginIterator libnebular::pluginBegin

(

)

PluginIterator libnebular::pluginEnd

(

)