libcrn  3.9.5
A document image processing library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Friends | List of all members
Styles::Text Class Reference

A text style. More...

#include <CRNAltoStyles.hpp>

+ Inheritance diagram for Styles::Text:
+ Collaboration diagram for Styles::Text:

Public Types

enum  FontType { FontType::Undef = 0, FontType::Serif, FontType::SansSerif }
 
enum  FontWidth { FontWidth::Undef = 0, FontWidth::Proportional, FontWidth::Fixed }
 
enum  FontStyle {
  FontStyle::Undef = 0, FontStyle::Bold = 1, FontStyle::Italics = 2, FontStyle::Subscript = 4,
  FontStyle::Superscript = 8, FontStyle::SmallCaps = 16, FontStyle::Underline = 32
}
 

Public Member Functions

 Text (const Text &)=default
 
 Text (Text &&)=default
 
virtual ~Text () override
 
Textoperator= (const Text &)=default
 
Textoperator= (Text &&)=default
 
const Id & GetId () const
 
Option< StringUTF8 > GetFontFamily () const
 
void SetFontFamily (const StringUTF8 &ff)
 
void UnsetFontFamily ()
 
Option< FontTypeGetFontType () const
 
void SetFontType (FontType ft)
 
void UnsetFontType ()
 
Option< FontWidthGetFontWidth () const
 
void SetFontWidth (FontWidth fw)
 
void UnsetFontWidth ()
 
double GetFontSize () const
 
void SetFontSize (double fs)
 
Option< uint32_t > GetFontColor () const
 
void SetFontColor (uint32_t fc)
 
void UnsetFontColor ()
 
Option< FontStyleGetFontStyle () const
 
void SetFontStyle (FontStyle fs)
 
void UnsetFontStyle ()
 

Friends

class Styles
 

Detailed Description

A text style.

Author
Yann LEYDIER

Definition at line 47 of file CRNAltoStyles.hpp.

Member Enumeration Documentation

Enumerator
Undef 
Bold 
Italics 
Subscript 
Superscript 
SmallCaps 
Underline 

Definition at line 79 of file CRNAltoStyles.hpp.

Enumerator
Undef 
Serif 
SansSerif 

Definition at line 62 of file CRNAltoStyles.hpp.

Enumerator
Undef 
Proportional 
Fixed 

Definition at line 67 of file CRNAltoStyles.hpp.

Constructor & Destructor Documentation

Styles::Text::Text ( const Text )
default
Styles::Text::Text ( Text &&  )
default
virtual Styles::Text::~Text ( )
inlineoverridevirtual

Definition at line 52 of file CRNAltoStyles.hpp.

Member Function Documentation

Option<uint32_t> Styles::Text::GetFontColor ( ) const
Option<StringUTF8> Styles::Text::GetFontFamily ( ) const
double Styles::Text::GetFontSize ( ) const
Option<FontStyle> Styles::Text::GetFontStyle ( ) const
Option<FontType> Styles::Text::GetFontType ( ) const
Option<FontWidth> Styles::Text::GetFontWidth ( ) const
const Id& Styles::Text::GetId ( ) const
inline

Definition at line 56 of file CRNAltoStyles.hpp.

Text& Styles::Text::operator= ( const Text )
default
Text& Styles::Text::operator= ( Text &&  )
default
void Styles::Text::SetFontColor ( uint32_t  fc)
void Styles::Text::SetFontFamily ( const StringUTF8 &  ff)
void Styles::Text::SetFontSize ( double  fs)
void Styles::Text::SetFontStyle ( FontStyle  fs)
void Styles::Text::SetFontType ( FontType  ft)
void Styles::Text::SetFontWidth ( FontWidth  fw)
void Styles::Text::UnsetFontColor ( )
void Styles::Text::UnsetFontFamily ( )
void Styles::Text::UnsetFontStyle ( )
void Styles::Text::UnsetFontType ( )
void Styles::Text::UnsetFontWidth ( )

Friends And Related Function Documentation

friend class Styles
friend

Definition at line 89 of file CRNAltoStyles.hpp.


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