ViewManager.h

Go to the documentation of this file.

/*
    Copyright 2006-2008 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.
*/

#ifndef VIEWMANAGER_H
#define VIEWMANAGER_H

// Qt
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QPointer>

// Konsole
#include "Profile.h"
#include "ViewContainer.h"

class QSignalMapper;
class KActionCollection;
class KConfigGroup;

namespace Konsole
{
class ColorScheme;
class IncrementalSearchBar;
class Session;
class TerminalDisplay;

class SessionController;
class ViewProperties;
class ViewSplitter;

class KONSOLEPRIVATE_EXPORT ViewManager : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.konsole.Window")

public:
    ViewManager(QObject* parent , KActionCollection* collection);
    ~ViewManager();

    void createView(Session* session);

    void applyProfileToView(TerminalDisplay* view , const Profile::Ptr profile);

    QWidget* widget() const;

    QWidget* activeView() const;

    QList<ViewProperties*> viewProperties() const;

    enum NavigationMethod {
        TabbedNavigation,
        NoNavigation
    };

    enum NewTabBehavior {
        PutNewTabAtTheEnd = 0,
        PutNewTabAfterCurrentTab = 1
    };

    void setNavigationMethod(NavigationMethod method);

    NavigationMethod navigationMethod() const;

    SessionController* activeViewController() const;

    IncrementalSearchBar* searchBar() const;

    void saveSessions(KConfigGroup& group);
    void restoreSessions(const KConfigGroup& group);

    void setNavigationVisibility(int visibility);
    void setNavigationPosition(int position);
    void setNavigationBehavior(int behavior);
    void setNavigationStyleSheet(const QString& styleSheet);
    void setShowQuickButtons(bool show);

    int managerId() const;

    QList<Session*> sessions() { return _sessionMap.values(); }

signals:
    void empty();

    void viewDetached(Session* session);

    void activeViewChanged(SessionController* controller);

    void unplugController(SessionController* controller);

    void viewPropertiesChanged(const QList<ViewProperties*>& propertiesList);

    void splitViewToggle(bool multipleViews);

    void setMenuBarVisibleRequest(bool);
    void updateWindowIcon();

    void newViewRequest();
    void newViewRequest(Profile::Ptr);

public slots:
    Q_SCRIPTABLE int sessionCount();

    Q_SCRIPTABLE int currentSession();

    Q_SCRIPTABLE int newSession(QString profile, QString directory);

    // TODO: its semantic is application-wide. Move it to more appropriate place
    // DBus slot that returns the name of default profile
    Q_SCRIPTABLE QString defaultProfile();

    // TODO: its semantic is application-wide. Move it to more appropriate place
    // DBus slot that returns a string list of defined (known) profiles
    Q_SCRIPTABLE QStringList profileList();

    Q_SCRIPTABLE int newSession();

    Q_SCRIPTABLE void nextSession();

    Q_SCRIPTABLE void prevSession();

    Q_SCRIPTABLE void moveSessionLeft();

    Q_SCRIPTABLE void moveSessionRight();

    Q_SCRIPTABLE void setTabWidthToText(bool);

private slots:
    // called when the "Split View Left/Right" menu item is selected
    void splitLeftRight();
    void splitTopBottom();
    void closeActiveContainer();
    void closeOtherContainers();
    void expandActiveContainer();
    void shrinkActiveContainer();

    // called when the "Detach View" menu item is selected
    void detachActiveView();
    void updateDetachViewState();

    // called when a session terminates - the view manager will delete any
    // views associated with the session
    void sessionFinished();
    // called when one view has been destroyed
    void viewDestroyed(QWidget* widget);

    // controller detects when an associated view is given the focus
    // and emits a signal.  ViewManager listens for that signal
    // and then plugs the action into the UI
    //void viewFocused( SessionController* controller );

    // called when the active view in a ViewContainer changes, so
    // that we can plug the appropriate actions into the UI
    void viewActivated(QWidget* view);

    // called when "Next View" shortcut is activated
    void nextView();

    // called when "Previous View" shortcut is activated
    void previousView();

    // called when "Switch to last tab" shortcut is activated
    void lastView();

    // called when "Next View Container" shortcut is activated
    void nextContainer();

    // called when the views in a container owned by this view manager
    // changes
    void containerViewsChanged(QObject* container);

    // called when a profile changes
    void profileChanged(Profile::Ptr profile);

    void updateViewsForSession(Session* session);

    // moves active view to the left
    void moveActiveViewLeft();
    // moves active view to the right
    void moveActiveViewRight();
    // switches to the view at visual position 'index'
    // in the current container
    void switchToView(int index);

    // called when a SessionController gains focus
    void controllerChanged(SessionController* controller);

    // called when a ViewContainer requests a view be
    // moved
    void containerMoveViewRequest(int index, int id, bool& success, TabbedViewContainer* sourceTabbedContainer);

    void detachView(ViewContainer* container, QWidget* view);

    void closeTabFromContainer(ViewContainer* container, QWidget* view);

private:
    void createView(Session* session, ViewContainer* container, int index);
    static const ColorScheme* colorSchemeForProfile(const Profile::Ptr profile);

    void setupActions();
    void focusActiveView();

    // takes a view from a view container owned by a different manager and places it in
    // newContainer owned by this manager
    void takeView(ViewManager* otherManager , ViewContainer* otherContainer, ViewContainer* newContainer, TerminalDisplay* view);
    void splitView(Qt::Orientation orientation);

    // creates a new container which can hold terminal displays
    ViewContainer* createContainer();
    // removes a container and emits appropriate signals
    void removeContainer(ViewContainer* container);

    // creates a new terminal display
    // the 'session' is used so that the terminal display's random seed
    // can be set to something which depends uniquely on that session
    TerminalDisplay* createTerminalDisplay(Session* session = 0);

    // creates a new controller for a session/display pair which provides the menu
    // actions associated with that view, and exposes basic information
    // about the session ( such as title and associated icon ) to the display.
    SessionController* createController(Session* session , TerminalDisplay* display);

private:
    QPointer<ViewSplitter>          _viewSplitter;
    QPointer<SessionController>     _pluggedController;

    QHash<TerminalDisplay*, Session*> _sessionMap;

    KActionCollection*                  _actionCollection;
    QSignalMapper*                      _containerSignalMapper;

    NavigationMethod  _navigationMethod;

    ViewContainer::NavigationVisibility _navigationVisibility;
    ViewContainer::NavigationPosition _navigationPosition;
    bool _showQuickButtons;
    NewTabBehavior _newTabBehavior;
    QString _navigationStyleSheet;

    int _managerId;
    static int lastManagerId;
};
}

#endif