Poppler Qt5  22.05.0
Classes | Public Types | Public Member Functions | List of all members
Poppler::HighlightAnnotation Class Reference

#include <poppler-annotation.h>

Inheritance diagram for Poppler::HighlightAnnotation:
Inheritance graph
[legend]
Collaboration diagram for Poppler::HighlightAnnotation:
Collaboration graph
[legend]

Classes

struct  Quad
 

Public Types

enum  HighlightType { Highlight , Squiggly , Underline , StrikeOut }
 
- Public Types inherited from Poppler::Annotation
enum  AdditionalActionType {
  CursorEnteringAction , CursorLeavingAction , MousePressedAction , MouseReleasedAction ,
  FocusInAction , FocusOutAction , PageOpeningAction , PageClosingAction ,
  PageVisibleAction , PageInvisibleAction
}
 
enum  Flag {
  Hidden = 1 , FixedSize = 2 , FixedRotation = 4 , DenyPrint = 8 ,
  DenyWrite = 16 , DenyDelete = 32 , ToggleHidingOnMouse = 64 , External = 128
}
 
enum  LineEffect { NoEffect = 1 , Cloudy = 2 }
 
enum  LineStyle {
  Solid = 1 , Dashed = 2 , Beveled = 4 , Inset = 8 ,
  Underline = 16
}
 
enum  RevScope { Root = 0 , Reply = 1 , Group = 2 , Delete = 4 }
 
enum  RevType {
  None = 1 , Marked = 2 , Unmarked = 4 , Accepted = 8 ,
  Rejected = 16 , Cancelled = 32 , Completed = 64
}
 
enum  SubType {
  AText = 1 , ALine = 2 , AGeom = 3 , AHighlight = 4 ,
  AStamp = 5 , AInk = 6 , ALink = 7 , ACaret = 8 ,
  AFileAttachment = 9 , ASound = 10 , AMovie = 11 , AScreen = 12 ,
  AWidget = 13 , ARichMedia = 14 , A_BASE = 0
}
 

Public Member Functions

QList< QuadhighlightQuads () const
 
HighlightType highlightType () const
 
void setHighlightQuads (const QList< Quad > &quads)
 
void setHighlightType (HighlightType type)
 
SubType subType () const override
 
- Public Member Functions inherited from Poppler::Annotation
std::unique_ptr< AnnotationAppearanceannotationAppearance () const
 
QString author () const
 
QRectF boundary () const
 
QString contents () const
 
QDateTime creationDate () const
 
int flags () const
 
QDateTime modificationDate () const
 
Popup popup () const
 
QList< Annotation * > revisions () const
 
RevScope revisionScope () const
 
RevType revisionType () const
 
void setAnnotationAppearance (const AnnotationAppearance &annotationAppearance)
 
void setAuthor (const QString &author)
 
void setBoundary (const QRectF &boundary)
 
void setContents (const QString &contents)
 
void setCreationDate (const QDateTime &date)
 
void setFlags (int flags)
 
void setModificationDate (const QDateTime &date)
 
void setPopup (const Popup &popup)
 
void setStyle (const Style &style)
 
void setUniqueName (const QString &uniqueName)
 
Style style () const
 
QString uniqueName () const
 
virtual ~Annotation ()
 

Detailed Description

Text highlight annotation.

The highlight annotation represents some areas of text being "highlighted".

Member Enumeration Documentation

◆ HighlightType

The type of highlight.

Enumerator
Highlight 

highlighter pen style annotation

Squiggly 

jagged or squiggly underline

Underline 

straight line underline

StrikeOut 

straight line through-line


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