---

WWhizTag Class Reference

The interface to the attributes of a tag. More...

#include <WWhizInterface2.h>

List of all members.

Public Types
enum	Access { PUBLIC, PROTECTED, PRIVATE, FRIEND }
	The access type of the tag. More...
enum	ImplementationType { DEFAULT, ABSTRACT, VIRTUAL, PUREVIRTUAL }
	The implementation type of the tag. More...
enum	Type {   CLASS, DECLARATION, DEFINE, ENUM,   ENUMMEMBER, FILE, FUNCTION, MEMBER,   NAMESPACE, STRUCTURE, TYPEDEF, UNION,   VARIABLE, LAST_TYPE }
	The various types a tag can be. More...
Public Methods
virtual Type	GetType (void)const=0
virtual LPCSTR	GetShortIdent (void)const=0
	To facilitate faster tag lookups, every tag has a "short" identifier associated with it. More...
virtual LPCSTR	GetIdent (void)const=0
virtual LPCSTR	GetFilename (void)const=0
virtual LPCSTR	GetSearchString (void)const=0
virtual LPCSTR	GetShortParentIdent (void)const=0
	To facilitate faster tag lookups, every parent tag has a "short" identifier associated with it. More...
virtual LPCSTR	GetParentIdent (void)const=0
virtual int	GetLineNumber (void)const=0
virtual WWhizTag*	GetMatchNext (void)const=0
virtual WWhizTag*	GetMatchPrev (void)const=0
virtual Access	GetAccess (void)const=0
virtual LPCSTR	GetNamespace (void)const=0
virtual WWhizTag*	GetBuddy (void)const=0
	Retrieves the buddy of the tag. More...
virtual ImplementationType	GetImplementationType (void)const=0

---

Detailed Description

The interface to the attributes of a tag.

This class represents a single tag.

---

Member Enumeration Documentation

enum WWhizTag::Access

The access type of the tag. Enumeration values: PUBLIC   A public class member. PROTECTED   A protected class member. PRIVATE   A private class member. FRIEND

enum WWhizTag::ImplementationType

The implementation type of the tag. Enumeration values: DEFAULT   ABSTRACT   VIRTUAL   PUREVIRTUAL

enum WWhizTag::Type

The various types a tag can be. Enumeration values: CLASS   A class definition. DECLARATION   A tag prototype. DEFINE   A define statement. ENUM   An enumeration. ENUMMEMBER   An enumeration's member. FILE   A file. FUNCTION   A function. MEMBER   A class or structure member. NAMESPACE   A namespace. STRUCTURE   A structure definition. TYPEDEF   A typedef definition. UNION   A union. VARIABLE   A variable. LAST_TYPE

---

Member Function Documentation

Access WWhizTag::GetAccess ( void ) const [pure virtual]

Returns: Returns the access of the tag if the tag is a class member.

WWhizTag * WWhizTag::GetBuddy ( void ) const [pure virtual]

Retrieves the buddy of the tag. That is, if the tag is a declaration, it retrieves the definition, and vice versa. Returns: Returns the "buddy" of the tag.

LPCSTR WWhizTag::GetFilename ( void ) const [pure virtual]

Returns: Returns the filename the tag resides within.

LPCSTR WWhizTag::GetIdent ( void ) const [pure virtual]

Returns: Returns the true tag name, case-sensitive.

ImplementationType WWhizTag::GetImplementationType ( void ) const [pure virtual]

Returns: Returns the tag's implementation type.

int WWhizTag::GetLineNumber ( void ) const [pure virtual]

WWhizTag * WWhizTag::GetMatchNext ( void ) const [pure virtual]

Returns: Returns the next matching tag, based on search criteria specified through the WWhizInterface::MatchTag() function.

WWhizTag * WWhizTag::GetMatchPrev ( void ) const [pure virtual]

Returns: Returns the previous matching tag, based on search criteria specified through the WWhizInterface::MatchTag() function.

LPCSTR WWhizTag::GetNamespace ( void ) const [pure virtual]

Returns: Returns the namespace, if any, of the tag.

LPCSTR WWhizTag::GetParentIdent ( void ) const [pure virtual]

Returns: Returns the true parent tag name, case-sensitive.

LPCSTR WWhizTag::GetSearchString ( void ) const [pure virtual]

Returns: Returns the regular expression used to search for the tag.

LPCSTR WWhizTag::GetShortIdent ( void ) const [pure virtual]

To facilitate faster tag lookups, every tag has a "short" identifier associated with it. The short identifier is all lowercase and only contains alphanumeric characters. Underscores are not included. Do not use GetShortIdent() for the display of the tag name. Instead, use GetIdent(). Returns: Returns the alphanumeric "short" name for the tag.

LPCSTR WWhizTag::GetShortParentIdent ( void ) const [pure virtual]

To facilitate faster tag lookups, every parent tag has a "short" identifier associated with it. The short identifier is all lowercase and only contains alphanumeric characters. Underscores are not included. Do not use GetShortParentIdent() for the display of the parent tag name. Instead, use GetParentIdent(). Returns: Returns the alphanumeric "short" name for the parent tag.

Type WWhizTag::GetType ( void ) const [pure virtual]

Returns: Returns the type of the tag.

---

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

• WWhizInterface2.h

---