libkf5mailcommon-dev 4:16.04.2-2 / usr / include / KF5 / mailcommon / snippetsmanager.h

/*
  Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
    Author Tobias Koenig <tokoe@kdab.com>

  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 MAILCOMMON_SNIPPETSMANAGER_H
#define MAILCOMMON_SNIPPETSMANAGER_H

#include "mailcommon_export.h"

#include <QObject>

class KActionCollection;

class QAbstractItemModel;
class QAction;
class QItemSelectionModel;

namespace MailCommon
{

class MAILCOMMON_EXPORT SnippetsManager : public QObject
{
    Q_OBJECT

    Q_PROPERTY(QAbstractItemModel *model READ model)
    Q_PROPERTY(QItemSelectionModel *selectionModel READ selectionModel)
    Q_PROPERTY(QAction *addSnippetAction READ addSnippetAction)
    Q_PROPERTY(QAction *editSnippetAction READ editSnippetAction)
    Q_PROPERTY(QAction *deleteSnippetAction READ deleteSnippetAction)
    Q_PROPERTY(QAction *addSnippetGroupAction READ addSnippetGroupAction)
    Q_PROPERTY(QAction *editSnippetGroupAction READ editSnippetGroupAction)
    Q_PROPERTY(QAction *deleteSnippetGroupAction READ deleteSnippetGroupAction)
    Q_PROPERTY(QAction *insertSnippetAction READ insertSnippetAction)

    Q_PROPERTY(bool snippetGroupSelected READ snippetGroupSelected)
    Q_PROPERTY(QString selectedName READ selectedName)

public:
    /**
     * Creates a new snippets manager.
     *
     * @param actionCollection The action collection where the manager will
     *                         register the snippet shortcuts at.
     * @param parent The parent object.
     */
    explicit SnippetsManager(KActionCollection *actionCollection,
                             QObject *parent = Q_NULLPTR, QWidget *widget = Q_NULLPTR);

    /**
     * Destroys the snippets manager.
     */
    ~SnippetsManager();

    /**
     * Sets the editor object the snippet manager will act on.
     *
     * @param editor The editor object
     * @param insertSnippetMethod The name of the method will be executed to
     *                            insert a snippet into the editor. This method
     *                            must provide a single QString parameter.
     * @param dropSignal The signature of the signal that is emitted by the editor
     *                   object when a snippet has been dropped on it.
     *
     * Example usage:
     *
     * @code
     *
     *  KMComposerEditor *editor = ...
     *
     *  snippetsManager->setEditor( editor, "insertPlainText", SIGNAL( insertSnippet() ) );
     *
     * @endcode
     */
    void setEditor(QObject *editor, const char *insertSnippetMethod, const char *dropSignal);

    /**
     * Returns the model that represents the snippets.
     */
    QAbstractItemModel *model() const;

    /**
     * Returns the selection model that is used by the manager to select the
     * snippet or snippet group to work on.
     */
    QItemSelectionModel *selectionModel() const;

    /**
     * Returns the action that handles adding new snippets.
     */
    QAction *addSnippetAction() const;

    /**
     * Returns the action that handles editing the currently selected snippet.
     */
    QAction *editSnippetAction() const;

    /**
     * Returns the action that handles deleting the currently selected snippet.
     */
    QAction *deleteSnippetAction() const;

    /**
     * Returns the action that handles adding new snippet groups.
     */
    QAction *addSnippetGroupAction() const;

    /**
     * Returns the action that handles editing the currently selected snippet group.
     */
    QAction *editSnippetGroupAction() const;

    /**
     * Returns the action that handles deleting the currently selected snippet group.
     */
    QAction *deleteSnippetGroupAction() const;

    /**
     * Returns the action that handles inserting a snippet into the editor.
     */
    QAction *insertSnippetAction() const;

    /**
     * Returns whether the currently selected item is a snippet group.
     */
    bool snippetGroupSelected() const;

    /**
     * Returns the name of the currently selected snippet or snippet group.
     */
    QString selectedName() const;

private:
    //@cond PRIVATE
    class Private;
    Private *const d;

    Q_PRIVATE_SLOT(d, void selectionChanged())
    Q_PRIVATE_SLOT(d, void addSnippet())
    Q_PRIVATE_SLOT(d, void editSnippet())
    Q_PRIVATE_SLOT(d, void deleteSnippet())
    Q_PRIVATE_SLOT(d, void addSnippetGroup())
    Q_PRIVATE_SLOT(d, void editSnippetGroup())
    Q_PRIVATE_SLOT(d, void deleteSnippetGroup())
    Q_PRIVATE_SLOT(d, void insertSelectedSnippet())
    Q_PRIVATE_SLOT(d, void insertActionSnippet())
    Q_PRIVATE_SLOT(d, void dndDone())
    Q_PRIVATE_SLOT(d, void slotAddNewDndSnippset(QString))
    //@endcond
};

}

#endif