Public Types | Public Member Functions | Private Attributes | List of all members
SearchIndexIntf Class Referenceabstract

#include <searchindex.h>

Inheritance diagram for SearchIndexIntf:
SearchIndex SearchIndexExternal

Public Types

enum  Kind { Internal, External }
 

Public Member Functions

 SearchIndexIntf (Kind k)
 
virtual ~SearchIndexIntf ()
 
virtual void setCurrentDoc (Definition *ctx, const char *anchor, bool isSourceFile)=0
 
virtual void addWord (const char *word, bool hiPriority)=0
 
virtual void write (const char *file)=0
 
Kind kind () const
 

Private Attributes

Kind m_kind
 

Detailed Description

Definition at line 69 of file searchindex.h.

Member Enumeration Documentation

Enumerator
Internal 
External 

Definition at line 72 of file searchindex.h.

Constructor & Destructor Documentation

SearchIndexIntf::SearchIndexIntf ( Kind  k)
inline

Definition at line 73 of file searchindex.h.

virtual SearchIndexIntf::~SearchIndexIntf ( )
inlinevirtual

Definition at line 74 of file searchindex.h.

74 {}

Member Function Documentation

virtual void SearchIndexIntf::addWord ( const char *  word,
bool  hiPriority 
)
pure virtual

Implemented in SearchIndexExternal, and SearchIndex.

Kind SearchIndexIntf::kind ( ) const
inline

Definition at line 78 of file searchindex.h.

78 { return m_kind; }
virtual void SearchIndexIntf::setCurrentDoc ( Definition ctx,
const char *  anchor,
bool  isSourceFile 
)
pure virtual

Implemented in SearchIndexExternal, and SearchIndex.

virtual void SearchIndexIntf::write ( const char *  file)
pure virtual

Implemented in SearchIndexExternal, and SearchIndex.

Member Data Documentation

Kind SearchIndexIntf::m_kind
private

Definition at line 80 of file searchindex.h.


The documentation for this class was generated from the following file: