Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Celartem::DjVu::MapText Class Reference

#include <djv_mapareas.h>

Inheritance diagram for Celartem::DjVu::MapText:
Inheritance graph

Public Member Functions

virtual MapAreaType getType () const
virtual Rect getRect () const
virtual bool isPointInsideArea (const Point &inPoint) const
virtual size_t isPointOnLine (const Point &inPoint, size_t inRadius=1) const
virtual String getANTString (const PageInfo &inPageInfo, Rotation inCurrentRotation) const
virtual AutoPtr< MapAreaduplicate () const
- Public Member Functions inherited from Celartem::Referable
 Referable ()
void addRef () const
void releaseRef () const
size_t getReferenceCount () const

Static Public Member Functions

static AutoPtr< MapTextcreate ()
- Static Public Member Functions inherited from Celartem::Referable
static void dumpDbgAllRefCount ()

Public Attributes

Rect rect
bool pushpin
Color textColor
Color bgColor
- Public Attributes inherited from Celartem::DjVu::MapArea
Link link
 Link to another resource. More...
String target
 The link target. More...
String text
 The text of the link. More...
BorderType borderType
 The border type. More...
Color lineColor
 The color of the border/line. More...
size_t lineWidth
 The width of the line. More...
bool borderAlwaysVisible
 Determines whether the border is always shown or not. More...

Additional Inherited Members

- Protected Member Functions inherited from Celartem::DjVu::MapArea
 MapArea ()

Detailed Description

Represents a text (matText) maparea instance.

Member Function Documentation

static AutoPtr<MapText> Celartem::DjVu::MapText::create ( )

Initialize new MapText instance.

virtual AutoPtr<MapArea> Celartem::DjVu::MapText::duplicate ( ) const

Clone this instance.

Pointer to the newly created instance.

Implements Celartem::DjVu::MapArea.

virtual String Celartem::DjVu::MapText::getANTString ( const PageInfo inPageInfo,
Rotation  inCurrentRotation 
) const

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

inPageInfoThe dimensions and rotation status of the page is used during encoding the ANT* string.
inCurrentRotationThe current rotation.
ANT* encoded representation of this maparea.

Implements Celartem::DjVu::MapArea.

virtual Rect Celartem::DjVu::MapText::getRect ( ) const

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.

A Rect instance.

Implements Celartem::DjVu::MapArea.

virtual MapAreaType Celartem::DjVu::MapText::getType ( ) const

Gets the type of the shape.

One of MapAreaType enumeration values.

Implements Celartem::DjVu::MapArea.

virtual bool Celartem::DjVu::MapText::isPointInsideArea ( const Point inPoint) const

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

inPointA point to verify.
true if the point is inside the maparea.

Implements Celartem::DjVu::MapArea.

virtual size_t Celartem::DjVu::MapText::isPointOnLine ( const Point inPoint,
size_t  inRadius = 1 
) const

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

inPointA point to verify.
inRadiusThe points within the area defined by inRadius is determined as on-line.
0 if the point is not on-line. 1 indicates the point is on left-top to left-bottom line. 2 indicates the point is on left-top to right-top line. 3 indicates the point is on right-top to right-bottom line. 4 indicates the point is on left-bottom to right-bottom line.

Implements Celartem::DjVu::MapArea.

Member Data Documentation

Color Celartem::DjVu::MapText::bgColor

The background color (a.k.a. hilight) of this MapText instance.
If this color is invalid (see Color::isValid, Color::InvalidColor), the background is not filled.
The default is invalid color and the background is not filled.

bool Celartem::DjVu::MapText::pushpin

Whether it is a pushpin (hidable) or not.

Rect Celartem::DjVu::MapText::rect

The area of this MapText instance.

Referenced by getRect(), and isPointInsideArea().

Color Celartem::DjVu::MapText::textColor

The color of the text.

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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:07.
Cuminas Logo