apps/konsole/src/ViewProperties.h

   1 /*
   2     Copyright (C) 2007 by Robert Knight <robertknight@gmail.com>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  17     02110-1301  USA.
  18 */
  19
  20 #ifndef VIEWPROPERTIES_H
  21 #define VIEWPROPERTIES_H
  22
  23 // Qt
  24 #include <QtGui/QIcon>
  25 #include <QtCore/QObject>
  26
  27 // KDE
  28 #include <KUrl>
  29
  30 namespace Konsole
  31 {
  32
  33 /**
  34  * Encapsulates user-visible information about the terminal session currently being displayed in a view,
  35  * such as the associated title and icon.
  36  *
  37  * This can be used by navigation widgets in a ViewContainer sub-class to provide a tab, label or other
  38  * item for switching between views.
  39  */
  40 class ViewProperties : public QObject
  41 {
  42 Q_OBJECT
  43
  44 public:
  45     ViewProperties(QObject* parent);
  46
  47     /** Returns the icon associated with a view */
  48     QIcon icon() const;
  49     /** Returns the title associated with a view */
  50     QString title() const;
  51
  52     /**
  53      * Returns the URL current associated with a view.
  54      * The default implementation returns an empty URL.
  55      */
  56     virtual KUrl url() const;
  57
  58     /**
  59      * Returns the current directory associated with a view.
  60      * This may be the same as url()
  61      *
  62      * The default implementation returns an empty string.
  63      */
  64     virtual QString currentDir() const;
  65
  66     /**
  67      * A unique identifier representing the data displayed by the view associated with this
  68      * ViewProperties instance.
  69      *
  70      * TODO: Finish implementation and documentation
  71      *
  72      * This can be used when dragging and dropping views between windows so that [ FINISH ME ]
  73      */
  74     int identifier() const;
  75
  76 signals:
  77     /** Emitted when the icon for a view changes */
  78     void iconChanged(ViewProperties* properties);
  79     /** Emitted when the title for a view changes */
  80     void titleChanged(ViewProperties* properties);
  81     /** Emitted when activity has occurred in this view. */
  82     void activity(ViewProperties* item);
  83
  84 public slots:
  85     /**
  86      * Requests the renaming of this view.
  87      *
  88      * The default implementation does nothing.
  89      */
  90      virtual void rename();
  91
  92 protected slots:
  93     /**
  94      * Emits the activity() signal.
  95      */
  96     void fireActivity();
  97
  98 protected:
  99     /**
 100      * Subclasses may call this method to change the title.  This causes
 101      * a titleChanged() signal to be emitted
 102      */
 103     void setTitle(const QString& title);
 104     /**
 105      * Subclasses may call this method to change the icon.  This causes
 106      * an iconChanged() signal to be emitted
 107      */
 108     void setIcon(const QIcon& icon);
 109     /**
 110      * Subclasses may call this method to change the identifier.
 111      */
 112     void setIdentifier(int id);
 113
 114
 115 private:
 116     QIcon _icon;
 117     QString _title;
 118     int _id;
 119 };
 120
 121 }
 122
 123 #endif //VIEWPROPERTIES_H