makVrv::DtPagePath Class Reference

A page path is the location of a page based upon its parents. A page path usually only consists of a Collection class name and a Page class name.

Inheritance diagram for makVrv::DtPagePath:

Classes
struct	PagePathBuilder

Public Member Functions
	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 DtPagePath	empty ()
static DtPagePath	root ()
static PagePathBuilder	collection (const std::string &name)

Protected Member Functions
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	DtPagePath (const std::string &path)

Protected Attributes
std::string	myPath

Constructor & Destructor Documentation

makVrv::DtPagePath::DtPagePath

(

)

Default CTOR. Needed for serialization.

makVrv::DtPagePath::DtPagePath

(

const PagePathBuilder &

builder

)

CTOR.

makVrv::DtPagePath::DtPagePath

(

const DtPagePath &

copy

)

Copy CTOR.

makVrv::DtPagePath::DtPagePath ( const std::string &  path )

protected

Protected CTOR. Use the static PagePage function to start a path.

Member Function Documentation

static DtPagePath makVrv::DtPagePath::empty ( )

static

Create an empty menu path.

static DtPagePath makVrv::DtPagePath::root ( )

static

Create an empty root menu path.

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

static

Start a main menu.

const std::string& makVrv::DtPagePath::path ( ) const

inline

Get the current path.

DtPagePath makVrv::DtPagePath::collectionPart

(

)

const

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

std::string makVrv::DtPagePath::name

(

)

const

Calculate the name of the this menu path. This is either the item name or the menu name.

bool makVrv::DtPagePath::isEmpty

(

)

const

Is the path empty?

bool makVrv::DtPagePath::isCollection

(

)

const

Is this item a main menu path?

bool makVrv::DtPagePath::isPage

(

)

const

Is the path a menu (not an item)?

bool makVrv::DtPagePath::isChildOf

(

const DtPagePath &

parent

)

const

Is this path its direct parent?

bool makVrv::DtPagePath::isSiblingOf

(

const DtPagePath &

sibling

)

const

Does this path have the same parent as the given path?

bool makVrv::DtPagePath::operator==

(

const DtPagePath &

other

)

const

Equal comparison operator.

bool makVrv::DtPagePath::operator<

(

const DtPagePath &

other

)

const

Less than comparison operator.

bool makVrv::DtPagePath::operator!=

(

const DtPagePath &

other

)

const

Not equal comparison operator.

template<class Archive >

void makVrv::DtPagePath::_serialize ( Archive &  ar, const unsigned int  version  )

inlineprotected

Serialize this class.

References DT_SERIALIZE_MEMBER.

Member Data Documentation

std::string makVrv::DtPagePath::myPath

protected

Internal path.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtPagePath.h