@database catalogList_example

@node main "Introduction to catalogList"

The catalogList object is exactly what its name suggests - a list of
catalogs. It was developed for internal use of the oomodules hierarchy.
Since each object can have it's own catalog and an application can use
many objects there has to be a way to deal with any number of catalogs
open at any time.

This is were the catalogList object comes in handy. By using the
setCurrentCatalog() method one can switch between catalogs. It doesn't
matter if this catalog is open or not, if this function returns non-NIL
access is granted.

There is an @{" example " link EMODULES:oomodules/library/locale/catalogList/test.e/main} available

There is an @{" autodoc " link EMODULES:oomodules/oodoc/guides/catalogList/main} file available or this object.



Again, this object was developed for internal use. Yes, you can use it
in your applications, but normally there should be no need for it for
an application has only one catalog.

@endnode
