EditProfileDialog.h 8.46 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
Dirk Mueller's avatar
Dirk Mueller committed
24 25
#include <QtGui/QAbstractItemDelegate>
#include <QtCore/QHash>
26
#include <QtCore/QPointer>
27 28 29 30

// KDE
#include <KDialog>

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

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

39 40
namespace Ui
{
Kurt Hindenburg's avatar
Kurt Hindenburg committed
41
class EditProfileDialog;
Stephan Binner's avatar
Stephan Binner committed
42
}
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 67
    EditProfileDialog(QWidget* parent = 0);
    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 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
public slots:
89
    // reimplemented
90
    virtual void accept();
Jekyll Wu's avatar
Jekyll Wu committed
91
    // reimplemented
92
    virtual void reject();
93

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

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

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

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

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

115 116
    void insertTabTitleText(const QString& text);
    void insertRemoteTabTitleText(const QString& text);
117

118
    void showTerminalSizeHint(bool);
119
    void saveGeometryOnExit(bool);
120
    void showEnvironmentEditor();
121
    void silenceSecondsChanged(int);
122

123
    // appearance page
124
    void setFontSize(int pointSize);
125 126
    void setFontSliderRange(const QFont&);
    void setFontSliderValue(const QFont&);
127
    void setAntialiasText(bool enable);
128
    void setBoldIntense(bool enable);
129
    void showFontDialog();
130 131 132
    void newColorScheme();
    void editColorScheme();
    void removeColorScheme();
133
    void colorSchemeSelected();
134
    void previewColorScheme(const QModelIndex& index);
135
    void fontSelected(const QFont&);
136

137 138
    void colorSchemeAnimationUpdate();

139 140 141 142
    // scrolling page
    void noScrollBack();
    void fixedScrollBack();
    void unlimitedScrollBack();
143

144 145 146 147 148 149
    void scrollBackLinesChanged(int);

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

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

156 157 158
    // advanced page
    void toggleBlinkingText(bool);
    void toggleFlowControl(bool);
159
    void togglebidiRendering(bool);
160
    void toggleBlinkingCursor(bool);
161
    void TripleClickModeChanged(int);
162
    void toggleUnderlineLinks(bool);
163

164 165 166 167 168
    void setCursorShape(int);
    void autoCursorColor();
    void customCursorColor();
    void customCursorColorChanged(const QColor&);
    void wordCharactersChanged(const QString&);
169
    void setDefaultCodec(QTextCodec*);
170

171 172 173
    // apply the first previewed changes stored up by delayedPreview()
    void delayedPreviewActivate();

174 175
private:
    // initialize various pages of the dialog
Jekyll Wu's avatar
Jekyll Wu committed
176 177 178 179 180 181
    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);
182

183
    void updateColorSchemeList(bool selectCurrentScheme = false);
Robert Knight's avatar
 
Robert Knight committed
184
    void updateColorSchemeButtons();
185
    void updateKeyBindingsList(bool selectCurrentTranslator = false);
Robert Knight's avatar
 
Robert Knight committed
186
    void updateKeyBindingsButtons();
187

188
    void showColorSchemeEditor(bool newScheme);
189 190
    void showKeyBindingEditor(bool newTranslator);

Kurt Hindenburg's avatar
Kurt Hindenburg committed
191
    void changeCheckedItem(QAbstractItemModel* mode,  const QModelIndex& to);
192

Robert Knight's avatar
Robert Knight committed
193
    void preview(int property , const QVariant& value);
194
    void delayedPreview(int property , const QVariant& value);
195
    void unpreview(int property);
196
    void unpreviewAll();
Kurt Hindenburg's avatar
Kurt Hindenburg committed
197
    void enableIfNonEmptySelection(QWidget* widget, QItemSelectionModel* selectionModel);
198

199
    void updateCaption(const Profile::Ptr profile);
Robert Knight's avatar
 
Robert Knight committed
200 201
    void updateTransparencyWarning();

202 203 204 205 206
    // 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);

207 208 209 210
    // helper method for creating an empty & hidden profile and assigning
    // it to _tempProfile.
    void createTempProfile();

Jekyll Wu's avatar
Jekyll Wu committed
211
    // Enable or disable apply button, used only within
212 213 214
    // updateTempProfileProperty().
    void updateButtonApply();

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

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

230
    const Profile::Ptr lookupProfile() const;
231

232
    Ui::EditProfileDialog* _ui;
233
    Profile::Ptr _tempProfile;
234
    Profile::Ptr _profile;
235

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

Robert Knight's avatar
 
Robert Knight committed
243
    QTimeLine* _colorSchemeAnimationTimeLine;
244

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

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

256 257 258 259 260 261
public:
    ColorSchemeViewDelegate(QObject* parent = 0);

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

Jekyll Wu's avatar
Jekyll Wu committed
265
    /**
266 267 268 269
     * 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
270
     * determine how to render the item ( with 0 being the beginning
271 272
     * of the animation and 1.0 being the end )
     */
Kurt Hindenburg's avatar
Kurt Hindenburg committed
273
    void setEntryTimeLine(QTimeLine* timeLine);
274 275 276 277

private:
    QPointer<QTimeLine> _entryTimeLine;

278 279
};

Stephan Binner's avatar
Stephan Binner committed
280
}
281

282
#endif // EDITPROFILEDIALOG_H