All Frameworks Class Hierarchy This Framework Indexes
ComponentsCatalogsInterfaces Interface CATICatalogChapterFactory
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICatalogChapterFactory
Interface to manage (create,delete,list) chapters in a catalog document.
Role: This interface is used to create, to find or to
delete chapters within a catalog document. This interface is implemented
on the root container of the catalog document. You retrieve it thanks to
the CATInit.GetRootContainer method.
All the chapters are stored
in the root container. The tree structure of the chapters is done by
descriptions.
- See also:
- CATICatalogChapter, CATICatalogDescription
Method Index
- o
CreateChapter(CATUnicodeString&,CATBoolean,CATICatalogChapter*&)
- Creates a new chapter.
- o
DeleteChapter(CATICatalogChapter*&,CATUnicodeString&,int)
- Removes a chapter and all its descriptions and keywords.
- o
FindChapter(CATUnicodeString&,CATICatalogChapter*&)
- Retrieves a chapter from its name in the current document.
- o
FindListChapter(CATUnicodeString&,CATListValCATICatalogChapter_var&)
- Retrieves the list of chapters from its name in the root container.
- o
GetRootChapter(CATICatalogChapter*&)
- Retrieves the root chapter of the current document.
- o
ListChapters(CATListValCATICatalogChapter_var*&)
- Retrieves the list of chapters in the root container.
Methods
o CreateChapter
| public virtual CreateChapter( | const | iName, |
| | iKindIsEndChapter, |
| | oNewChapter) |
-
Creates a new chapter.
- Parameters:
-
- iName
- The name of the chapter.
- iKindIsEndChapter
- The type of the chapter.
- FALSE:This chapter contains sub-chapter.
- TRUE:This chapter contains descriptions which all
have links towards a component (feature,document,...) but not an
another chapter. In this case the chapter is also named a family
- oNewChapter
- [out, CATBaseUnknown#Release] The new created chapter.
o DeleteChapter
| public virtual DeleteChapter( | | iChapterToDelete, |
| | oErrorMessage, |
| | iManageImpact | = 1) |
-
Removes a chapter and all its descriptions and keywords.
- Parameters:
-
- iChapterToDelete
- The chapter to delete.
- oErrorMessage
- The error message if E_FAIL.
- iManageImpact
- 1 to delete all links on this chapter in the current container.
o FindChapter
| public virtual FindChapter( | const | iName, |
| | oChapter) |
-
Retrieves a chapter from its name in the current document.
- Parameters:
-
- iName
- The name of the chapter to retrieve.
- oChapter
- [out, CATBaseUnknown#Release] The retrieved chapter.
o FindListChapter
| public virtual FindListChapter( | const | iName, |
| | oChapterList) |
-
Retrieves the list of chapters from its name in the root container.
Role:This method retrieves only the chapters inside the current
root container. It means that this method doesn't retrieve the external chapters.
- Parameters:
-
- iName
- The name of the chapter to retrieve.
- oChapterList
- The list of retrieved chapters.
o GetRootChapter
| public virtual GetRootChapter( | | oChapter) |
-
Retrieves the root chapter of the current document.
Role:The first chapter created by the
CreateChapter method is the root chapter. This method retrievesn among all the chapters of the root
container, the first created.
- Parameters:
-
- oChapter
- [out, CATBaseUnknown#Release] The root chapter.
o ListChapters
| public virtual ListChapters( | | oListChapters) |
-
Retrieves the list of chapters in the root container.
Role:This method retrieves only the chapters inside the current
root container. It means that this method doesn't retrieve the external chapters.
- Parameters:
-
- oListChapters
- The list of chapters.
This object is included in the file: CATICatalogChapterFactory.h
If needed, your Imakefile.mk should include the module: CATCclInterfaces