Celartem::DjVu::MapArea Class Reference

#include <djv_mapareas.h>

Inheritance diagram for Celartem::DjVu::MapArea:

List of all members.

Public Member Functions
virtual MapAreaType	getType () const =0
virtual Rect	getRect () const =0
virtual bool	isPointInsideArea (const Point &inPoint) const =0
virtual size_t	isPointOnLine (const Point &inPoint, size_t inRadius=1) const =0
virtual String	getANTString (const PageInfo &inPageInfo, Rotation inCurrentRotation) const =0
virtual AutoPtr< MapArea >	duplicate () const =0
Public Attributes
Link	link
	Link to another resource.
String	target
	The link target.
String	text
	The text of the link.
BorderType	borderType
	The border type.
Color	lineColor
	The color of the border/line.
size_t	lineWidth
	The width of the line.
bool	borderAlwaysVisible
	Determines whether the border is always shown or not.
Protected Member Functions
	MapArea ()

---

Detailed Description

Abstract class for MapArea types.

---

Constructor & Destructor Documentation

Celartem::DjVu::MapArea::MapArea

(

)

[inline, protected]

For internal use only.

For initialization of MapArea variations.

---

Member Function Documentation

virtual AutoPtr<MapArea> Celartem::DjVu::MapArea::duplicate

(

)

const [pure virtual]

Clone this instance.

Returns:

Pointer to the newly created instance.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

virtual String Celartem::DjVu::MapArea::getANTString	(	const PageInfo &	inPageInfo,
		Rotation	inCurrentRotation
	)			const [pure virtual]

Get the string for ANT* encoding.
This is for advanced purpose and should not be used for normal use.

Parameters:

	inPageInfo	The dimensions and rotation status of the page is used during encoding the ANT* string.
	inCurrentRotation	The current rotation.

Returns:

ANT* encoded representation of this maparea.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

virtual Rect Celartem::DjVu::MapArea::getRect

(

)

const [pure virtual]

Gets the minimum rectangle which can contain all the points of the maparea.
For rect and text areas, it is identical to the area of the maparea.

Returns:

A Rect instance.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

virtual MapAreaType Celartem::DjVu::MapArea::getType

(

)

const [pure virtual]

Gets the type of the shape.

Returns:

One of MapAreaType enumeration values.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

virtual bool Celartem::DjVu::MapArea::isPointInsideArea

(

const Point &

inPoint

)

const [pure virtual]

Determines whether the specified point is inside the maparea or not.

Parameters:

inPoint

A point to verify.

Returns:

true if the point is inside the maparea.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

virtual size_t Celartem::DjVu::MapArea::isPointOnLine	(	const Point &	inPoint,
		size_t	inRadius = 1
	)			const [pure virtual]

Determines whether the specified point is on the border (line) or not.

Parameters:

	inPoint	A point to verify.
	inRadius	The points within the area defined by inRadius is determined as on-line.

Returns:

Non-0 value if the point is on-line; otherwise 0.

Implemented in Celartem::DjVu::MapRect, Celartem::DjVu::MapOval, Celartem::DjVu::MapPoly, Celartem::DjVu::MapLine, and Celartem::DjVu::MapText.

---

Member Data Documentation

bool Celartem::DjVu::MapArea::borderAlwaysVisible

Determines whether the border is always shown or not.

If the value is true, the border will be always visible; otherwise, false, the border will be shown only when the mouse cursor is over the maparea.
It cannot be used with poly and line maparea.
Applicable for rect, oval, poly, text

BorderType Celartem::DjVu::MapArea::borderType

The border type.

For rect (MapRect) maparea type, it can be any of BorderType. For other types, it should be one of btNone, btXor and btSolid.
For line (MapLine), this is not applicable.
Applicable for rect, oval, poly, text

Color Celartem::DjVu::MapArea::lineColor

The color of the border/line.

With line (MapLine), it actually a color of line.
Applicable for rect, oval, poly, line, text

size_t Celartem::DjVu::MapArea::lineWidth

The width of the line.

For rect (MapRect), the thickness of the border for btShadowIn, btShadowOut, btShadowEIn and btShadowEOut.
For line (MapLine), the thickness of the line.
With other type of border, this will be ignored.
Applicable for rect, line

Link Celartem::DjVu::MapArea::link

Link to another resource.

String Celartem::DjVu::MapArea::target

The link target.

The target specifies where the link URL is loaded. It is same to target on HTML's href. The following is the wel-known targets:

• _blank Load the link in a new blank window.
• _self Load the link into the plugin window.
• _top Load the link into the top-level frame.

Applicable for rect, oval, poly, line, text

String Celartem::DjVu::MapArea::text

The text of the link.

It will be shown in tool tip window (a.k.a. hint). With the text maparea type, it will also shown in text area.
Applicable for rect, oval, poly, line, text

---

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

• djv_mapareas.h