Anchor Class Reference

Page number and vertical position in physical coordinates. More...

#include <anchor.h>

List of all members.

Public Member Functions
	Anchor (const PageNumber &pg, const Length &_distance_from_top)
	Anchor ()
bool	isValid () const
Public Attributes
Length	distance_from_top
PageNumber	page

---

Detailed Description

Page number and vertical position in physical coordinates.

This very simple class contains a page number and a vertical position in physical coordiantes. The vertical position is given by the distance from the top of the page. Anchors are completely independent of documents, there is no need for a document to exists that contains the given page, nor does the page number need to be valid.

Author:

Stefan Kebekus <kebekus@kde.org>

Version:

1.0 0

Definition at line 30 of file anchor.h.

---

Constructor & Destructor Documentation

Anchor::Anchor

(

)

[inline]

Constructs an anchor that points to an invalid page.

Definition at line 33 of file anchor.h.

Anchor::Anchor	(	const PageNumber &	pg,
		const Length &	_distance_from_top
	)			[inline]

Constructs an snchor that points to a given position on a given page.

The class contains no code to make sure in any way that the page number pg exists, and that page pg, if it exists, is taller than distance_from_top

Parameters:

	pg	number of the page
	_distance_from_top	distance from the top of the page

Definition at line 45 of file anchor.h.

---

Member Function Documentation

bool Anchor::isValid

(

)

const [inline]

quick validity check for anchors

Returns:

true if the page number is valid, and 0mm <= distance_from_top <= 2m

Definition at line 51 of file anchor.h.

---

Member Data Documentation

Length Anchor::distance_from_top

Distance from the top of the page in inch.

Definition at line 57 of file anchor.h.

PageNumber Anchor::page

Page number that this anchor point to.

Definition at line 54 of file anchor.h.

---

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

• anchor.h