KReportSection

Search for usage in LXR

#include <KReportSection.shared.h>

Public Types

enum  Type {
  Invalid, PageHeaderFirst, PageHeaderOdd, PageHeaderEven,
  PageHeaderLast, PageHeaderAny, ReportHeader, ReportFooter,
  PageFooterFirst, PageFooterOdd, PageFooterEven, PageFooterLast,
  PageFooterAny, GroupHeader, GroupFooter, Detail
}
 

Public Member Functions

bool addElement (const KReportElement &element)
 
bool insertElement (int i, const KReportElement &element)
 
bool removeElement (const KReportElement &element)
 
bool removeElementAt (int i)
 

Static Public Member Functions

static QColor defaultBackgroundColor ()
 
static qreal defaultHeight ()
 
static void setDefaultBackgroundColor (const QColor &color)
 
static void setDefaultHeight (qreal height)
 

Public Attributes

QColor backgroundColor
 
QList< KReportElementelements
 
QSet< KReportElementelementsSet
 
qreal height
 
KReportSection::Type type
 

Detailed Description

The KReportSection class represents a section of a report design.

A section has optional report header, report footer, page header, page footer, group header, group footer and detail. In the case of page header and page footer it is possible to define (firstpage, odd, even or lastpage).

Definition at line 31 of file KReportSection.shared.h.

Member Function Documentation

◆ addElement()

bool KReportSection::addElement ( const KReportElement element)

Adds element element to this section.

Returns
true on success. Adding fails if element is already added to this or other section. Use KReportElement::clone() to add a copy.

Definition at line 113 of file KReportSection.cpp.

◆ defaultBackgroundColor()

QColor KReportSection::defaultBackgroundColor ( )
static
Returns
default background color for report sections. The standard is white.

Definition at line 192 of file KReportSection.cpp.

◆ defaultHeight()

qreal KReportSection::defaultHeight ( )
static
Returns
default height for report sections. The standard is 2cm (converted to points).

Definition at line 180 of file KReportSection.cpp.

◆ insertElement()

bool KReportSection::insertElement ( int  i,
const KReportElement element 
)

Adds element element to this section at index position i.

Returns
true on success. Adding fails if element is already added to this or other section or if position i is out of bounds. Use KReportElement::clone() to add a copy.

Definition at line 124 of file KReportSection.cpp.

◆ removeElement()

bool KReportSection::removeElement ( const KReportElement element)

Removes element element from this section.

Returns
true on success. Removing fails if element element is not added in this section.

Definition at line 139 of file KReportSection.cpp.

◆ removeElementAt()

bool KReportSection::removeElementAt ( int  i)

Removes element from index position i from this section.

Returns
true on success. Removing fails position i is out of bounds.

Definition at line 152 of file KReportSection.cpp.

◆ setDefaultBackgroundColor()

void KReportSection::setDefaultBackgroundColor ( const QColor color)
static

Sets default background color for report sections.

Definition at line 198 of file KReportSection.cpp.

◆ setDefaultHeight()

void KReportSection::setDefaultHeight ( qreal  height)
static

Sets default height for report sections in points.

Definition at line 186 of file KReportSection.cpp.

Member Data Documentation

◆ backgroundColor

QColor KReportSection::backgroundColor

@getter

Returns
section background color It is equal to KReportSection::defaultBackgroundColor() unless setBackgroundColor() is called with a valid color. @setter Sets section background color. Set invalid color (QColor()) to reset to the default background color.

Definition at line 83 of file KReportSection.shared.h.

◆ elements

QList< KReportElement > KReportSection::elements

@getter

Returns
all elements of this section

Definition at line 89 of file KReportSection.shared.h.

◆ elementsSet

QSet<KReportElement> KReportSection::elementsSet

A set that helps to quickly check if element is part of the section.

Definition at line 94 of file KReportSection.shared.h.

◆ height

qreal KReportSection::height

@getter

Returns
section height measured in points It is equal to KReportSection::defaultHeight() unless setHeight() is called with value > 0. @setter Sets section height measured in points. Set negative value to reset to the default height.

Definition at line 72 of file KReportSection.shared.h.

◆ type

KReportSection::Type KReportSection::type

@getter

Returns
section type Default section type is Invalid. @setter Sets section type.

Definition at line 61 of file KReportSection.shared.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu May 26 2022 04:04:55 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.