A page path is the location of a page based upon it's parents. A page path usually only consists of a Collection class name and a Page class name. Information collections can also contain items that are placed on the page. This could be in addition to other data items that might be placed on the page by default.

Inheritance diagram for makVrf::DtInformationPagePath:

[legend]

Classes
struct	InformationPagePathBuilder

Public Member Functions
	DtInformationPagePath (const std::string &path)

	DtInformationPagePath ()

	DtInformationPagePath (const InformationPagePathBuilder &builder)

	DtInformationPagePath (const DtInformationPagePath &copy)

	DtInformationPagePath (const DtPagePath &copy)

bool	isInformationItem () const

bool	isPage () const

bool	isSection () const

void	variables (std::set< std::string > &) const

std::string	sectionName () const

std::string	name () const

virtual bool	isChildOf (const DtInformationPagePath &parent) const

DtInformationPagePath	parentPath () const

DtInformationPagePath	collectionPart () const

Public Member Functions inherited from makVrv::DtPagePath
	DtPagePath ()

	DtPagePath (const PagePathBuilder &builder)

	DtPagePath (const DtPagePath &copy)

const std::string &	path () const

DtPagePath	collectionPart () const

std::string	name () const

bool	isEmpty () const

bool	isCollection () const

bool	isPage () const

bool	isChildOf (const DtPagePath &parent) const

bool	isSiblingOf (const DtPagePath &sibling) const

bool	operator== (const DtPagePath &other) const

bool	operator< (const DtPagePath &other) const

bool	operator!= (const DtPagePath &other) const

Static Public Member Functions
static InformationPagePathBuilder	collection (const std::string &name)

static InformationPagePathBuilder	page (const std::string &name)

static InformationPagePathBuilder	section (const std::string &name)

Static Public Member Functions inherited from makVrv::DtPagePath
static DtPagePath	empty ()

static DtPagePath	root ()

static PagePathBuilder	collection (const std::string &name)

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtPagePath
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)

	DtPagePath (const std::string &path)

Protected Attributes inherited from makVrv::DtPagePath
std::string	myPath

Constructor & Destructor Documentation

makVrf::DtInformationPagePath::DtInformationPagePath ( const std::string & path )

CTOR to use for custom format.

makVrf::DtInformationPagePath::DtInformationPagePath ( )

DtInformationPagePath Needed for serialization.

makVrf::DtInformationPagePath::DtInformationPagePath ( const InformationPagePathBuilder & builder )

CTOR.

makVrf::DtInformationPagePath::DtInformationPagePath ( const DtInformationPagePath & copy )

Copy CTOR.

makVrf::DtInformationPagePath::DtInformationPagePath ( const DtPagePath & copy )

Copy CTOR.

Member Function Documentation

static InformationPagePathBuilder makVrf::DtInformationPagePath::collection ( const std::string & name )

static

static InformationPagePathBuilder makVrf::DtInformationPagePath::page ( const std::string & name )

static

static InformationPagePathBuilder makVrf::DtInformationPagePath::section ( const std::string & name )

static

bool makVrf::DtInformationPagePath::isInformationItem ( ) const

bool makVrf::DtInformationPagePath::isPage ( ) const

bool makVrf::DtInformationPagePath::isSection ( ) const

void makVrf::DtInformationPagePath::variables ( std::set< std::string > & ) const

std::string makVrf::DtInformationPagePath::sectionName ( ) const

std::string makVrf::DtInformationPagePath::name ( ) const

virtual bool makVrf::DtInformationPagePath::isChildOf ( const DtInformationPagePath & parent ) const

virtual

DtInformationPagePath makVrf::DtInformationPagePath::parentPath ( ) const

Get the path to the parent of this path. If this path is the top level an empty path is returned.

DtInformationPagePath makVrf::DtInformationPagePath::collectionPart ( ) const

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfGuiCore/informationPagePath.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation