makVrf::DtInformationPagePath Class Reference

A page path is the location of a page based upon it's parents. More...

Inheritance diagram for makVrf::DtInformationPagePath:

Classes
struct	InformationPagePathBuilder

Public Member Functions
	DtInformationPagePath (const std::string &path)
	CTOR to use for custom format.
	DtInformationPagePath ()
	DtInformationPagePath Needed for serialization.
	DtInformationPagePath (const InformationPagePathBuilder &builder)
	CTOR.
	DtInformationPagePath (const DtInformationPagePath &copy)
	Copy CTOR.
	DtInformationPagePath (const DtPagePath &copy)
	Copy CTOR.
bool	isInformationItem () const
bool	isPage () const
	Is the path a menu (not an item)?
bool	isSection () const
void	variables (std::set< std::string > &) const
std::string	name () const
	Calculate the name of the this menu path.
virtual bool	isChildOf (const DtInformationPagePath &parent) const
DtInformationPagePath	parentPath () const
	Get the path to the parent of this path.
DtInformationPagePath	collectionPart () const
	Get the path to the parent of this path.
Public Member Functions inherited from makVrv::DtPagePath
	DtPagePath ()
	Default CTOR.
	DtPagePath (const PagePathBuilder &builder)
	CTOR.
	DtPagePath (const DtPagePath &copy)
	Copy CTOR.
const std::string &	path () const
	Get the current path.
bool	isEmpty () const
	Is the path empty?
bool	isCollection () const
	Is this item a main menu path?
bool	isChildOf (const DtPagePath &parent) const
	Is this path its direct parent?
bool	isSiblingOf (const DtPagePath &sibling) const
	Does this path have the same parent as the given path?
bool	operator== (const DtPagePath &other) const
	Equal comparison operator.
bool	operator< (const DtPagePath &other) const
	Less than comparison operator.
bool	operator!= (const DtPagePath &other) const
	Not equal comparison operator.

Static Public Member Functions
static InformationPagePathBuilder	collection (const std::string &name)
	Start a main menu.
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 ()
	Create an empty menu path.
static DtPagePath	root ()
	Create an empty root menu path.

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtPagePath
template<class Archive >
void	_serialize (Archive &ar, const unsigned int version)
	Serialize this class.
	DtPagePath (const std::string &path)
	Protected CTOR.
Protected Attributes inherited from makVrv::DtPagePath
std::string	myPath
	Internal path.

Detailed Description

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

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

Start a main menu.

Reimplemented from makVrv::DtPagePath.

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

Is the path a menu (not an item)?

Reimplemented from makVrv::DtPagePath.

bool makVrf::DtInformationPagePath::isSection

(

)

const

void makVrf::DtInformationPagePath::variables

(

std::set< std::string > &

)

const

std::string makVrf::DtInformationPagePath::name

(

)

const

Calculate the name of the this menu path.

This is either the item name or the menu name.

Reimplemented from makVrv::DtPagePath.

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

Get the path to the parent of this path.

If this path is the top level an empty path is returned.

Reimplemented from makVrv::DtPagePath.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfGuiCore/informationPagePath.h