EditProfileDialog.h 8.47 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
#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 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 88
     * 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();

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 117
    void insertTabTitleText(const QString& text);
    void insertRemoteTabTitleText(const QString& text);
118

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

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

138 139
    void colorSchemeAnimationUpdate();

140
    // scrolling page
141
    void historyModeChanged(Enum::HistoryModeEnum mode);
142

143
    void historySizeChanged(int);
144 145 146 147 148

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

private:
    QPointer<QTimeLine> _entryTimeLine;

277 278
};

Stephan Binner's avatar
Stephan Binner committed
279
}
280

281
#endif // EDITPROFILEDIALOG_H