kde-playground/kdepimlibs/akonadi/contact/contactviewerdialog.h
2015-04-14 21:49:29 +00:00

107 lines
2.3 KiB
C++

/*
This file is part of Akonadi Contact.
Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_CONTACTVIEWERDIALOG_H
#define AKONADI_CONTACTVIEWERDIALOG_H
#include "akonadi-contact_export.h"
#include <kdialog.h>
class QUrl;
namespace KABC {
class Address;
class PhoneNumber;
}
namespace Akonadi {
class Item;
class ContactViewer;
/**
* @short A dialog for displaying a contact in Akonadi.
*
* This dialog provides a way to show a contact from the
* Akonadi storage.
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* const Item contact = ...
*
* ContactViewerDialog *dlg = new ContactViewerDialog( this );
* dlg->setContact( contact );
* dlg->show();
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.4
*/
class AKONADI_CONTACT_EXPORT ContactViewerDialog : public KDialog
{
Q_OBJECT
public:
/**
* Creates a new contact viewer dialog.
*
* @param parent The parent widget of the dialog.
*/
explicit ContactViewerDialog( QWidget *parent = 0 );
/**
* Destroys the contact viewer dialog.
*/
~ContactViewerDialog();
/**
* Returns the contact that is currently displayed.
*/
Akonadi::Item contact() const;
/**
* Returns the ContactViewer that is used by this dialog.
*/
ContactViewer *viewer() const;
public Q_SLOTS:
/**
* Sets the @p contact that shall be displayed in the dialog.
*/
void setContact( const Akonadi::Item &contact );
private:
//@cond PRIVATE
class Private;
Private* const d;
//@endcond
};
}
#endif