• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

Kontact Plugin Interface Library

  • KontactInterface
  • Summary
Public Slots | Signals | Public Member Functions | Protected Member Functions
KontactInterface::Summary Class Reference

#include <summary.h>

Inherits QWidget.

List of all members.

Public Slots

virtual void configChanged ()
virtual void updateSummary (bool force=false)

Signals

void message (const QString &message)
void summaryWidgetDropped (QWidget *target, QWidget *widget, int alignment)

Public Member Functions

 Summary (QWidget *parent)
virtual ~Summary ()
virtual QStringList configModules () const
QWidget * createHeader (QWidget *parent, const QString &icon, const QString &heading)
virtual int summaryHeight () const

Protected Member Functions

virtual void dragEnterEvent (QDragEnterEvent *)
virtual void dropEvent (QDropEvent *)
virtual void mouseMoveEvent (QMouseEvent *)
virtual void mousePressEvent (QMouseEvent *)

Detailed Description

Base class for summary widgets in Kontact.

This class should be used as base class when creating new summary widgets for the Summary View plugin in Kontact.


Constructor & Destructor Documentation

Summary::Summary ( QWidget *  parent) [explicit]

Creates a new summary widget.

Parameters:
parentThe parent widget.

Definition at line 66 of file summary.cpp.

Summary::~Summary ( ) [virtual]

Destroys the summary widget.

Definition at line 73 of file summary.cpp.


Member Function Documentation

void Summary::configChanged ( ) [virtual, slot]

This method is called whenever the configuration has been changed.

Definition at line 116 of file summary.cpp.

QStringList Summary::configModules ( ) const [virtual]

Returns a list of names identifying configuration modules for this summary widget.

Note:
The names have to be suitable for being passed to KCMultiDialog::addModule().

Definition at line 111 of file summary.cpp.

QWidget * Summary::createHeader ( QWidget *  parent,
const QString &  icon,
const QString &  heading 
)

Creates a heading for a typical summary view with an icon and a heading.

Parameters:
parentThe parent widget.
iconThe name of the icon.
headingThe text of the header.

Definition at line 83 of file summary.cpp.

void KontactInterface::Summary::message ( const QString &  message) [signal]

This signal can be emitted to signaling that an action is going on.

The message will be shown in the status bar.

int Summary::summaryHeight ( ) const [virtual]

Returns the logical height of summary widget.

This is used to calculate how much vertical space relative to other summary widgets this widget will use in the summary view.

Definition at line 78 of file summary.cpp.

void KontactInterface::Summary::summaryWidgetDropped ( QWidget *  target,
QWidget *  widget,
int  alignment 
) [signal]

This signal is emitted whenever a summary widget has been dropped on this summary widget.

void Summary::updateSummary ( bool  force = false) [virtual, slot]

This method is called if the displayed information should be updated.

Parameters:
forcetrue if the update was requested by the user

Definition at line 120 of file summary.cpp.


The documentation for this class was generated from the following files:
  • summary.h
  • summary.cpp

Kontact Plugin Interface Library

Skip menu "Kontact Plugin Interface Library"
  • Main Page
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal