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 7.99 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
    Copyright (C) 2007 by Robert Knight <robertknight@gmail.com>

    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 26 27
#include <QtGui/QAbstractItemDelegate>
#include <QtCore/QPair>
#include <QtCore/QHash>
#include <QtCore/QSet>
28
#include <QtCore/QPointer>
29 30 31 32

// KDE
#include <KDialog>

33
class QAbstractButton;
34
class QTextCodec;
35
class QTimeLine;
36

37 38
namespace Ui
{
39
    class EditProfileDialog;
Stephan Binner's avatar
Stephan Binner committed
40
}
41 42 43 44

namespace Konsole
{

45
class Profile;
46 47

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

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

    /**
     * Initialises the dialog with the settings for the specified session
     * type.
     *
75 76 77
     * When the dialog closes, the profile will be updated in the SessionManager
     * with the altered settings.
     *
78 79
     * @param key The key for the session type provided by the SessionManager instance
     */
80
    void setProfile(const QString& key);
81

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

90
public slots:
91
    // reimplemented
92
    virtual void accept();
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 112 113 114
    void selectIcon();

    void profileNameChanged(const QString& text);
    void initialDirChanged(const QString& text);
    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 showMenuBar(bool);
120
    void showEnvironmentEditor();
121 122
    void tabBarVisibilityChanged(int);
    void tabBarPositionChanged(int);
123

124
    // appearance page
125 126
    void setFontSize(int pointSize);
    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 previewFont(const QFont&);
134

135 136
    void colorSchemeAnimationUpdate();

137 138 139 140 141 142 143 144 145 146 147
    // scrolling page
    void noScrollBack();
    void fixedScrollBack();
    void unlimitedScrollBack();
   
    void scrollBackLinesChanged(int);

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

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

154 155 156 157
    // advanced page
    void toggleBlinkingText(bool);
    void toggleFlowControl(bool);
    void toggleResizeWindow(bool);
158
    void toggleBlinkingCursor(bool);
159

160 161 162 163 164
    void setCursorShape(int);
    void autoCursorColor();
    void customCursorColor();
    void customCursorColorChanged(const QColor&);
    void wordCharactersChanged(const QString&);
165
    void setDefaultCodec(QTextCodec*);
166

167 168
private:
    // initialize various pages of the dialog
169
    void setupGeneralPage(const Profile* info);
170
    void setupTabsPage(const Profile* info);
171
    void setupAppearancePage(const Profile* info);
172 173 174
    void setupKeyboardPage(const Profile* info);
    void setupScrollingPage(const Profile* info);
    void setupAdvancedPage(const Profile* info);
175

176
    void updateColorSchemeList(bool selectCurrentScheme = false);
177
    void updateKeyBindingsList(bool selectCurrentTranslator = false);
178
    void updateFontPreviewLabel(const QFont& font);
179

180
    void showColorSchemeEditor(bool newScheme);
181 182 183
    void showKeyBindingEditor(bool newTranslator);

    void changeCheckedItem( QAbstractItemModel* mode,  const QModelIndex& to );
184

Robert Knight's avatar
Robert Knight committed
185
    void preview(int property , const QVariant& value);
186
    void unpreview(int property);
187
    void unpreviewAll();
188

Robert Knight's avatar
 
Robert Knight committed
189 190
    void updateCaption(const QString& profileName);

Robert Knight's avatar
Robert Knight committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204
    struct RadioOption
    {
       QAbstractButton* button;
       int property;
       char* slot; 
    };
    void setupRadio(RadioOption* possible,int actual);
    struct ComboOption
    {
       QAbstractButton* button;
       int property;
       char* slot;
    };
    void setupCombo(ComboOption* options , const Profile* profile);
205

206 207
    const Profile* lookupProfile() const;

208
    Ui::EditProfileDialog* _ui;
209
    Profile* _tempProfile;
210
    QString _profileKey;
211

212 213 214 215 216
    // keeps track of pages which need to be updated to match the current
    // profile.  all elements in this vector are set to true when the 
    // profile is changed and individual elements are set to false 
    // after an update by a call to ensurePageLoaded()
    QVector<bool> _pageNeedsUpdate;
217
    QHash<int,QVariant> _previewedProperties;
Robert Knight's avatar
 
Robert Knight committed
218 219

    QTimeLine* _colorSchemeAnimationTimeLine;
220 221 222 223 224 225 226
};

/**
 * A delegate which can display and edit color schemes in a view.
 */
class ColorSchemeViewDelegate : public QAbstractItemDelegate
{
227 228
Q_OBJECT

229 230 231 232 233 234 235 236 237
public:
    ColorSchemeViewDelegate(QObject* parent = 0);

    // reimplemented
    virtual void paint(QPainter* painter, const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;
    virtual QSize sizeHint( const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;

238 239 240 241 242 243 244 245 246 247 248 249 250
    /** 
     * 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
     * determine how to render the item ( with 0 being the beginning 
     * of the animation and 1.0 being the end )
     */
    void setEntryTimeLine( QTimeLine* timeLine );

private:
    QPointer<QTimeLine> _entryTimeLine;

251 252
   // virtual QWidget* createEditor(QWidget* parent, const QStyleOptionViewItem& option, 
   //                               const QModelIndex& index) const;
253 254
   // virtual bool editorEvent(QEvent* event,QAbstractItemModel* model,
   //                          const QStyleOptionViewItem& option, const QModelIndex& index);
255

256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
};

/**
 * A delegate which can display and edit key bindings in a view.
 */
class KeyBindingViewDelegate : public QAbstractItemDelegate
{
public:
    KeyBindingViewDelegate(QObject* parent = 0);

    // reimplemented
    virtual void paint(QPainter* painter, const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;
    virtual QSize sizeHint( const QStyleOptionViewItem& option,
                       const QModelIndex& index) const;

};

Stephan Binner's avatar
Stephan Binner committed
274
}
275

276
#endif // EDITPROFILEDIALOG_H