KD Reports API Documentation  2.2
Classes | Typedefs | Enumerations | Functions | Variables
KDReports Namespace Reference

Classes

class  AbstractReportLayout
 
class  AbstractTableElement
 
class  AutoTableElement
 
class  Cell
 
class  ChartElement
 
class  Element
 
struct  ElementData
 
class  ErrorDetails
 
class  ErrorDetailsPrivate
 
class  FontScaler
 
class  Frame
 
class  Header
 
class  HeaderMap
 
class  HeaderPrivate
 
class  HeaderReportBuilder
 
class  HLineElement
 
class  HLineTextObject
 
class  HtmlElement
 
class  ImageElement
 
class  MainTable
 
class  PreviewDialog
 
class  PreviewWidget
 
class  Report
 
class  ReportBuilder
 
class  ReportPrivate
 
class  SpreadsheetReportLayout
 
class  TableBreakingLogic
 
class  TableBreakingSettingsDialog
 
class  TableElement
 
class  TableLayout
 
class  TextDocReportLayout
 
class  TextDocument
 
class  TextDocumentData
 
class  TextElement
 
class  XmlElementHandler
 
class  XmlHelper
 
class  XmlParser
 

Typedefs

using CellContentMap = QMap< QPair< int, int >, Cell >
 
typedef Header Footer
 
using XmlElementHandlerPrivateV2 = XmlElementHandlerPrivate
 

Enumerations

enum  { HeaderColumnsProperty = QTextFormat::UserProperty + 248 }
 
enum  HeaderLocation {
  FirstPage = 1 , EvenPages = 2 , OddPages = 4 , LastPage = 8 ,
  AllPages = OddPages | EvenPages
}
 
enum  Unit { Millimeters , Percent }
 
enum  VariableType {
  PageNumber , PageCount , TextDate , ISODate ,
  LocaleDate , TextTime , ISOTime , LocaleTime ,
  SystemLocaleShortDate , SystemLocaleLongDate , DefaultLocaleShortDate , DefaultLocaleLongDate ,
  NVariableTypes
}
 

Functions

void cleanupVariableProperties (QTextCharFormat &charFormat)
 
KDREPORTS_EXPORT qreal mmToPixels (qreal mm)
 
QAbstractItemModel * modelForKey (const QString &key)
 
KDREPORTS_EXPORT qreal pixelsToPointsMultiplier (double resolution)
 
void setVariableMarker (QTextDocument &textDoc, int pos, KDReports::VariableType variableType, int valueLength)
 
QString variableValue (int pageNumber, KDReports::Report *report, VariableType type)
 

Variables

static const int ResizableImageProperty = QTextFormat::UserProperty + 5984
 

Detailed Description

This is the namespace that contains all KDReports classes and some enums that do not belong to a particular class.

Typedef Documentation

◆ CellContentMap

using KDReports::CellContentMap = typedef QMap<QPair<int , int >, Cell>

Definition at line 24 of file KDReportsTableElement.cpp.

◆ Footer

Definition at line 122 of file KDReportsHeader.h.

◆ XmlElementHandlerPrivateV2

using KDReports::XmlElementHandlerPrivateV2 = typedef XmlElementHandlerPrivate

Definition at line 259 of file KDReportsXmlElementHandler.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
HeaderColumnsProperty 

Definition at line 42 of file KDReportsTextDocument_p.h.

◆ HeaderLocation

If no header was specified for the first and last pages, then the even/odd headers are used for those.

Enumerator
FirstPage 

The first page of the report.

EvenPages 

The even pages of the report: 2, 4, 6 etc.

OddPages 

The odd pages of the report: 1 (unless FirstPage has its own header), 3, 5, 7 etc.

LastPage 

The last page of the report.

AllPages 

All pages (except first and last if FirstPage or LastPage have their own headers)

Definition at line 59 of file KDReportsReport.h.

◆ Unit

Units used when setting a size.

Enumerator
Millimeters 

Millimeters (the default)

Percent 

Percentage of the text width, i.e. the page width minus margins.

Definition at line 19 of file KDReportsUnit.h.

◆ VariableType

Type of variable

Enumerator
PageNumber 

Page number.

PageCount 

Page count.

TextDate 

Current date in text format like "Thu Aug 18 2005", with translated

ISODate 

names but unlocalized order of names and numbers

Current date in ISO 8601 format like "2005-08-18"

LocaleDate 

Current date in locale-dependent format, deprecated in favour of SystemLocaleShortDate or SystemLocaleLongDate.

TextTime 

Current time in text format like "13:42:59".

ISOTime 

Current time in ISO 8601 format like "13:42:59".

LocaleTime 

Current time in locale-dependent format.

SystemLocaleShortDate 

Current date formatted according to the system locale, short format, see Qt::SystemLocaleShortDate.

SystemLocaleLongDate 

Current date formatted according to the system locale, long format, see Qt::SystemLocaleLongDate.

DefaultLocaleShortDate 

Current date formatted according to the application locale, short format, see Qt::DefaultLocaleShortDate.

DefaultLocaleLongDate 

Current date formatted according to the application locale, long format, see Qt::DefaultLocaleLongDate.

NVariableTypes 

Definition at line 23 of file KDReportsVariableType.h.

Function Documentation

◆ cleanupVariableProperties()

void KDReports::cleanupVariableProperties ( QTextCharFormat &  charFormat)

◆ mmToPixels()

QT_END_NAMESPACE qreal KDReports::mmToPixels ( qreal  mm)

◆ modelForKey()

QAbstractItemModel * KDReports::modelForKey ( const QString &  key)

◆ pixelsToPointsMultiplier()

qreal KDReports::pixelsToPointsMultiplier ( double  resolution)

Definition at line 23 of file KDReportsLayoutHelper.cpp.

Referenced by KDReports::Report::print().

◆ setVariableMarker()

void KDReports::setVariableMarker ( QTextDocument &  textDoc,
int  pos,
KDReports::VariableType  variableType,
int  valueLength 
)

◆ variableValue()

QString KDReports::variableValue ( int  pageNumber,
KDReports::Report report,
VariableType  type 
)

Variable Documentation

◆ ResizableImageProperty

const int KDReports::ResizableImageProperty = QTextFormat::UserProperty + 5984
static

© Klarälvdalens Datakonsult AB (KDAB)
"The Qt, C++ and OpenGL Experts"
https://www.kdab.com/
https://www.kdab.com/development-resources/qt-tools/kd-reports/
Generated by doxygen 1.9.1