korganizer Library API Documentation

KOrg::CalendarDecoration Class Reference

This class provides the interface for a date dependent decoration. More...

#include <calendardecoration.h>

List of all members.

Public Types

typedef QPtrList< CalendarDecorationList

Public Member Functions

virtual QString shortText (const QDate &)
virtual QString longText (const QDate &)
virtual QPixmap smallPixmap (const QDate &)
virtual QPixmap largePixmap (const QDate &)
virtual QWidgetsmallWidget (QWidget *, const QDate &)

Static Public Member Functions

static int interfaceVersion ()
static QString serviceType ()


Detailed Description

This class provides the interface for a date dependent decoration.

It provides entities like texts and pictures for a given date. Implementations can implement all functions or only a subset.

Definition at line 40 of file calendardecoration.h.


Member Function Documentation

virtual QString KOrg::CalendarDecoration::shortText const QDate  )  [inline, virtual]
 

Return a short text for a given date, ususally only a few words.

Definition at line 54 of file calendardecoration.h.

Referenced by KOAgendaView::createDayLabels().

virtual QString KOrg::CalendarDecoration::longText const QDate  )  [inline, virtual]
 

Return along text for a given date.

This text can be of any length, but usually it will have one or a few paragraphs.

Definition at line 59 of file calendardecoration.h.

virtual QPixmap KOrg::CalendarDecoration::smallPixmap const QDate  )  [inline, virtual]
 

Return a small pixmap.

The size should be something like 30x30 pixels.

Definition at line 64 of file calendardecoration.h.

virtual QPixmap KOrg::CalendarDecoration::largePixmap const QDate  )  [inline, virtual]
 

Return a large pixmap.

The size should be something like 300x300 pixels.

Definition at line 68 of file calendardecoration.h.

virtual QWidget* KOrg::CalendarDecoration::smallWidget QWidget ,
const QDate
[inline, virtual]
 

Return a small widget.

It should have the size of a pushbutton.

Definition at line 73 of file calendardecoration.h.

Referenced by KOAgendaView::createDayLabels().


The documentation for this class was generated from the following file:
KDE Logo
This file is part of the documentation for korganizer Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Aug 2 09:56:30 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003