contactdefaultactions.h

/*
    This file is part of Akonadi Contact.
 
    SPDX-FileCopyrightText: 2009 Tobias Koenig <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#pragma once
 
#include "akonadi-contact_export.h"
 
#include <QObject>
 
#include <memory>
 
class QUrl;
 
namespace KContacts
{
class Address;
class PhoneNumber;
}
 
namespace Akonadi
{
class ContactDefaultActionsPrivate;
 
/**
 * @short A convenience class that handles different contact related actions.
 *
 * This class handles contact related actions like opening an email address,
 * showing the address of a contact on a map etc.
 *
 * Example:
 *
 * @code
 *
 * using namespace Akonadi;
 *
 * const Item contact = ...
 *
 * ContactViewer *viewer = new ContactViewer( this );
 * viewer->setContact( contact );
 *
 * ContactDefaultActions *actions = new ContactDefaultActions( this );
 * actions->connectToView( viewer );
 * @endcode
 *
 * If you want to use the full functionality of ContactDefaultActions
 * but customize a single action (e.g. handling sending mail differently)
 * the following can be done:
 *
 * @code
 *
 * using namespace Akonadi;
 *
 * ContactViewer *viewer = new ContactViewer( this );
 * ContactDefaultActions *actions = new ContactDefaultActions( this );
 *
 * // first connect all actions
 * actions->connectToView( viewer );
 *
 * // then remove the signal/slot connection you want to overwrite
 * disconnect( viewer, SIGNAL(emailClicked(QString,QString)),
 *             actions, SLOT(sendEmail(QString,QString)) );
 *
 * // connect to your custom implementation
 * connect( viewer, SIGNAL(emailClicked(QString,QString)),
 *          this, SLOT(handleSpecial(QString,QString)) );
 *
 * @endcode
 *
 * @author Tobias Koenig <[email protected]>
 * @since 4.4
 */
class AKONADI_CONTACT_EXPORT ContactDefaultActions : public QObject
{
    Q_OBJECT
 
public:
    /**
     * Creates a new contact default actions object.
     *
     * @param parent The parent object.
     */
    explicit ContactDefaultActions(QObject *parent = nullptr);
 
    /**
     * Destroys the contact default actions object.
     */
    ~ContactDefaultActions() override;
 
    /**
     * Tries to connect the well known signals of the @p view
     * to the well known slots of this object.
     */
    void connectToView(QObject *view);
 
public Q_SLOTS:
    /**
     * Shows the given @p url in the users preferred webbrowser.
     */
    void showUrl(const QUrl &url);
 
    /**
     * Opens the users preferred mail composer and does the setup
     * to send a mail to the contact with the given @p name and
     * email @p address.
     */
    void sendEmail(const QString &name, const QString &address);
 
    /**
     * Dials the given phone @p number with the application as
     * configured by the user in the general settings dialog.
     */
    void dialPhoneNumber(const KContacts::PhoneNumber &number);
 
    /**
     * Sends a sms to @p number with the application as
     * configured by the user in the general settings dialog.
     */
    void sendSms(const KContacts::PhoneNumber &number);
 
    /**
     * Shows the @p address of a contact in a webbrowser or application
     * as configured by the user in the general settings dialog.
     */
    void showAddress(const KContacts::Address &address);
 
private:
    //@cond PRIVATE
    std::unique_ptr<ContactDefaultActionsPrivate> const d;
    //@endcond PRIVATE
};
}