qt-creator/src/plugins/diffeditor/diffeditor.h

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef DIFFEDITOR_H
#define DIFFEDITOR_H

#include "diffeditor_global.h"
#include "diffeditorcontroller.h"

#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/idocument.h>

QT_BEGIN_NAMESPACE
class QComboBox;
class QToolBar;
class QToolButton;
class QStackedWidget;
QT_END_NAMESPACE

namespace TextEditor { class TextEditorWidget; }

namespace DiffEditor {

namespace Internal {
class DescriptionEditorWidget;
class DiffEditorDocument;
} // namespace Internal

class DiffEditorGuiController;
class SideBySideDiffEditorWidget;
class UnifiedDiffEditorWidget;

class DIFFEDITOR_EXPORT DiffEditor : public Core::IEditor
{
    Q_OBJECT

public:
    DiffEditor(const QSharedPointer<Internal::DiffEditorDocument> &doc);
    ~DiffEditor();

public:
    DiffEditorController *controller() const;

    Core::IEditor *duplicate();

    bool open(QString *errorString,
              const QString &fileName,
              const QString &realFileName);
    Core::IDocument *document();

    QWidget *toolBar();

public slots:
    void activateEntry(int index);

private slots:
    void slotCleared(const QString &message);
    void slotDiffFilesChanged(const QList<FileData> &diffFileList,
                              const QString &workingDirectory);
    void entryActivated(int index);
    void slotDescriptionChanged(const QString &description);
    void slotDescriptionVisibilityChanged();
    void slotReloaderChanged();
    void slotDiffEditorSwitched();

private:
    void updateEntryToolTip();
    void showDiffEditor(QWidget *newEditor);
    void updateDiffEditorSwitcher();
    QWidget *readLegacyCurrentDiffEditorSetting();
    QWidget *readCurrentDiffEditorSetting();
    void writeCurrentDiffEditorSetting(QWidget *currentEditor);

    QSharedPointer<Internal::DiffEditorDocument> m_document;
    Internal::DescriptionEditorWidget *m_descriptionWidget;
    QStackedWidget *m_stackedWidget;
    SideBySideDiffEditorWidget *m_sideBySideEditor;
    UnifiedDiffEditorWidget *m_unifiedEditor;
    QWidget *m_currentEditor;
    DiffEditorGuiController *m_guiController;
    QToolBar *m_toolBar;
    QComboBox *m_entriesComboBox;
    QAction *m_whitespaceButtonAction;
    QAction *m_contextLabelAction;
    QAction *m_contextSpinBoxAction;
    QAction *m_toggleDescriptionAction;
    QAction *m_reloadAction;
    QToolButton *m_diffEditorSwitcher;
};

} // namespace DiffEditor

#endif // DIFFEDITOR_H