PSiteWrapper Class Reference

A website wrapper. More...

#include <PSiteWrapper.h>

Inheritance diagram for PSiteWrapper:

List of all members.

Public Member Functions
	PSiteWrapper (PEngine *engine)
void	addPageWrapper (PPageWrapper *pageWrapper)
QString	schemaDirectory (const QString &schemaName)
QString	schemaFileName (const QString &schemaName)
Protected Member Functions
QList< QString >	schemaCandidateNames ()
QString	cacheFileName ()
Friends
class	PSiteWrapperPrivate

---

Detailed Description

A website wrapper.

---

Constructor & Destructor Documentation

PSiteWrapper::PSiteWrapper

(

PEngine *

engine

)

Note:

The site wrapper is a top level wrapper, i.e. its parent is NULL.

---

Member Function Documentation

void PSiteWrapper::addPageWrapper

(

PPageWrapper *

pageWrapper

)

Append the pageWrapper to the list if not already exists.

QString PSiteWrapper::cacheFileName

(

)

[protected, virtual]

Returns:

the filename as engine->cacheDirectory()/name()/sitecache.xml

Implements PWrapper.

QList< QString > PSiteWrapper::schemaCandidateNames

(

)

[protected, virtual]

Loop through each subdirectory in the schemaCandidatesDirectory() looking for a valid site wrapper schema, appending it to the returned list when found.

Implements PWrapper.

QString PSiteWrapper::schemaDirectory

(

const QString &

schemaName

)

Given a schema name, return the directory of the schema as schemaCandidatesDirectory()/schemaName/. If the schema name is not valid, return an empty string. Note: the final / is removed

QString PSiteWrapper::schemaFileName

(

const QString &

schemaName

)

[virtual]

Returns:

the filename as schemaDirectory()/siteschema.xml

Implements PWrapper.

---

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

• PSiteWrapper.h
• PSiteWrapper.cpp