C_HeadTag Class Reference

#include <C_HeadTag.h>

Inheritance diagram for C_HeadTag:

Inheritance graph
[legend]
Collaboration diagram for C_HeadTag:

Collaboration graph
[legend]
List of all members.

Public Types

enum  eTagType {
  UNKNOWN, IMPORT, STREAM, META,
  HEAD, TITLE, BASE, CLIP,
  ANCHOR, IMAGE, DESC, PARAM,
  BAD_TAG = 1000
}

Public Member Functions

 C_HeadTag (void)
virtual ~C_HeadTag (void)
wstring profile ()
 Returns uri for profile used in meta tags (eg Dublin Core).
C_TitleTagtitle ()
 Returns an internal pointer to the title element. Can modify but don't delete.
C_BaseTagbase ()
 Returns an internal pointer to the base element. Can modify but don't delete.
C_MetaTagListmetaList ()
 Returns an internal pointer to the meta tag list. Can modify but don't delete.
void setProfile (wstring inProfile)
 Sets the uri for the profile used in meta tags.
void setTitle (C_TitleTag *inTitle)
 Sets the title tag for this element. You give away your pointer.
void setBase (C_BaseTag *inBase)
 Sets the base tag for this element. You give away your pointer.
void setMetaList (C_MetaTagList *inMetaList)
 Sets the metalist used for this element. You give away your pointer.
virtual wstring toString ()
 Returns an xml representation of this tag.
C_HeadTagclone ()
 Performs a deep copy and returns a pointer you can keep.
virtual C_CMMLTaggenericClone ()
 Performs a deep copy and returns a pointer to the base class you can keep.
wstring lang ()
 Returns the language country code for this tag (eg. en or de).
wstring dirn ()
 Returns the direction this langauge is read (ltr or rtl).
void setLang (wstring inLang)
 Sets the language country code for this tag (eg. en or de).
void setDirn (wstring inDirn)
 Sets the direction this langauge is read (ltr or rtl).
wstring id ()
 Returns the id attribute for this tag.
void setId (wstring inId)
 Sets the id attribute for this tag.
eTagType tagType ()
 Returns the type of tag this really is.

Protected Member Functions

virtual void privateClone (C_CMMLTag *outTag)
virtual wstring makeLangElements ()
wstring makeAttribute (wstring inElemName, wstring inElemContent)
 Makes an attribute of the form name="content" and returns a string.
wstring makeRequiredAttribute (wstring inElemName, wstring inElemContent)
wstring escapeEntities (wstring inString)
 Escapes out & " < > ' and turns it into an entity reference.
wstring replaceAll (wstring inOriginal, wchar_t inReplaceThis, wstring inWithThis)
 Implements the missing functionality from an stl string... ie replace.

Protected Attributes

wstring mProfile
C_TitleTagmTitle
C_BaseTagmBase
C_MetaTagListmMetaList
wstring mLang
wstring mDirn
wstring mId
eTagType mTagType

Member Enumeration Documentation

enum C_CMMLTag::eTagType [inherited]
 

Enumeration values:
UNKNOWN 
IMPORT 
STREAM 
META 
HEAD 
TITLE 
BASE 
CLIP 
ANCHOR 
IMAGE 
DESC 
PARAM 
BAD_TAG 

Definition at line 60 of file C_CMMLTag.h.

Referenced by C_CMMLTag::tagType().


Constructor & Destructor Documentation

C_HeadTag::C_HeadTag void   ) 
 

Definition at line 37 of file C_HeadTag.cpp.

References mBase, mMetaList, and mTitle.

C_HeadTag::~C_HeadTag void   )  [virtual]
 

Definition at line 45 of file C_HeadTag.cpp.


Member Function Documentation

C_BaseTag * C_HeadTag::base  ) 
 

Returns an internal pointer to the base element. Can modify but don't delete.

Definition at line 60 of file C_HeadTag.cpp.

Referenced by illiminable::libCMMLTagsDotNET::HeadTag::base().

C_HeadTag * C_HeadTag::clone  ) 
 

Performs a deep copy and returns a pointer you can keep.

Definition at line 99 of file C_HeadTag.cpp.

References privateClone().

Referenced by genericClone(), CMMLCallbackProxy::headCallback(), C_CMMLRootTag::privateClone(), illiminable::libCMMLTagsDotNET::CMMLRootTag::setHead(), and CMMLDecodeFilter::Transform().

Here is the call graph for this function:

wstring C_HumReadCMMLTag::dirn  )  [inherited]
 

Returns the direction this langauge is read (ltr or rtl).

Definition at line 49 of file C_HumReadCMMLTag.cpp.

wstring C_CMMLTag::escapeEntities wstring  inString  )  [protected, inherited]
 

Escapes out & " < > ' and turns it into an entity reference.

Definition at line 92 of file C_CMMLTag.cpp.

References C_CMMLTag::replaceAll().

Referenced by C_CMMLTag::makeAttribute(), C_CMMLTag::makeRequiredAttribute(), C_TitleTag::toString(), toString(), C_DescTag::toString(), and C_AnchorTag::toString().

Here is the call graph for this function:

C_CMMLTag * C_HeadTag::genericClone  )  [virtual]
 

Performs a deep copy and returns a pointer to the base class you can keep.

Implements C_CMMLTag.

Definition at line 96 of file C_HeadTag.cpp.

References clone().

Here is the call graph for this function:

wstring C_CMMLTag::id  )  [inherited]
 

Returns the id attribute for this tag.

Definition at line 46 of file C_CMMLTag.cpp.

Referenced by illiminable::libCMMLTagsDotNET::CMMLTag::id().

wstring C_HumReadCMMLTag::lang  )  [inherited]
 

Returns the language country code for this tag (eg. en or de).

Definition at line 46 of file C_HumReadCMMLTag.cpp.

wstring C_CMMLTag::makeAttribute wstring  inElemName,
wstring  inElemContent
[protected, inherited]
 

Makes an attribute of the form name="content" and returns a string.

Definition at line 56 of file C_CMMLTag.cpp.

References C_CMMLTag::escapeEntities().

Referenced by C_HumReadCMMLTag::makeLangElements(), C_TitleTag::toString(), C_StreamTag::toString(), C_ParamTag::toString(), C_MetaTag::toString(), C_ImportTag::toString(), C_ImageTag::toString(), C_DescTag::toString(), C_CMMLRootTag::toString(), C_ClipTag::toString(), C_BaseTag::toString(), and C_AnchorTag::toString().

Here is the call graph for this function:

wstring C_HumReadCMMLTag::makeLangElements  )  [protected, virtual, inherited]
 

Definition at line 69 of file C_HumReadCMMLTag.cpp.

References C_CMMLTag::makeAttribute(), C_HumReadCMMLTag::mDirn, and C_HumReadCMMLTag::mLang.

Referenced by C_TitleTag::toString(), C_ParamTag::toString(), C_MetaTag::toString(), C_ImportTag::toString(), C_ImageTag::toString(), toString(), C_DescTag::toString(), C_CMMLRootTag::toString(), C_ClipTag::toString(), and C_AnchorTag::toString().

Here is the call graph for this function:

wstring C_CMMLTag::makeRequiredAttribute wstring  inElemName,
wstring  inElemContent
[protected, inherited]
 

Definition at line 66 of file C_CMMLTag.cpp.

References C_CMMLTag::escapeEntities().

Referenced by C_AnchorTag::toString().

Here is the call graph for this function:

C_MetaTagList * C_HeadTag::metaList  ) 
 

Returns an internal pointer to the meta tag list. Can modify but don't delete.

Definition at line 63 of file C_HeadTag.cpp.

Referenced by CMMLParser::parseHeadTag().

void C_HeadTag::privateClone C_CMMLTag outTag  )  [protected, virtual]
 

Reimplemented from C_HumReadCMMLTag.

Definition at line 85 of file C_HeadTag.cpp.

References C_TitleTag::clone(), C_MetaTagList::clone(), C_BaseTag::clone(), mBase, mMetaList, mProfile, mTitle, C_HumReadCMMLTag::privateClone(), setBase(), setMetaList(), setProfile(), and setTitle().

Referenced by clone().

Here is the call graph for this function:

wstring C_HeadTag::profile  ) 
 

Returns uri for profile used in meta tags (eg Dublin Core).

Definition at line 54 of file C_HeadTag.cpp.

wstring C_CMMLTag::replaceAll wstring  inOriginal,
wchar_t  inReplaceThis,
wstring  inWithThis
[protected, inherited]
 

Implements the missing functionality from an stl string... ie replace.

Definition at line 73 of file C_CMMLTag.cpp.

Referenced by C_CMMLTag::escapeEntities().

void C_HeadTag::setBase C_BaseTag inBase  ) 
 

Sets the base tag for this element. You give away your pointer.

Definition at line 79 of file C_HeadTag.cpp.

References mBase.

Referenced by CMMLParser::parseHeadTag(), privateClone(), and illiminable::libCMMLTagsDotNET::HeadTag::setBase().

void C_HumReadCMMLTag::setDirn wstring  inDirn  )  [inherited]
 

Sets the direction this langauge is read (ltr or rtl).

Definition at line 57 of file C_HumReadCMMLTag.cpp.

References C_HumReadCMMLTag::mDirn.

Referenced by CMMLParser::parseAnchorTag(), CMMLParser::parseClipTag(), CMMLParser::parseCMMLRootTag(), CMMLParser::parseDescTag(), CMMLParser::parseHeadTag(), CMMLParser::parseMetaTag(), CMMLParser::parseTitleTag(), C_HumReadCMMLTag::privateClone(), and illiminable::libCMMLTagsDotNET::HumReadCMMLTag::setDirn().

void C_CMMLTag::setId wstring  inId  )  [inherited]
 

Sets the id attribute for this tag.

Definition at line 51 of file C_CMMLTag.cpp.

References C_CMMLTag::mId.

Referenced by CMMLParser::parseAnchorTag(), CMMLParser::parseBaseTag(), CMMLParser::parseClipTag(), CMMLParser::parseCMMLRootTag(), CMMLParser::parseDescTag(), CMMLParser::parseHeadTag(), CMMLParser::parseImageTag(), CMMLParser::parseImportTag(), CMMLParser::parseMetaTag(), CMMLParser::parseParamTag(), CMMLParser::parseStreamTag(), CMMLParser::parseTitleTag(), C_CMMLTag::privateClone(), and illiminable::libCMMLTagsDotNET::CMMLTag::setId().

void C_HumReadCMMLTag::setLang wstring  inLang  )  [inherited]
 

Sets the language country code for this tag (eg. en or de).

Definition at line 54 of file C_HumReadCMMLTag.cpp.

References C_HumReadCMMLTag::mLang.

Referenced by CMMLParser::parseAnchorTag(), CMMLParser::parseClipTag(), CMMLParser::parseCMMLRootTag(), CMMLParser::parseDescTag(), CMMLParser::parseHeadTag(), CMMLParser::parseMetaTag(), CMMLParser::parseTitleTag(), C_HumReadCMMLTag::privateClone(), and illiminable::libCMMLTagsDotNET::HumReadCMMLTag::setLang().

void C_HeadTag::setMetaList C_MetaTagList inMetaList  ) 
 

Sets the metalist used for this element. You give away your pointer.

Definition at line 75 of file C_HeadTag.cpp.

References mMetaList.

Referenced by privateClone().

void C_HeadTag::setProfile wstring  inProfile  ) 
 

Sets the uri for the profile used in meta tags.

Definition at line 67 of file C_HeadTag.cpp.

References mProfile.

Referenced by CMMLParser::parseHeadTag(), privateClone(), and illiminable::libCMMLTagsDotNET::HeadTag::setProfile().

void C_HeadTag::setTitle C_TitleTag inTitle  ) 
 

Sets the title tag for this element. You give away your pointer.

Definition at line 70 of file C_HeadTag.cpp.

References mTitle.

Referenced by CMMLParser::parseHeadTag(), privateClone(), and illiminable::libCMMLTagsDotNET::HeadTag::setTitle().

C_CMMLTag::eTagType C_CMMLTag::tagType  )  [inherited]
 

Returns the type of tag this really is.

Definition at line 111 of file C_CMMLTag.cpp.

References C_CMMLTag::eTagType.

Referenced by CMMLRawSourcePin::deliverTag().

C_TitleTag * C_HeadTag::title  ) 
 

Returns an internal pointer to the title element. Can modify but don't delete.

Definition at line 57 of file C_HeadTag.cpp.

wstring C_HeadTag::toString  )  [virtual]
 

Returns an xml representation of this tag.

Implements C_HumReadCMMLTag.

Definition at line 107 of file C_HeadTag.cpp.

References C_CMMLTag::escapeEntities(), C_HumReadCMMLTag::makeLangElements(), mBase, mMetaList, mProfile, mTitle, C_MetaTagList::toString(), C_TitleTag::toString(), and C_BaseTag::toString().

Referenced by C_CMMLRootTag::toString().

Here is the call graph for this function:


Member Data Documentation

C_BaseTag* C_HeadTag::mBase [protected]
 

Definition at line 91 of file C_HeadTag.h.

Referenced by C_HeadTag(), privateClone(), setBase(), and toString().

wstring C_HumReadCMMLTag::mDirn [protected, inherited]
 

Definition at line 69 of file C_HumReadCMMLTag.h.

Referenced by C_HumReadCMMLTag::makeLangElements(), C_HumReadCMMLTag::privateClone(), and C_HumReadCMMLTag::setDirn().

wstring C_CMMLTag::mId [protected, inherited]
 

Definition at line 89 of file C_CMMLTag.h.

Referenced by C_CMMLTag::privateClone(), and C_CMMLTag::setId().

wstring C_HumReadCMMLTag::mLang [protected, inherited]
 

Definition at line 68 of file C_HumReadCMMLTag.h.

Referenced by C_HumReadCMMLTag::makeLangElements(), C_HumReadCMMLTag::privateClone(), and C_HumReadCMMLTag::setLang().

C_MetaTagList* C_HeadTag::mMetaList [protected]
 

Definition at line 92 of file C_HeadTag.h.

Referenced by C_HeadTag(), privateClone(), setMetaList(), and toString().

wstring C_HeadTag::mProfile [protected]
 

Definition at line 89 of file C_HeadTag.h.

Referenced by privateClone(), setProfile(), and toString().

eTagType C_CMMLTag::mTagType [protected, inherited]
 

Definition at line 90 of file C_CMMLTag.h.

C_TitleTag* C_HeadTag::mTitle [protected]
 

Definition at line 90 of file C_HeadTag.h.

Referenced by C_HeadTag(), privateClone(), setTitle(), and toString().


The documentation for this class was generated from the following files:
Generated on Tue Feb 15 15:01:59 2005 for oggdsf by  doxygen 1.3.9