CalendarSupport::CalPrintPluginBase

Search for usage in LXR

#include <calprintpluginbase.h>

Inheritance diagram for CalendarSupport::CalPrintPluginBase:

Public Types

enum  DisplayFlags { Text = 0x0001 , TimeBoxes = 0x0002 }
 
- Public Types inherited from CalendarSupport::PrintPlugin
using List = QList<PrintPlugin *>
 

Public Member Functions

 CalPrintPluginBase ()
 
int borderWidth () const
 
QWidgetcreateConfigWidget (QWidget *) override
 
void doLoadConfig () override
 
void doPrint (QPrinter *printer) override
 
void doSaveConfig () override
 
void drawAgendaDayBox (QPainter &p, const KCalendarCore::Event::List &eventList, QDate qd, bool expandable, QTime fromTime, QTime toTime, QRect box, bool includeDescription, bool includeCategories, bool excludeTime, const QList< QDate > &workDays)
 
void drawAgendaItem (PrintCellItem *item, QPainter &p, const QDateTime &startPrintDate, const QDateTime &endPrintDate, float minlen, QRect box, bool includeDescription, bool includeCategories, bool excludeTime)
 
int drawBoxWithCaption (QPainter &p, QRect box, const QString &caption, const QString &contents, bool sameLine, bool expand, const QFont &captionFont, const QFont &textFont, bool richContents=false)
 
void drawDayBox (QPainter &p, QDate qd, QTime fromTime, QTime toTime, QRect box, bool fullDate=false, bool printRecurDaily=true, bool printRecurWeekly=true, bool singleLineLimit=true, bool includeDescription=false, bool includeCategories=false)
 
void drawDaysOfWeek (QPainter &p, QDate fromDate, QDate toDate, QRect box)
 
void drawDaysOfWeekBox (QPainter &p, QDate qd, QRect box)
 
int drawFooter (QPainter &p, QRect box)
 
int drawHeader (QPainter &p, const QString &title, QDate month1, QDate month2, QRect box, bool expand=false, QColor backColor=QColor())
 
void drawMonth (QPainter &p, QDate dt, QRect box, int maxdays=-1, int subDailyFlags=TimeBoxes, int holidaysFlags=Text)
 
void drawMonthTable (QPainter &p, QDate qd, QTime fromTime, QTime toTime, bool weeknumbers, bool recurDaily, bool recurWeekly, bool singleLineLimit, bool includeDescription, bool includeCategories, QRect box)
 
void drawNoteLines (QPainter &p, QRect box, int startY)
 
void drawSmallMonth (QPainter &p, QDate qd, QRect box)
 
void drawSplitHeaderRight (QPainter &p, QDate fd, QDate td, QDate cd, int width, int height)
 
void drawSubHeaderBox (QPainter &p, const QString &str, QRect box)
 
void drawTextLines (QPainter &p, const QString &entry, int x, int &y, int width, int pageHeight, bool richTextEntry)
 
void drawTimeLine (QPainter &p, QTime fromTime, QTime toTime, QRect box)
 
void drawTodo (int &count, const KCalendarCore::Todo::Ptr &todo, QPainter &p, KCalendarCore::TodoSortField sortField, KCalendarCore::SortDirection sortDir, bool connectSubTodos, bool strikeoutCompleted, bool desc, int posPriority, int posSummary, int posCategories, int posStartDt, int posDueDt, int posPercentComplete, int level, int x, int &y, int width, int pageHeight, const KCalendarCore::Todo::List &todoList, TodoParentStart *r)
 
void drawVerticalBox (QPainter &p, int linewidth, QRect box, const QString &str, int flags=-1)
 
int footerHeight () const
 
int headerHeight () const
 
int margin () const
 
QPageLayout::Orientation orientation () const
 
int padding () const
 
virtual void print (QPainter &p, int width, int height)=0
 
void printEventString (QPainter &p, QRect box, const QString &str, int flags=-1)
 
bool printFooter () const
 
void setBorderWidth (const int border)
 
void setFooterHeight (const int height)
 
void setHeaderHeight (const int height)
 
void setMargin (const int margin)
 
void setPadding (const int margin)
 
void setPrintFooter (bool printFooter)
 
void setSubHeaderHeight (const int height)
 
void setUseColors (bool useColors)
 
void showEventBox (QPainter &p, int linewidth, QRect box, const KCalendarCore::Incidence::Ptr &incidence, const QString &str, int flags=-1)
 
int subHeaderHeight () const
 
bool useColors () const
 
- Public Member Functions inherited from CalendarSupport::PrintPlugin
QWidgetconfigWidget (QWidget *w)
 
virtual QPageLayout::Orientation defaultOrientation () const
 
virtual QString description () const =0
 
virtual bool enabled () const
 
virtual QString groupName () const =0
 
virtual QString info () const =0
 
virtual void readSettingsWidget ()
 
virtual KCalendarCore::Incidence::List selectedIncidences () const
 
virtual void setCalendar (const KCalendarCore::Calendar::Ptr &cal)
 
virtual void setConfig (KConfig *cfg)
 
virtual void setDateRange (const QDate &from, const QDate &to)
 
virtual void setSelectedIncidences (const KCalendarCore::Incidence::List &inc)
 
virtual void setSettingsWidget ()
 
virtual int sortID () const
 

Static Public Member Functions

static void drawBox (QPainter &p, int linewidth, QRect rect)
 
static void drawShadedBox (QPainter &p, int linewidth, const QBrush &brush, QRect rect)
 
static int weekdayColumn (int weekday)
 

Protected Member Functions

QColor categoryBgColor (const KCalendarCore::Incidence::Ptr &incidence) const
 
QTime dayStart () const
 
void drawIncidence (QPainter &p, QRect dayBox, const QString &time, const QString &summary, const QString &description, int &textY, bool singleLineLimit, bool includeDescription, bool richDescription)
 
void drawTodoLines (QPainter &p, const QString &entry, int x, int &y, int width, int pageHeight, bool richTextEntry, QList< TodoParentStart * > &startPoints, bool connectSubTodos)
 
KCalendarCore::Event::Ptr holidayEvent (QDate date) const
 
QString toPlainText (const QString &htmlText)
 

Protected Attributes

int mBorder
 
bool mExcludeConfidential
 
bool mExcludePrivate
 
int mFooterHeight
 
int mHeaderHeight
 
int mMargin
 
int mPadding
 
bool mPrintFooter
 
bool mShowNoteLines
 
int mSubHeaderHeight
 
bool mUseColors
 
- Protected Attributes inherited from CalendarSupport::PrintPlugin
KCalendarCore::Calendar::Ptr mCalendar
 
KConfigmConfig = nullptr
 
QPointer< QWidgetmConfigWidget
 
QDate mFromDate
 
QPrintermPrinter = nullptr
 
KCalendarCore::Incidence::List mSelectedIncidences
 
QDate mToDate
 

Static Protected Attributes

static const QColor sHolidayBackground = QColor(244, 244, 244)
 

Detailed Description

Base class for Calendar printing classes.

Each sub class represents one calendar print format.

Definition at line 43 of file calprintpluginbase.h.

Member Enumeration Documentation

◆ DisplayFlags

enum CalendarSupport::CalPrintPluginBase::DisplayFlags

Definition at line 46 of file calprintpluginbase.h.

Constructor & Destructor Documentation

◆ CalPrintPluginBase()

CalPrintPluginBase::CalPrintPluginBase ( )

Constructor.

Definition at line 114 of file calprintpluginbase.cpp.

Member Function Documentation

◆ borderWidth()

int CalPrintPluginBase::borderWidth ( ) const

Definition at line 386 of file calprintpluginbase.cpp.

◆ categoryBgColor()

QColor CalPrintPluginBase::categoryBgColor ( const KCalendarCore::Incidence::Ptr & incidence) const
protected

Definition at line 280 of file calprintpluginbase.cpp.

◆ createConfigWidget()

QWidget * CalPrintPluginBase::createConfigWidget ( QWidget * w)
overridevirtual

Returns widget for configuring the print format.

Implements CalendarSupport::PrintPlugin.

Definition at line 128 of file calprintpluginbase.cpp.

◆ dayStart()

QTime CalPrintPluginBase::dayStart ( ) const
protected

Definition at line 247 of file calprintpluginbase.cpp.

◆ doLoadConfig()

void CalPrintPluginBase::doLoadConfig ( )
overridevirtual

Load complete configuration.

Each implementation calls its parent's implementation to load parent configuration options, then loads its own.

Reimplemented from CalendarSupport::PrintPlugin.

Definition at line 178 of file calprintpluginbase.cpp.

◆ doPrint()

void CalPrintPluginBase::doPrint ( QPrinter * printer)
overridevirtual

Start printing.

Implements CalendarSupport::PrintPlugin.

Definition at line 147 of file calprintpluginbase.cpp.

◆ doSaveConfig()

void CalPrintPluginBase::doSaveConfig ( )
overridevirtual

Save complete configuration.

Each implementation saves its own configuration options, then calls its parent's implementation to save parent options.

Reimplemented from CalendarSupport::PrintPlugin.

Definition at line 196 of file calprintpluginbase.cpp.

◆ drawAgendaDayBox()

void CalPrintPluginBase::drawAgendaDayBox ( QPainter & p,
const KCalendarCore::Event::List & eventList,
QDate qd,
bool expandable,
QTime fromTime,
QTime toTime,
QRect box,
bool includeDescription,
bool includeCategories,
bool excludeTime,
const QList< QDate > & workDays )

Draw the agenda box for the day print style (the box showing all events of that day).

Also draws a grid with half-hour spacing of the grid lines. Does NOT draw allday events. Use drawAllDayBox for allday events.

Obeys configuration options mExcludeConfidential, #excludePrivate.

Parameters
pQPainter of the printout
eventListThe list of the events that are supposed to be printed inside this box
qdThe date of the currently printed day
expandableIf true, the start and end times are adjusted to include the whole range of all events of that day, not just of the given time range. The height of the box will not be affected by this (but the height of one hour will be scaled down so that the whole range fits into the box. fromTime and toTime receive the actual time range printed by this function).
fromTimeStart of the time range to be printed. Might be adjusted to include all events if expandable==true
toTimeEnd of the time range to be printed. Might be adjusted to include all events if expandable==true
boxcoordinates of the agenda day box.
includeDescriptionWhether to print the event description as well.
includeCategoriesWhether to print the event categories (tags) as well.
excludeTimeWhether the time is printed in the detail area.
workDaysList of workDays

Definition at line 762 of file calprintpluginbase.cpp.

◆ drawAgendaItem()

void CalPrintPluginBase::drawAgendaItem ( PrintCellItem * item,
QPainter & p,
const QDateTime & startPrintDate,
const QDateTime & endPrintDate,
float minlen,
QRect box,
bool includeDescription,
bool includeCategories,
bool excludeTime )

Definition at line 883 of file calprintpluginbase.cpp.

◆ drawBox()

void CalPrintPluginBase::drawBox ( QPainter & p,
int linewidth,
QRect rect )
static

Draw a box with given width at the given coordinates.

Parameters
pThe printer to be used
linewidthThe border width of the box
rectThe rectangle of the box

Definition at line 396 of file calprintpluginbase.cpp.

◆ drawBoxWithCaption()

int CalPrintPluginBase::drawBoxWithCaption ( QPainter & p,
QRect box,
const QString & caption,
const QString & contents,
bool sameLine,
bool expand,
const QFont & captionFont,
const QFont & textFont,
bool richContents = false )

Draw a component box with a heading (printed in bold).

Parameters
pQPainter of the printout
boxCoordinates of the box
captionCaption string to be printed inside the box
contentsNormal text contents of the box. If contents.isNull(), then no text will be printed, only the caption.
sameLineWhether the contents should start on the same line as the caption (the space below the caption text will be used as indentation in the subsequent lines) or on the next line (no indentation of the contents)
expandWhether to expand the box vertically to fit the whole text in it.
rickContentsWhether contents contains rich text.
Returns
The bottom of the printed box. If expand==true, the bottom of the drawn box is returned, if expand==false, the vertical end of the printed contents inside the box is returned. If you want to print some custom graphics or text below the contents, use the return value as the top-value of your custom contents in that case.

Definition at line 468 of file calprintpluginbase.cpp.

◆ drawDayBox()

void CalPrintPluginBase::drawDayBox ( QPainter & p,
QDate qd,
QTime fromTime,
QTime toTime,
QRect box,
bool fullDate = false,
bool printRecurDaily = true,
bool printRecurWeekly = true,
bool singleLineLimit = true,
bool includeDescription = false,
bool includeCategories = false )

Draw the box containing a list of all events of the given day (with their times, of course).

Used in the Filofax and the month print style.

Obeys configuration options mExcludeConfidential, mExcludePrivate, mShowNoteLines, mUseColors.

Parameters
pQPainter of the printout
qdThe date of the currently printed day. All events of the calendar that appear on that day will be printed.
fromTimeStart time of the time range to display
toTimeEnd time of the time range to display
boxcoordinates of the day box.
fullDateWhether the title bar of the box should contain the full date string or just a short.
printRecurDailyWhether daily recurring incidences should be printed.
printRecurWeeklyWhether weekly recurring incidences should be printed.
singleLineLimitWhether Incidence text wraps or truncates.
includeDescriptionWhether to print the event description as well.
includeCategoriesWhether to print the event categories (tags) as well.

Definition at line 964 of file calprintpluginbase.cpp.

◆ drawDaysOfWeek()

void CalPrintPluginBase::drawDaysOfWeek ( QPainter & p,
QDate fromDate,
QDate toDate,
QRect box )

Draw a horizontal bar with the weekday names of the given date range in the given area of the painter.

This is used for the weekday-bar on top of the timetable view and the month view.

Parameters
pQPainter of the printout
fromDateFirst date of the printed dates
toDateLast date of the printed dates
boxcoordinates of the box for the days of the week

Definition at line 678 of file calprintpluginbase.cpp.

◆ drawDaysOfWeekBox()

void CalPrintPluginBase::drawDaysOfWeekBox ( QPainter & p,
QDate qd,
QRect box )

Draw a single weekday name in a box inside the given area of the painter.

This is called in a loop by drawDaysOfWeek.

Parameters
pQPainter of the printout
qdDate of the printed day
boxcoordinates of the weekbox

Definition at line 694 of file calprintpluginbase.cpp.

◆ drawFooter()

int CalPrintPluginBase::drawFooter ( QPainter & p,
QRect box )

Draw a page footer containing the printing date and possibly other things, like a page number.

Parameters
pQPainter of the printout
boxcoordinates of the footer
Returns
The bottom of the printed box.

Definition at line 607 of file calprintpluginbase.cpp.

◆ drawHeader()

int CalPrintPluginBase::drawHeader ( QPainter & p,
const QString & title,
QDate month1,
QDate month2,
QRect box,
bool expand = false,
QColor backColor = QColor() )

Draw the gray header bar of the printout to the QPainter.

It prints the given text and optionally one or two small month views, as specified by the two QDate. The printed text can also contain a line feed. If month2 is invalid, only the month that contains month1 is printed. E.g. the filofax week view draws just the current month, while the month view draws the previous and the next month.

Parameters
pQPainter of the printout
titleThe string printed as the title of the page (e.g. the date, date range or todo list title)
month1Date specifying the month for the left one of the small month views in the title bar. If left empty, only month2 will be printed (or none, it that is invalid as well).
month2Date specifying the month for the right one of the small month views in the title bar. If left empty, only month1 will be printed (or none, it that is invalid as well).
boxcoordinates of the title bar
expandWhether to expand the box vertically to fit the whole title in it.
backColorbackground color for the header box.
Returns
The bottom of the printed box. If expand==false, this is box.bottom, otherwise it is larger than box.bottom and matches the y-coordinate of the surrounding rectangle.

Definition at line 552 of file calprintpluginbase.cpp.

◆ drawIncidence()

void CalPrintPluginBase::drawIncidence ( QPainter & p,
QRect dayBox,
const QString & time,
const QString & summary,
const QString & description,
int & textY,
bool singleLineLimit,
bool includeDescription,
bool richDescription )
protected

Definition at line 1143 of file calprintpluginbase.cpp.

◆ drawMonth()

void CalPrintPluginBase::drawMonth ( QPainter & p,
QDate dt,
QRect box,
int maxdays = -1,
int subDailyFlags = TimeBoxes,
int holidaysFlags = Text )

Draw a vertical representation of the month containing the date dt.

Each day gets one line.

Obeys configuration options mExcludeConfidential, #excludePrivate.

Parameters
pQPainter of the printout
dtArbitrary date within the month to be printed
boxcoordinates of the box reserved for the month
maxdaysDays to print. If a value of -1 is given, the number of days is deduced from the month. If maxdays is larger than the number of days in the month, the remaining boxes are shaded to indicate they are not days of the month.
subDailyFlagsBitfield consisting of DisplayFlags flags to determine how events that do not cross midnight should be printed.
holidaysFlagsBitfield consisting of DisplayFlags flags to determine how holidays should be printed.

Definition at line 1258 of file calprintpluginbase.cpp.

◆ drawMonthTable()

void CalPrintPluginBase::drawMonthTable ( QPainter & p,
QDate qd,
QTime fromTime,
QTime toTime,
bool weeknumbers,
bool recurDaily,
bool recurWeekly,
bool singleLineLimit,
bool includeDescription,
bool includeCategories,
QRect box )

Draw the month table of the month containing the date qd.

Each day gets one box (using drawDayBox) that contains a list of all events on that day. They are arranged in a matrix, with the first column being the first day of the week (so it might display some days of the previous and the next month). Above the matrix there is a bar showing the weekdays (drawn using drawDaysOfWeek).

Obeys configuration options mExcludeConfidential, mExcludePrivate, mShowNoteLines, mUseColors.

Parameters
pQPainter of the printout
qdArbitrary date within the month to be printed.
fromTimeStart time of the displayed time range
toTimeEnd time of the displayed time range
weeknumbersWhether the week numbers are printed left of each row of the matrix
recurDailyWhether daily recurring incidences should be printed.
recurWeeklyWhether weekly recurring incidences should be printed.
singleLineLimitWhether Incidence text wraps or truncates.
includeDescriptionWhether descriptions are printed.
includeCategoriesWhether to print the event categories (tags) as well.
boxcoordinates of the month.

Definition at line 1454 of file calprintpluginbase.cpp.

◆ drawNoteLines()

void CalPrintPluginBase::drawNoteLines ( QPainter & p,
QRect box,
int startY )

Draws dotted lines for notes in a box.

Parameters
pQPainter of the printout
boxcoordinates of the box where the lines will be placed
startYstarting y-coordinate for the first line

Definition at line 1918 of file calprintpluginbase.cpp.

◆ drawShadedBox()

void CalPrintPluginBase::drawShadedBox ( QPainter & p,
int linewidth,
const QBrush & brush,
QRect rect )
static

Draw a shaded box with given width at the given coordinates.

Parameters
pThe printer to be used
linewidthThe border width of the box
brushThe brush to fill the box
rectThe rectangle of the box

Definition at line 411 of file calprintpluginbase.cpp.

◆ drawSmallMonth()

void CalPrintPluginBase::drawSmallMonth ( QPainter & p,
QDate qd,
QRect box )

Draw a small calendar with the days of a month into the given area.

Used for example in the title bar of the sheet.

Parameters
pQPainter of the printout
qdArbitrary Date within the month to be printed.
boxcoordinates of the small calendar

Definition at line 618 of file calprintpluginbase.cpp.

◆ drawSplitHeaderRight()

void CalPrintPluginBase::drawSplitHeaderRight ( QPainter & p,
QDate fd,
QDate td,
QDate cd,
int width,
int height )

Definition at line 1867 of file calprintpluginbase.cpp.

◆ drawSubHeaderBox()

void CalPrintPluginBase::drawSubHeaderBox ( QPainter & p,
const QString & str,
QRect box )

Draw a subheader box with a shaded background and the given string.

Parameters
pQPainter of the printout
strText to be printed inside the box
boxCoordinates of the box

Definition at line 445 of file calprintpluginbase.cpp.

◆ drawTextLines()

void CalPrintPluginBase::drawTextLines ( QPainter & p,
const QString & entry,
int x,
int & y,
int width,
int pageHeight,
bool richTextEntry )

Draws text lines splitting on page boundaries.

Parameters
pQPainter of the printout
xx-coordinate of the upper left coordinate of the first item
yy-coordinate of the upper left coordinate of the first item
widthwidth of the whole list
pageHeightsize of the page. A new page is started when the text reaches the end of the page.

Definition at line 1839 of file calprintpluginbase.cpp.

◆ drawTimeLine()

void CalPrintPluginBase::drawTimeLine ( QPainter & p,
QTime fromTime,
QTime toTime,
QRect box )

Draw a (vertical) time scale from time fromTime to toTime inside the given area of the painter.

Every hour will have a one-pixel line over the whole width, every half-hour the line will only span the left half of the width. This is used in the day and timetable print styles

Parameters
pQPainter of the printout
fromTimeStart time of the time range to display
toTimeEnd time of the time range to display
boxcoordinates of the timeline

Definition at line 699 of file calprintpluginbase.cpp.

◆ drawTodo()

void CalPrintPluginBase::drawTodo ( int & count,
const KCalendarCore::Todo::Ptr & todo,
QPainter & p,
KCalendarCore::TodoSortField sortField,
KCalendarCore::SortDirection sortDir,
bool connectSubTodos,
bool strikeoutCompleted,
bool desc,
int posPriority,
int posSummary,
int posCategories,
int posStartDt,
int posDueDt,
int posPercentComplete,
int level,
int x,
int & y,
int width,
int pageHeight,
const KCalendarCore::Todo::List & todoList,
TodoParentStart * r )

Draws single to-do and its (indented) sub-to-dos, optionally connects them by a tree-like line, and optionally shows due date, summary, description and priority.

Parameters
countThe number of the currently printed to-do (count will be incremented for each to-do drawn)
todoThe to-do to be printed. It's sub-to-dos are recursively drawn, so drawTodo should only be called on the to-dos of the highest level.
pQPainter of the printout
sortFieldSpecifies on which attribute of the todo you want to sort.
sortDirSpecifies if you want to sort ascending or descending.
connectSubTodosWhether sub-to-dos shall be connected with their parent by a line (tree-like).
strikeoutCompletedWhether completed to-dos should be printed with strike-out summaries.
descWhether to print the whole description of the to-do (the summary is always printed).
posPriorityx-coordinate where the priority is supposed to be printed. If negative, no priority will be printed.
posSummaryx-coordinate where the summary of the to-do is supposed to be printed.
posCategoriesx-coordinate where the categories (tags) should be printed. If negative, no categories will be printed.
posStartDtx-coordinate where the due date is supposed to the be printed. If negative, no start date will be printed.
posDueDtx-coordinate where the due date is supposed to the be printed. If negative, no due date will be printed.
posPercentCompletex-coordinate where the percentage complete is supposed to be printed. If negative, percentage complete will not be printed.
levelLevel of the current to-do in the to-do hierarchy (0 means highest level of printed to-dos, 1 are their sub-to-dos, etc.)
xx-coordinate of the upper left coordinate of the first to-do.
yy-coordinate of the upper left coordinate of the first to-do.
widthwidth of the whole to-do list.
pageHeightTotal height allowed for the to-do list on a page. If an to-do would be below that line, a new page is started.
todoListContains a list of sub-todos for the specified todo .
rInternal (used when printing sub-to-dos to give information about its parent)

Definition at line 1582 of file calprintpluginbase.cpp.

◆ drawTodoLines()

void CalPrintPluginBase::drawTodoLines ( QPainter & p,
const QString & entry,
int x,
int & y,
int width,
int pageHeight,
bool richTextEntry,
QList< TodoParentStart * > & startPoints,
bool connectSubTodos )
protected

Definition at line 1532 of file calprintpluginbase.cpp.

◆ drawVerticalBox()

void CalPrintPluginBase::drawVerticalBox ( QPainter & p,
int linewidth,
QRect box,
const QString & str,
int flags = -1 )

Draw an event box with vertical text.

Parameters
pQPainter of the printout
linewidthis the width of the line used to draw the box, ignored if less than 1.
boxCoordinates of the box
strext to be printed inside the box
flagsis a bitwise OR of Qt::AlignmentFlags and Qt::TextFlags values.

Definition at line 454 of file calprintpluginbase.cpp.

◆ footerHeight()

int CalPrintPluginBase::footerHeight ( ) const

Returns the height of the page footer.

If the height was explicitly set using setFooterHeight, that value is returned, otherwise a default value based on the printer orientation.

Returns
height of the page footer of the printout

Definition at line 346 of file calprintpluginbase.cpp.

◆ headerHeight()

int CalPrintPluginBase::headerHeight ( ) const

Returns the height of the page header.

If the height was explicitly set using setHeaderHeight, that value is returned, otherwise a default value based on the printer orientation.

Returns
height of the page header of the printout

Definition at line 320 of file calprintpluginbase.cpp.

◆ holidayEvent()

KCalendarCore::Event::Ptr CalPrintPluginBase::holidayEvent ( QDate date) const
protected

Definition at line 301 of file calprintpluginbase.cpp.

◆ margin()

int CalPrintPluginBase::margin ( ) const

Definition at line 366 of file calprintpluginbase.cpp.

◆ orientation()

QPageLayout::Orientation CalPrintPluginBase::orientation ( ) const

Definition at line 236 of file calprintpluginbase.cpp.

◆ padding()

int CalPrintPluginBase::padding ( ) const

Definition at line 376 of file calprintpluginbase.cpp.

◆ print()

virtual void CalendarSupport::CalPrintPluginBase::print ( QPainter & p,
int width,
int height )
pure virtual

Actually do the printing.

Parameters
pQPainter the print result is painted to
widthWidth of printable area
heightHeight of printable area

◆ printEventString()

void CalPrintPluginBase::printEventString ( QPainter & p,
QRect box,
const QString & str,
int flags = -1 )

Print the given string (event summary) in the given rectangle.

Margins and justification (centered or not) are automatically adjusted.

Parameters
pQPainter of the printout
boxCoordinates of the surrounding event box
strThe text to be printed in the box

Definition at line 419 of file calprintpluginbase.cpp.

◆ printFooter()

bool CalPrintPluginBase::printFooter ( ) const

Definition at line 226 of file calprintpluginbase.cpp.

◆ setBorderWidth()

void CalPrintPluginBase::setBorderWidth ( const int border)

Definition at line 391 of file calprintpluginbase.cpp.

◆ setFooterHeight()

void CalPrintPluginBase::setFooterHeight ( const int height)

Definition at line 361 of file calprintpluginbase.cpp.

◆ setHeaderHeight()

void CalPrintPluginBase::setHeaderHeight ( const int height)

Definition at line 331 of file calprintpluginbase.cpp.

◆ setMargin()

void CalPrintPluginBase::setMargin ( const int margin)

Definition at line 371 of file calprintpluginbase.cpp.

◆ setPadding()

void CalPrintPluginBase::setPadding ( const int margin)

Definition at line 381 of file calprintpluginbase.cpp.

◆ setPrintFooter()

void CalPrintPluginBase::setPrintFooter ( bool printFooter)

Definition at line 231 of file calprintpluginbase.cpp.

◆ setSubHeaderHeight()

void CalPrintPluginBase::setSubHeaderHeight ( const int height)

Definition at line 341 of file calprintpluginbase.cpp.

◆ setUseColors()

void CalPrintPluginBase::setUseColors ( bool useColors)

Definition at line 221 of file calprintpluginbase.cpp.

◆ showEventBox()

void CalPrintPluginBase::showEventBox ( QPainter & p,
int linewidth,
QRect box,
const KCalendarCore::Incidence::Ptr & incidence,
const QString & str,
int flags = -1 )

Print the box for the given event with the given string.

Parameters
pQPainter of the printout
linewidthis the width of the line used to draw the box, ignored if less than 1.
boxCoordinates of the event's box
incidenceThe incidence (if available), from which the category color will be deduced, if applicable.
strThe string to print inside the box
flagsis a bitwise OR of Qt::AlignmentFlags and Qt::TextFlags values.

Definition at line 426 of file calprintpluginbase.cpp.

◆ subHeaderHeight()

int CalPrintPluginBase::subHeaderHeight ( ) const

Definition at line 336 of file calprintpluginbase.cpp.

◆ toPlainText()

QString CalPrintPluginBase::toPlainText ( const QString & htmlText)
protected

Definition at line 1936 of file calprintpluginbase.cpp.

◆ useColors()

bool CalPrintPluginBase::useColors ( ) const

HELPER FUNCTIONS.

Definition at line 216 of file calprintpluginbase.cpp.

◆ weekdayColumn()

int CalPrintPluginBase::weekdayColumn ( int weekday)
static

Determines the column of the given weekday ( 1=Monday, 7=Sunday ), taking the start of the week setting into account as given in kcontrol.

Parameters
weekdayIndex of the weekday

Definition at line 1833 of file calprintpluginbase.cpp.

Member Data Documentation

◆ mBorder

int CalendarSupport::CalPrintPluginBase::mBorder
protected

Definition at line 549 of file calprintpluginbase.h.

◆ mExcludeConfidential

bool CalendarSupport::CalPrintPluginBase::mExcludeConfidential
protected

Whether or not to print incidences with secrecy "confidential".

Definition at line 542 of file calprintpluginbase.h.

◆ mExcludePrivate

bool CalendarSupport::CalPrintPluginBase::mExcludePrivate
protected

Whether or not to print incidences with secrecy "private".

Definition at line 543 of file calprintpluginbase.h.

◆ mFooterHeight

int CalendarSupport::CalPrintPluginBase::mFooterHeight
protected

Definition at line 546 of file calprintpluginbase.h.

◆ mHeaderHeight

int CalendarSupport::CalPrintPluginBase::mHeaderHeight
protected

Definition at line 544 of file calprintpluginbase.h.

◆ mMargin

int CalendarSupport::CalPrintPluginBase::mMargin
protected

Definition at line 547 of file calprintpluginbase.h.

◆ mPadding

int CalendarSupport::CalPrintPluginBase::mPadding
protected

Definition at line 548 of file calprintpluginbase.h.

◆ mPrintFooter

bool CalendarSupport::CalPrintPluginBase::mPrintFooter
protected

Whether or not to print a footer at the bottoms of pages.

Definition at line 540 of file calprintpluginbase.h.

◆ mShowNoteLines

bool CalendarSupport::CalPrintPluginBase::mShowNoteLines
protected

Whether or not to print horizontal lines in note areas.

Definition at line 541 of file calprintpluginbase.h.

◆ mSubHeaderHeight

int CalendarSupport::CalPrintPluginBase::mSubHeaderHeight
protected

Definition at line 545 of file calprintpluginbase.h.

◆ mUseColors

bool CalendarSupport::CalPrintPluginBase::mUseColors
protected

Whether or not to use event category colors to draw the events.

Definition at line 539 of file calprintpluginbase.h.

◆ sHolidayBackground

const QColor CalPrintPluginBase::sHolidayBackground = QColor(244, 244, 244)
staticprotected

Definition at line 551 of file calprintpluginbase.h.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:16:32 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.