vcsbaseoutputwindow.h 3.88 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32 33 34 35 36

#ifndef VCSBASEOUTPUTWINDOW_H
#define VCSBASEOUTPUTWINDOW_H

#include "vcsbase_global.h"

#include  <coreplugin/ioutputpane.h>

hjk's avatar
hjk committed
37
namespace VcsBase {
38

hjk's avatar
hjk committed
39
struct VcsBaseOutputWindowPrivate;
40

hjk's avatar
hjk committed
41
class VCSBASE_EXPORT VcsBaseOutputWindow : public Core::IOutputPane
42 43
{
    Q_OBJECT
44
    Q_PROPERTY(QString repository READ repository WRITE setRepository)
hjk's avatar
hjk committed
45

46
public:
hjk's avatar
hjk committed
47
    ~VcsBaseOutputWindow();
48

hjk's avatar
hjk committed
49 50 51
    QWidget *outputWidget(QWidget *parent);
    QList<QWidget *> toolBarWidgets() const;
    QString displayName() const;
52

hjk's avatar
hjk committed
53
    int priorityInStatusBar() const;
54

hjk's avatar
hjk committed
55 56
    void clearContents();
    void visibilityChanged(bool visible);
57

hjk's avatar
hjk committed
58 59 60
    void setFocus();
    bool hasFocus() const;
    bool canFocus() const;
61

hjk's avatar
hjk committed
62 63 64 65 66
    bool canNavigate() const;
    bool canNext() const;
    bool canPrevious() const;
    void goToNext();
    void goToPrev();
67

hjk's avatar
hjk committed
68
    static VcsBaseOutputWindow *instance();
69

70 71
    QString repository() const;

72 73 74 75 76 77 78
    // Helper to consistently format log entries for commands as
    // 'Executing <dir>: <cmd> <args>'. Hides well-known password option
    // arguments.
    static QString msgExecutionLogEntry(const QString &workingDir,
                                        const QString &executable,
                                        const QStringList &arguments);

79
public slots:
80 81 82
    void setRepository(const QString &);
    void clearRepository();

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    // Set the whole text.
    void setText(const QString &text);
    // Set text from QProcess' output data using the Locale's converter.
    void setData(const QByteArray &data);

    // Append text and pop up.
    void append(const QString &text);

    // Silently append text, do not pop up.
    void appendSilently(const QString &text);

    // Append red error text and pop up.
    void appendError(const QString &text);

    // Append dark-yellow warning text and pop up.
    void appendWarning(const QString &text);

    // Append a command, prepended by a log time stamp. "Executing: vcs -diff"
    // will result in "10:00 Executing: vcs -diff" in bold
    void appendCommand(const QString &text);
103 104 105 106 107
    // Append a standard-formatted entry for command execution
    // (see msgExecutionLogEntry).
    void appendCommand(const QString &workingDirectory,
                       const QString &binary,
                       const QStringList &args);
108

Orgad Shaneh's avatar
Orgad Shaneh committed
109 110 111
    // Append a blue message text and pop up.
    void appendMessage(const QString &text);

112
private:
hjk's avatar
hjk committed
113
    VcsBaseOutputWindow();
114

hjk's avatar
hjk committed
115
    VcsBaseOutputWindowPrivate *d;
116 117
};

hjk's avatar
hjk committed
118
} // namespace VcsBase
119 120

#endif // VCSBASEOUTPUTWINDOW_H