pdftron::PDF::TextExtractor::Style

pdftron::PDF::TextExtractor::Style Class Reference

A class representing predominant text style associated with a given Line, a Word, or a Glyph. More...

#include <TextExtractor.h>

List of all members.

Public Member Functions

SDF::Obj GetFont ()
 
Returns:
low-level PDF font object.

UString GetFontName ()
 
Returns:
the font name used to draw the selected text.

double GetFontSize ()
 
Returns:
The font size used to draw the selected text as it appears on the output page.

int GetWeight ()
 
Returns:
The weight (thickness) component of the fully-qualified font name or font specifier.

bool IsItalic ()
 
Returns:
true if glyphs have dominant vertical strokes that are slanted.

bool IsSerif ()
 
Returns:
true if glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems.

void GetColor (UInt8 rgb[3])
 
Returns:
text color in RGB color space.

bool operator== (const Style &s)
bool operator!= (const Style &s)
 Style ()

Detailed Description

A class representing predominant text style associated with a given Line, a Word, or a Glyph.

The class includes information about the font, font size, font styles, text color, etc.

Constructor & Destructor Documentation

pdftron::PDF::TextExtractor::Style::Style (  ) 

Member Function Documentation

SDF::Obj pdftron::PDF::TextExtractor::Style::GetFont (  ) 

Returns:
low-level PDF font object.

A high level font object can be instantiated as follows: In C++: pdftron.PDF.Font f(style.GetFont()) In C#: pdftron.PDF.Font f = new pdftron.PDF.Font(style.GetFont());

UString pdftron::PDF::TextExtractor::Style::GetFontName (  ) 

Returns:
the font name used to draw the selected text.

double pdftron::PDF::TextExtractor::Style::GetFontSize (  ) 

Returns:
The font size used to draw the selected text as it appears on the output page.

Note:
Unlike the 'font size' in the graphics state (pdftron.PDF.GState) the returned font size accounts for the effects CTM, text matrix, and other graphics state attributes that can affect the appearance of text.

int pdftron::PDF::TextExtractor::Style::GetWeight (  ) 

Returns:
The weight (thickness) component of the fully-qualified font name or font specifier.

The possible values are 100, 200, 300, 400, 500, 600, 700, 800, or 900, where each number indicates a weight that is at least as dark as its predecessor. A value of 400 indicates a normal weight; 700 indicates bold. Note: The specific interpretation of these values varies from font to font. For example, 300 in one font may appear most similar to 500 in another.

bool pdftron::PDF::TextExtractor::Style::IsItalic (  ) 

Returns:
true if glyphs have dominant vertical strokes that are slanted.

Note:
the return value corresponds to the state of 'italic' flag in the 'Font Descriptor'.

bool pdftron::PDF::TextExtractor::Style::IsSerif (  ) 

Returns:
true if glyphs have serifs, which are short strokes drawn at an angle on the top and bottom of glyph stems.

Note:
the return value corresponds to the state of 'serif' flag in the 'Font Descriptor'.

void pdftron::PDF::TextExtractor::Style::GetColor ( UInt8  rgb[3]  ) 

Returns:
text color in RGB color space.

bool pdftron::PDF::TextExtractor::Style::operator== ( const Style &  s  ) 

bool pdftron::PDF::TextExtractor::Style::operator!= ( const Style &  s  ) 

© 2002-2008 PDFTron Systems Inc.