korganizer Library API Documentation

KOEventView Class Reference

KOEventView is the abstract base class from which all other calendar views for event data are derived. Abstract class from which all event views are derived. More...

#include <koeventview.h>

Inheritance diagram for KOEventView:

KOrg::BaseView QWidget KOAgendaView KOListView List of all members.

Public Slots

void showIncidencePopup (QPopupMenu *popup, Incidence *event)
void defaultAction (Incidence *)

Signals

void datesSelected (const DateList)
void showIncidenceSignal (Incidence *)
void editIncidenceSignal (Incidence *)
void deleteIncidenceSignal (Incidence *)
void newEventSignal ()
void newEventSignal (QDate)
void newEventSignal (QDateTime)
void newEventSignal (QDateTime, QDateTime)
void shiftedEvent (const QDate &olddate, const QDate &newdate)

Public Methods

 KOEventView (Calendar *cal, QWidget *parent=0, const char *name=0)
virtual ~KOEventView ()
virtual int maxDatesHint ()=0
KOEventPopupMenu * eventPopup ()
QPopupMenunewEventPopup ()
bool isEventView ()

Protected Slots

void popupShow ()
void popupEdit ()
void popupDelete ()

Protected Attributes

Incidence * mCurrentIncidence

Detailed Description

KOEventView is the abstract base class from which all other calendar views for event data are derived. Abstract class from which all event views are derived.

It provides methods for displaying appointments and events on one or more days. The actual number of days that a view actually supports is not defined by this abstract class; that is up to the classes that inherit from it. It also provides methods for updating the display, retrieving the currently selected event (or events), and the like.

Author:
Preston Brown <pbrown@kde.org>
See also:
KOListView, KOAgendaView, KOWeekView, KOMonthView

Definition at line 52 of file koeventview.h.


Constructor & Destructor Documentation

KOEventView::KOEventView Calendar *    cal,
QWidget   parent = 0,
const char *    name = 0
 

Constructs a view.

Parameters:
cal  is a pointer to the calendar object from which events will be retrieved for display.

Definition at line 44 of file koeventview.cpp.

KOEventView::~KOEventView   [virtual]
 

Destructor.

Views will do view-specific cleanups here.

Definition at line 51 of file koeventview.cpp.


Member Function Documentation

virtual int KOEventView::maxDatesHint   [pure virtual]
 

provides a hint back to the caller on the maximum number of dates that the view supports.

A return value of 0 means no maximum.

Implemented in KOAgendaView, and KOListView.

KOEventPopupMenu * KOEventView::eventPopup  
 

Construct a standard context menu for an event.

Definition at line 57 of file koeventview.cpp.

References deleteIncidenceSignal(), editIncidenceSignal(), eventPopup(), and showIncidenceSignal().

Referenced by eventPopup().

QPopupMenu * KOEventView::newEventPopup  
 

Construct a standard context that allows to create a new event.

Definition at line 71 of file koeventview.cpp.

bool KOEventView::isEventView   [inline, virtual]
 

This view is an view for displaying events.

Reimplemented from KOrg::BaseView.

Definition at line 86 of file koeventview.h.

void KOEventView::showIncidencePopup QPopupMenu   popup,
Incidence *    event
[slot]
 

Show context menu for event.

Parameters:
event  event, which is to be manipulated by the menu actions
popup  a popop menu created with eventPopup()

Definition at line 88 of file koeventview.cpp.

References QWidget::event(), QPopupMenu::popup(), and QCursor::pos().

void KOEventView::defaultAction Incidence *    [slot]
 

Perform the default action for an incidence, e.g.

open the event editor, when double-clicking an event in the agenda view.

Definition at line 118 of file koeventview.cpp.

References editIncidenceSignal(), and showIncidenceSignal().

void KOEventView::datesSelected const    DateList [signal]
 

when the view changes the dates that are selected in one way or another, this signal is emitted.

It should be connected back to the

See also:
KDateNavigator object so that it changes appropriately, and any other objects that need to be aware that the list of selected dates has changed.

void KOEventView::showIncidenceSignal Incidence *    [signal]
 

instructs the receiver to show the incidence in read-only mode.

Referenced by defaultAction(), and eventPopup().

void KOEventView::editIncidenceSignal Incidence *    [signal]
 

instructs the receiver to begin editing the incidence specified in some manner.

Doesn't make sense to connect to more than one receiver.

Referenced by defaultAction(), and eventPopup().

void KOEventView::deleteIncidenceSignal Incidence *    [signal]
 

instructs the receiver to delete the Incidence in some manner; some possibilities include automatically, with a confirmation dialog box, etc.

Doesn't make sense to connect to more than one receiver.

Referenced by eventPopup().

void KOEventView::newEventSignal   [signal]
 

instructs the receiver to create a new event.

Doesn't make sense to connect to more than one receiver.

void KOEventView::newEventSignal QDate    [signal]
 

instructs the receiver to create a new event with the specified beginning time.

Doesn't make sense to connect to more than one receiver.

void KOEventView::newEventSignal QDateTime    [signal]
 

instructs the receiver to create a new event with the specified beginning time.

Doesn't make sense to connect to more than one receiver.

void KOEventView::newEventSignal QDateTime   ,
QDateTime   
[signal]
 

instructs the receiver to create a new event, with the specified beginning end ending times.

Doesn't make sense to connect to more than one receiver.

void KOEventView::shiftedEvent const QDate   olddate,
const QDate   newdate
[signal]
 

Emitted when an event is moved using the mouse in an agenda view (week / month).


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for korganizer Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:38:32 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003