EditProfileDialog.h 8.44 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
#include "ColorScheme.h"
#include "ColorSchemeEditor.h"
36

37
class QAbstractButton;
Robert Knight's avatar
 
Robert Knight committed
38
class QItemSelectionModel;
39
class QTextCodec;
40

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

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

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

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

Jekyll Wu's avatar
Jekyll Wu committed
81 82
    /**
     * Selects the text in the profile name edit area.
Robert Knight's avatar
 
Robert Knight committed
83 84 85 86 87
     * 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();
88
    const Profile::Ptr lookupProfile() const;
Robert Knight's avatar
 
Robert Knight committed
89

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

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

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

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

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

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

117 118
    void terminalColumnsEntryChanged(int);
    void terminalRowsEntryChanged(int);
119
    void showTerminalSizeHint(bool);
120
    void showEnvironmentEditor();
121
    void silenceSecondsChanged(int);
122

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

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

141
    void historySizeChanged(int);
142 143 144 145

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

147 148
    void scrollFullPage();
    void scrollHalfPage();
149

150 151 152 153 154 155
    // keyboard page
    void editKeyBinding();
    void newKeyBinding();
    void keyBindingSelected();
    void removeKeyBinding();

156 157
    // mouse page
    void toggleUnderlineLinks(bool);
158
    void toggleOpenLinksByDirectClick(bool);
159
    void toggleCtrlRequiredForDrag(bool);
160
    void toggleCopyTextToClipboard(bool);
161
    void toggleTrimTrailingSpacesInSelectedText(bool);
162 163 164 165 166 167
    void pasteFromX11Selection();
    void pasteFromClipboard();

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

168 169 170
    // advanced page
    void toggleBlinkingText(bool);
    void toggleFlowControl(bool);
171
    void togglebidiRendering(bool);
172
    void lineSpacingChanged(int);
173
    void toggleBlinkingCursor(bool);
174

175 176 177 178
    void setCursorShape(int);
    void autoCursorColor();
    void customCursorColor();
    void customCursorColorChanged(const QColor&);
179
    void setDefaultCodec(QTextCodec*);
180

181 182 183
    // apply the first previewed changes stored up by delayedPreview()
    void delayedPreviewActivate();

184 185
private:
    // initialize various pages of the dialog
Jekyll Wu's avatar
Jekyll Wu committed
186 187 188 189 190 191
    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);
192
    void setupMousePage(const Profile::Ptr info);
193

194
    void updateColorSchemeList(bool selectCurrentScheme = false);
Robert Knight's avatar
 
Robert Knight committed
195
    void updateColorSchemeButtons();
196
    void updateKeyBindingsList(bool selectCurrentTranslator = false);
Robert Knight's avatar
 
Robert Knight committed
197
    void updateKeyBindingsButtons();
198

199
    void showColorSchemeEditor(bool isNewScheme);
200
    void closeColorSchemeEditor();
201 202
    void showKeyBindingEditor(bool newTranslator);

Robert Knight's avatar
Robert Knight committed
203
    void preview(int property , const QVariant& value);
204
    void delayedPreview(int property , const QVariant& value);
205
    void unpreview(int property);
206
    void unpreviewAll();
Kurt Hindenburg's avatar
Kurt Hindenburg committed
207
    void enableIfNonEmptySelection(QWidget* widget, QItemSelectionModel* selectionModel);
208

209
    void updateCaption(const Profile::Ptr profile);
Robert Knight's avatar
 
Robert Knight committed
210 211
    void updateTransparencyWarning();

212 213 214 215 216
    // 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);

217 218 219 220
    // helper method for creating an empty & hidden profile and assigning
    // it to _tempProfile.
    void createTempProfile();

Jekyll Wu's avatar
Jekyll Wu committed
221
    // Enable or disable apply button, used only within
222 223 224
    // updateTempProfileProperty().
    void updateButtonApply();

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

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

240
    Ui::EditProfileDialog* _ui;
241
    Profile::Ptr _tempProfile;
242
    Profile::Ptr _profile;
243

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

Kurt Hindenburg's avatar
Kurt Hindenburg committed
251
    QHash<int, QVariant> _delayedPreviewProperties;
252
    QTimer* _delayedPreviewTimer;
253 254

    ColorSchemeEditor* _colorDialog;
255 256 257 258 259 260 261
};

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

264
public:
265
    explicit ColorSchemeViewDelegate(QObject* parent = 0);
266 267 268 269

    // reimplemented
    virtual void paint(QPainter* painter, const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;
Kurt Hindenburg's avatar
Kurt Hindenburg committed
270 271
    virtual QSize sizeHint(const QStyleOptionViewItem& option,
                           const QModelIndex& index) const;
272
};
Stephan Binner's avatar
Stephan Binner committed
273
}
274

275
#endif // EDITPROFILEDIALOG_H