xlnt::relationship Class Reference

Represents an association between a source Package or part, and a target object which can be a part or external resource. More...

#include <relationship.hpp>

Public Member Functions
	relationship ()
	Constructs a new empty relationship. More...
	relationship (const std::string &id, relationship_type t, const uri &source, const uri &target, xlnt::target_mode mode)
	Constructs a new relationship by specifying all of its properties. More...
const std::string &	id () const
	Returns a string of the form rId# that identifies the relationship. More...
relationship_type	type () const
	Returns the type of this relationship. More...
xlnt::target_mode	target_mode () const
	Returns whether the target of the relationship is internal or external to the package. More...
const uri &	source () const
	Returns the URI of the package part this relationship points to. More...
const uri &	target () const
	Returns the URI of the package part this relationship points to. More...
bool	operator== (const relationship &rhs) const
	Returns true if and only if rhs is equal to this relationship. More...
bool	operator!= (const relationship &rhs) const
	Returns true if and only if rhs is not equal to this relationship. More...

Detailed Description

Represents an association between a source Package or part, and a target object which can be a part or external resource.

Constructor & Destructor Documentation

relationship() [1/2]

xlnt::relationship::relationship

(

)

Constructs a new empty relationship.

relationship() [2/2]

xlnt::relationship::relationship	(	const std::string &	id,
		relationship_type	t,
		const uri &	source,
		const uri &	target,
		xlnt::target_mode	mode
	)

Constructs a new relationship by specifying all of its properties.

Member Function Documentation

id()

const std::string& xlnt::relationship::id

(

)

const

Returns a string of the form rId# that identifies the relationship.

operator!=()

bool xlnt::relationship::operator!=

(

const relationship &

rhs

)

const

Returns true if and only if rhs is not equal to this relationship.

operator==()

bool xlnt::relationship::operator==

(

const relationship &

rhs

)

const

Returns true if and only if rhs is equal to this relationship.

source()

const uri& xlnt::relationship::source

(

)

const

Returns the URI of the package part this relationship points to.

target()

const uri& xlnt::relationship::target

(

)

const

Returns the URI of the package part this relationship points to.

target_mode()

xlnt::target_mode xlnt::relationship::target_mode

(

)

const

Returns whether the target of the relationship is internal or external to the package.

type()

relationship_type xlnt::relationship::type

(

)

const

Returns the type of this relationship.

---

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

• xlnt/packaging/relationship.hpp