Members of the KDE Community are recommended to subscribe to the kde-community mailing list at https://mail.kde.org/mailman/listinfo/kde-community to allow them to participate in important discussions and receive other important announcements

EditProfileDialog.h 8.63 KB
Newer Older
1
/*
2
    Copyright 2007-2008 by Robert Knight <robertknight@gmail.com>
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301  USA.
*/

20 21
#ifndef EDITPROFILEDIALOG_H
#define EDITPROFILEDIALOG_H
22 23

// Qt
24
#include <QAbstractItemDelegate>
Dirk Mueller's avatar
Dirk Mueller committed
25
#include <QtCore/QHash>
26
#include <QtCore/QPointer>
27 28 29 30

// KDE
#include <KDialog>

Jekyll Wu's avatar
Jekyll Wu committed
31
// Konsole
32
#include "Profile.h"
33
#include "Enumeration.h"
34

35
class QAbstractButton;
Robert Knight's avatar
 
Robert Knight committed
36
class QItemSelectionModel;
37
class QTextCodec;
38
class QTimeLine;
39

40 41
namespace Ui
{
Kurt Hindenburg's avatar
Kurt Hindenburg committed
42
class EditProfileDialog;
Stephan Binner's avatar
Stephan Binner committed
43
}
44 45 46 47

namespace Konsole
{
/**
48
 * A dialog which allows the user to edit a profile.
Jekyll Wu's avatar
Jekyll Wu committed
49
 * After the dialog is created, it can be initialized with the settings
Jekyll Wu's avatar
Jekyll Wu committed
50
 * for a profile using setProfile().  When the user makes changes to the
51
 * dialog and accepts the changes, the dialog will update the
Jekyll Wu's avatar
Jekyll Wu committed
52
 * profile in the SessionManager by calling the SessionManager's
53 54 55 56
 * changeProfile() method.
 *
 * Some changes made in the dialog are preview-only changes which cause
 * the SessionManager's changeProfile() method to be called with
57
 * the persistent argument set to false.  These changes are then
58
 * un-done when the dialog is closed.
59
 */
60
class KONSOLEPRIVATE_EXPORT EditProfileDialog : public KDialog
61
{
Kurt Hindenburg's avatar
Kurt Hindenburg committed
62
    Q_OBJECT
63 64 65

public:
    /** Constructs a new dialog with the specified parent. */
66
    explicit EditProfileDialog(QWidget* parent = 0);
67
    virtual ~EditProfileDialog();
68 69

    /**
Jekyll Wu's avatar
Jekyll Wu committed
70
     * Initializes the dialog with the settings for the specified session
71 72
     * type.
     *
73 74 75
     * When the dialog closes, the profile will be updated in the SessionManager
     * with the altered settings.
     *
76
     * @param profile The profile to be edited
77
     */
78
    void setProfile(Profile::Ptr profile);
79

Jekyll Wu's avatar
Jekyll Wu committed
80 81
    /**
     * Selects the text in the profile name edit area.
Robert Knight's avatar
 
Robert Knight committed
82 83 84 85 86
     * When the dialog is being used to create a new profile,
     * this can be used to draw the user's attention to the profile name
     * and make it easy for them to change it.
     */
    void selectProfileName();
87
    const Profile::Ptr lookupProfile() const;
Robert Knight's avatar
 
Robert Knight committed
88

89
public slots:
90
    // reimplemented
91
    virtual void accept();
Jekyll Wu's avatar
Jekyll Wu committed
92
    // reimplemented
93
    virtual void reject();
94

95 96 97
protected:
    virtual bool eventFilter(QObject* watched , QEvent* event);

98
private slots:
99
    // sets up the specified tab page if necessary
Robert Knight's avatar
 
Robert Knight committed
100
    void preparePage(int);
101

102 103 104
    // saves changes to profile
    void save();

105 106
    // general page
    void selectInitialDir();
107 108 109 110
    void selectIcon();

    void profileNameChanged(const QString& text);
    void initialDirChanged(const QString& text);
111
    void startInSameDir(bool);
112 113 114
    void commandChanged(const QString& text);
    void tabTitleFormatChanged(const QString& text);
    void remoteTabTitleFormatChanged(const QString& text);
115

116
    void showTerminalSizeHint(bool);
117
    void saveGeometryOnExit(bool);
118
    void showEnvironmentEditor();
119
    void silenceSecondsChanged(int);
120

121
    // appearance page
122
    void setFontSize(double pointSize);
123
    void setFontInputValue(const QFont&);
124
    void setAntialiasText(bool enable);
125
    void setBoldIntense(bool enable);
126
    void showFontDialog();
127 128 129
    void newColorScheme();
    void editColorScheme();
    void removeColorScheme();
130
    void colorSchemeSelected();
131
    void previewColorScheme(const QModelIndex& index);
132
    void fontSelected(const QFont&);
133
    void toggleMouseWheelZoom(bool enable);
134

135 136
    void colorSchemeAnimationUpdate();

137
    // scrolling page
138
    void historyModeChanged(Enum::HistoryModeEnum mode);
139

140
    void historySizeChanged(int);
141 142 143 144 145

    void hideScrollBar();
    void showScrollBarLeft();
    void showScrollBarRight();

146 147 148 149 150 151
    // keyboard page
    void editKeyBinding();
    void newKeyBinding();
    void keyBindingSelected();
    void removeKeyBinding();

152 153
    // mouse page
    void toggleUnderlineLinks(bool);
154
    void toggleOpenLinksByDirectClick(bool);
155
    void toggleCtrlRequiredForDrag(bool);
156
    void toggleCopyTextToClipboard(bool);
157
    void toggleTrimTrailingSpacesInSelectedText(bool);
158 159 160 161 162 163
    void pasteFromX11Selection();
    void pasteFromClipboard();

    void TripleClickModeChanged(int);
    void wordCharactersChanged(const QString&);

164 165 166
    // advanced page
    void toggleBlinkingText(bool);
    void toggleFlowControl(bool);
167
    void togglebidiRendering(bool);
168
    void lineSpacingChanged(int);
169
    void toggleBlinkingCursor(bool);
170

171 172 173 174
    void setCursorShape(int);
    void autoCursorColor();
    void customCursorColor();
    void customCursorColorChanged(const QColor&);
175
    void setDefaultCodec(QTextCodec*);
176

177 178 179
    // apply the first previewed changes stored up by delayedPreview()
    void delayedPreviewActivate();

180 181
private:
    // initialize various pages of the dialog
Jekyll Wu's avatar
Jekyll Wu committed
182 183 184 185 186 187
    void setupGeneralPage(const Profile::Ptr profile);
    void setupTabsPage(const Profile::Ptr profile);
    void setupAppearancePage(const Profile::Ptr profile);
    void setupKeyboardPage(const Profile::Ptr profile);
    void setupScrollingPage(const Profile::Ptr profile);
    void setupAdvancedPage(const Profile::Ptr profile);
188
    void setupMousePage(const Profile::Ptr info);
189

190
    void updateColorSchemeList(bool selectCurrentScheme = false);
Robert Knight's avatar
 
Robert Knight committed
191
    void updateColorSchemeButtons();
192
    void updateKeyBindingsList(bool selectCurrentTranslator = false);
Robert Knight's avatar
 
Robert Knight committed
193
    void updateKeyBindingsButtons();
194

195
    void showColorSchemeEditor(bool newScheme);
196 197
    void showKeyBindingEditor(bool newTranslator);

Robert Knight's avatar
Robert Knight committed
198
    void preview(int property , const QVariant& value);
199
    void delayedPreview(int property , const QVariant& value);
200
    void unpreview(int property);
201
    void unpreviewAll();
Kurt Hindenburg's avatar
Kurt Hindenburg committed
202
    void enableIfNonEmptySelection(QWidget* widget, QItemSelectionModel* selectionModel);
203

204
    void updateCaption(const Profile::Ptr profile);
Robert Knight's avatar
 
Robert Knight committed
205 206
    void updateTransparencyWarning();

207 208 209 210 211
    // Update _tempProfile in a way of respecting the apply button.
    // When used with some previewed property, this method should
    // always come after the preview operation.
    void updateTempProfileProperty(Profile::Property, const QVariant& value);

212 213 214 215
    // helper method for creating an empty & hidden profile and assigning
    // it to _tempProfile.
    void createTempProfile();

Jekyll Wu's avatar
Jekyll Wu committed
216
    // Enable or disable apply button, used only within
217 218 219
    // updateTempProfileProperty().
    void updateButtonApply();

220 221
    static QString groupProfileNames(const ProfileGroup::Ptr group, int maxLength = -1);

Kurt Hindenburg's avatar
Kurt Hindenburg committed
222 223 224 225
    struct RadioOption {
        QAbstractButton* button;
        int value;
        const char* slot;
Robert Knight's avatar
Robert Knight committed
226
    };
227
    void setupRadio(RadioOption* possibilities, int actual);
Kurt Hindenburg's avatar
Kurt Hindenburg committed
228 229 230 231
    struct BooleanOption {
        QAbstractButton* button;
        Profile::Property property;
        const char* slot;
Robert Knight's avatar
Robert Knight committed
232
    };
233
    void setupCheckBoxes(BooleanOption* options , const Profile::Ptr profile);
234

235
    Ui::EditProfileDialog* _ui;
236
    Profile::Ptr _tempProfile;
237
    Profile::Ptr _profile;
238

239
    // keeps track of pages which need to be updated to match the current
Jekyll Wu's avatar
Jekyll Wu committed
240 241
    // profile.  all elements in this vector are set to true when the
    // profile is changed and individual elements are set to false
242 243
    // after an update by a call to ensurePageLoaded()
    QVector<bool> _pageNeedsUpdate;
Kurt Hindenburg's avatar
Kurt Hindenburg committed
244
    QHash<int, QVariant> _previewedProperties;
245

Robert Knight's avatar
 
Robert Knight committed
246
    QTimeLine* _colorSchemeAnimationTimeLine;
247

Kurt Hindenburg's avatar
Kurt Hindenburg committed
248
    QHash<int, QVariant> _delayedPreviewProperties;
249
    QTimer* _delayedPreviewTimer;
250 251 252 253 254 255 256
};

/**
 * A delegate which can display and edit color schemes in a view.
 */
class ColorSchemeViewDelegate : public QAbstractItemDelegate
{
Kurt Hindenburg's avatar
Kurt Hindenburg committed
257
    Q_OBJECT
258

259
public:
260
    explicit ColorSchemeViewDelegate(QObject* parent = 0);
261 262 263 264

    // reimplemented
    virtual void paint(QPainter* painter, const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;
Kurt Hindenburg's avatar
Kurt Hindenburg committed
265 266
    virtual QSize sizeHint(const QStyleOptionViewItem& option,
                           const QModelIndex& index) const;
267

Jekyll Wu's avatar
Jekyll Wu committed
268
    /**
269 270 271 272
     * Sets the timeline used to control the entry animation
     * for this delegate.
     *
     * During a call to paint(), the value of the timeLine is used to
Jekyll Wu's avatar
Jekyll Wu committed
273
     * determine how to render the item ( with 0 being the beginning
274 275
     * of the animation and 1.0 being the end )
     */
Kurt Hindenburg's avatar
Kurt Hindenburg committed
276
    void setEntryTimeLine(QTimeLine* timeLine);
277 278 279

private:
    QPointer<QTimeLine> _entryTimeLine;
280
};
Stephan Binner's avatar
Stephan Binner committed
281
}
282

283
#endif // EDITPROFILEDIALOG_H