AOI_Object_PathText Class Reference

Text along a path. More...

Inheritance diagram for AOI_Object_PathText:

Public Member Functions
void	SetText (const aur::ACPL::UString &uniText)
aur::ACPL::UString	GetText (int selStart, int selEnd) const
void	SetProperties (int selStart, int selEnd, const AOI_TextProperties &properties)
void	GetProperties (int selStart, int selEnd, AOI_TextProperties &properties) const
AOI_Mapping	GetMapping () const
void	GetContour (AOI_ContourPtr) const
AOI_StylePtr	GetFillStyle () const
AOI_StylePtr	GetStrokeStyle () const
void	SetFillStyle (AOI_StylePtr)
void	SetStrokeStyle (AOI_StylePtr)
bool	GetEOFill () const
void	SetEOFill (bool)
float	GetStrokeWidth () const
void	SetStrokeWidth (float)
float	GetJoin () const
void	SetJoin (float)
uint8_t	GetCaps () const
void	SetCaps (uint8_t)
void	GetDash (int32_t *, float **, float *) const
void	SetDash (int32_t, float *, float)
uint32_t	GetType () const
void	GetBounds (AOI_Rectangle &) const
AOI_Object *	GetNext () const
void	GetMaskedBounds (AOI_Rectangle &) const
void	GetPrecisionBounds (AOI_Rectangle &) const
AOI_BlendMode	GetBlendMode () const
float	GetBlendValue () const
AOI_Intent	GetIntent () const
bool	Visible () const
void	SetBlendMode (AOI_BlendMode)
void	SetBlendValue (float)
void	SetIntent (AOI_Intent)
void	Map (const AOI_Mapping &mapping)
void	Scale (const AOI_Mapping &)

Static Public Member Functions
static AOI_Object_Text *	Create (AOI_Document *document)
static void	operator delete (void *)

Detailed Description

Text along a path.

The path text object contains 1 line of text and a path that is representing its baseline. The text will follow the path and allow writting around circles or any other form.

Definition at line 53 of file AOI_Text.h.

Member Function Documentation

Create()

AOI_Object_Text * AOI_Object_Text::Create ( AOI_Document * document )

staticinherited

Creates a new empty AOI_Object_Text object.

Parameters

document

The AOI_Document the text will be used in.

Returns

The AOI_Object_Text created.

Definition at line 98 of file AOI_Text.cpp.

GetBlendMode()

AOI_BlendMode AOI_Object::GetBlendMode ( ) const

inherited

Returns the BlendMode of the object.

Possible BlendModes are:

• eBMNormal
• eBMMultiply
• eBMScreen
• eBMOverlay
• eBMSoftLight
• eBMHardLight
• eBMColorDodge
• eBMColorBurn
• eBMDarken
• eBMLighten
• eBMDifference
• eBMExclusion
• eBMHue
• eBMSaturation
• eBMColor
• eBMLuminosity

Returns

The BlendMode.

Definition at line 132 of file AOI_Object.cpp.

GetBlendValue()

float AOI_Object::GetBlendValue ( ) const

inherited

Returns the value with which blending should be done. For normal blending this is the opacity value. 0 is transparent and 1 is opaque.

Returns

The BlendValue.

See also

GetBlendMode

Definition at line 145 of file AOI_Object.cpp.

GetBounds()

void AOI_Object::GetBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object.

This function is quick and will suffice in most situations. It handles bezier curves by adding the complete hull to the bounds. For precise bounds use GetPrecisionBounds

Parameters

r	Receives the bounds

See also

GetPrecisionBounds GetMaskedBounds

Definition at line 40 of file AOI_Object.cpp.

GetCaps()

uint8_t AOI_Object_Vector::GetCaps ( ) const

inherited

Return the caps type of the nodes of the path.

Possible values:

• kButtCap
• kRoundCap
• kSquareCap

Returns

The type of caps used.

See also

SetCaps

Definition at line 153 of file AOI_Vector.cpp.

GetContour()

void AOI_Object_Vector::GetContour ( AOI_ContourPtr outContour ) const

inherited

Returns the AOI_Contour.

All AOI_Objects derived from AOI_Object_Vector have a contour. So if the contour information ao an AOI_Object_Text is needed, caal this function.

Parameters

outContour

Receives the contour. Should be a pointer to an existing empty AOI_Contour.

See also

AOI_Contour

Definition at line 23 of file AOI_Vector.cpp.

GetDash()

void AOI_Object_Vector::GetDash ( int32_t * nrOffDashes, float ** dashes, float * fase ) const

inherited

Returns the dash definition of this Vector.

The dashes parameter is filled with a pointer to an existing dashes array. Do not supply an array nor delete this after use.

Parameters

nrOffDashes	Recieves the number of alternating values.
dashes	Recieves the alternating values.
fase	Recieves the offset in the alternating values to start with at the beginning of the vector.

See also

SetDash

Definition at line 180 of file AOI_Vector.cpp.

GetEOFill()

bool AOI_Object_Vector::GetEOFill ( ) const

inherited

Returns if the fill should be done with EOFill or winding fill filling rule

Returns

True if the filling rule is EOFill ( Even/Odd )

See also

SetEOFill

Definition at line 81 of file AOI_Vector.cpp.

GetFillStyle()

AOI_StylePtr AOI_Object_Vector::GetFillStyle ( ) const

inherited

Returns the fill style of an object.

Returns

The fill style.

See also

AOI_Style

Definition at line 36 of file AOI_Vector.cpp.

GetIntent()

AOI_Intent AOI_Object::GetIntent ( ) const

inherited

Returns the intent with which this object should be rendered.

Possible values:

• ePerceptual
• eRelativeColorimetric
• eSaturation
• eAbsoluteColorimetric

Returns

The intent.

Definition at line 161 of file AOI_Object.cpp.

GetJoin()

float AOI_Object_Vector::GetJoin ( ) const

inherited

Returns the value used at joins beyond which to switch to bevel.

Returns

Join value.

See also

SetJoin

Definition at line 126 of file AOI_Vector.cpp.

GetMapping()

AOI_Mapping AOI_Object_Text::GetMapping ( ) const

inherited

Returns the mapping of the text.

Returns

the mapping

Definition at line 186 of file AOI_Text.cpp.

GetMaskedBounds()

void AOI_Object::GetMaskedBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object, taking into account the clipping.

Parameters

r	Receives the bounds

See also

GetBounds GetPrecisionBounds

Definition at line 63 of file AOI_Object.cpp.

GetNext()

AOI_ObjectPtr AOI_Object::GetNext ( ) const

inherited

Returns the next object.

The objects are stored in a tree with parents and children. The next object is the next kid of a parent. If there are no more kids, NULL will be returned.

Returns

The next object.

Definition at line 104 of file AOI_Object.cpp.

GetPrecisionBounds()

void AOI_Object::GetPrecisionBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object. Beziers are handled completely, unlike in GetBounds.

Parameters

r	Receives the bounds

See also

GetBounds GetMaskedBounds

Definition at line 52 of file AOI_Object.cpp.

GetProperties()

void AOI_Object_Text::GetProperties ( int selStart, int selEnd, AOI_TextProperties & properties ) const

inherited

Gets the properties of a specific part of the text.

On return properties will contain the properties of the first character in the specified range. If not all characters in the range share a specific property, the properties.valid boolean will be set to false. Otherwise the boolean will be true.

If all characters in the range have size 10, properties.valid.size will be true ( and properties.style.size will be 10 ). but properties.valid.size will be false.

Parameters

selStart	The point in the text to start from.
selEnd	The point in the text to end with.
properties	The TextProperties gotten from the specified text part.

See also

AOI_TextProperties

Definition at line 171 of file AOI_Text.cpp.

GetStrokeStyle()

AOI_StylePtr AOI_Object_Vector::GetStrokeStyle ( ) const

inherited

Returns the stroke style of an object.

Returns

The fill style.

See also

AOI_Style

Definition at line 48 of file AOI_Vector.cpp.

GetStrokeWidth()

float AOI_Object_Vector::GetStrokeWidth ( ) const

inherited

Returns the stroke width.

Returns

The stroke width.

See also

SetStrokeWidth

Definition at line 103 of file AOI_Vector.cpp.

GetText()

aur::ACPL::UString AOI_Object_Text::GetText ( int selStart, int selEnd ) const

inherited

Returns the requested part of the text in charCode format. Depending on the encoding type of the font this might be Unicode or any other format. For embedded fonts this is usually custom encoding.

Parameters

selStart	The point in the text to start from.
selEnd	The point in the text to end with.
charCode	Receives the text.

Returns

the number of characters obtained in charCode.

Definition at line 127 of file AOI_Text.cpp.

GetType()

uint32_t AOI_Object::GetType ( ) const

inherited

Returns the type of the object.

Possible types are:

• gDimensionType
• gGroupType
• gRasterType
• gSymbolType
• gMultiSymbolType
• gEllipseType
• gPathType
• gMultigonType
• gRectangleType
• gTextType
• gPathTextType
• gGroupType
• gPlaceHolderType

Returns

The type of the object.

See also

AOI_Object_Bitmap AOI_Object_Dimension AOI_Object_Ellipse AOI_Object_Group AOI_Object_Layer AOI_Object_Multigon AOI_Object_MultiSymbol AOI_Object_Path AOI_Object_PathText AOI_Object_PlaceHolder AOI_Object_Raster AOI_Object_Rectangle AOI_Object_Symbol AOI_Object_Text AOI_Object_Vector

Definition at line 90 of file AOI_Object.cpp.

Map()

void AOI_Object::Map ( const AOI_Mapping & mapping )

inherited

Maps the object.

Parameters

mapping

The mapping which should be applied to this object.

See also

AOI_Mapping, Scale

Definition at line 192 of file AOI_Object.cpp.

operator delete()

void AOI_Object::operator delete ( void * p )

staticinherited

Deletes the object, after removing it from the object tree.

Definition at line 181 of file AOI_Object.cpp.

Scale()

void AOI_Object::Scale ( const AOI_Mapping & mapping )

inherited

Scale the objects while retaining properties like line-width and dash distance proportional to the supplied scale.

Parameters

mapping

The mapping which should be applied to this object. The mapping should only contain a scale to avoid unwanted side effect.

See also

AOI_Mapping, Map

Definition at line 206 of file AOI_Object.cpp.

SetBlendMode()

void AOI_Object::SetBlendMode ( AOI_BlendMode blendmode )

inherited

Sets the object its blendmode.

Parameters

blendmode

The blend mode to use.

See also

AOI_BlendMode GetBlendMode

Definition at line 217 of file AOI_Object.cpp.

SetBlendValue()

void AOI_Object::SetBlendValue ( float blendValue )

inherited

Sets the object its blendmode.

Parameters

blendValue

The amount of opacity. For normal blending this is the opacity value. 0 is transparent and 1 is opaque.

See also

GetBlendValue

Definition at line 230 of file AOI_Object.cpp.

SetCaps()

void AOI_Object_Vector::SetCaps ( uint8_t caps )

inherited

Set the caps type of the nodes of the path.

Parameters

caps	kButtCap, kRoundCap, kSquareCap are valid values.

See also

GetCaps

Definition at line 164 of file AOI_Vector.cpp.

SetDash()

void AOI_Object_Vector::SetDash ( int32_t nrOffDashes, float * dashes, float fase )

inherited

Sets the dash definition of this path.

Parameters

nrOffDashes	Set the number of alternating values; the size of the dashes array.
dashes	Array containing the alternating values.
fase	The offset in the alternating values to start with at the beginning of the vector.

See also

GetDash

Definition at line 198 of file AOI_Vector.cpp.

SetEOFill()

void AOI_Object_Vector::SetEOFill ( bool eoFill )

inherited

Set the EOFill or window fill.

Parameters

eoFill

True will set EOFill and false will set winding fill.

See also

GetEOFill

Definition at line 92 of file AOI_Vector.cpp.

SetFillStyle()

void AOI_Object_Vector::SetFillStyle ( AOI_StylePtr style )

inherited

Replaces the fill style.

Parameters

style

The fill style to use.

See also

AOI_Style

Definition at line 60 of file AOI_Vector.cpp.

SetIntent()

void AOI_Object::SetIntent ( AOI_Intent intent )

inherited

Sets the object its blendmode.

Parameters

intent

Intent to be used to convert to the device when a ICC based colorspace is assigned to this object.

See also

GetIntent

Definition at line 242 of file AOI_Object.cpp.

SetJoin()

void AOI_Object_Vector::SetJoin ( float join )

inherited

Set the join type of the nodes of the path.

Parameters

join	< 0 : round join, 0 : bevel join, > 0 mitter join (x line width)

See also

GetJoin

Definition at line 137 of file AOI_Vector.cpp.

SetProperties()

void AOI_Object_Text::SetProperties ( int selStart, int selEnd, const AOI_TextProperties & properties )

inherited

Sets the properties of a specific part of the text.

Parameters

selStart	The point in the text to start from.
selEnd	The point in the text to end with.
properties	The TextProperties to set on the specified text part.

See also

AOI_TextProperties

Definition at line 146 of file AOI_Text.cpp.

SetStrokeStyle()

void AOI_Object_Vector::SetStrokeStyle ( AOI_StylePtr style )

inherited

Replaces the stroke style.

Parameters

style

The stroke style to use.

See also

AOI_Style

Definition at line 71 of file AOI_Vector.cpp.

SetStrokeWidth()

void AOI_Object_Vector::SetStrokeWidth ( float width )

inherited

Set the width of the stroke in units.

Parameters

width

Width of the stroke. 0 represents a hairline. Negative values are not allowed.

See also

GetStrokeWidth

Definition at line 115 of file AOI_Vector.cpp.

SetText()

void AOI_Object_Text::SetText ( const aur::ACPL::UString & uniText )

inherited

Replaces the actual text of the AOI_Object_Text.

Parameters

uniText

The text in unicode format.

Definition at line 108 of file AOI_Text.cpp.

Visible()

bool AOI_Object::Visible ( ) const

inherited

Returns if this object is visible.

Returns

The visibility.

Definition at line 171 of file AOI_Object.cpp.

---

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

• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Text.h