• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.11.3 API Reference
  • KDE Home
  • Contact Us
 

Kontact Plugin Interface Library

  • KontactInterface
  • Summary
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
KontactInterface::Summary Class Reference

#include <summary.h>

Inherits QWidget.

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.

Definition at line 41 of file summary.h.

Constructor & Destructor Documentation

Summary::Summary ( QWidget *  parent)
explicit

Creates a new summary widget.

Parameters
parentThe parent widget.

Definition at line 68 of file summary.cpp.

Summary::~Summary ( )
virtual

Destroys the summary widget.

Definition at line 75 of file summary.cpp.

Member Function Documentation

void Summary::configChanged ( )
virtualslot

This method is called whenever the configuration has been changed.

Definition at line 118 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 113 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 85 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 80 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)
virtualslot

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

Parameters
forcetrue if the update was requested by the user

Definition at line 122 of file summary.cpp.


The documentation for this class was generated from the following files:
  • summary.h
  • summary.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:03:07 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Kontact Plugin Interface Library

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

kdepimlibs-4.11.3 API Reference

Skip menu "kdepimlibs-4.11.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal