ViewContainer.h

Go to the documentation of this file.

/*
    This file is part of the Konsole Terminal.

    Copyright 2006-2008 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 VIEWCONTAINER_H
#define VIEWCONTAINER_H

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

// Konsole
#include "Profile.h"

class QStackedWidget;
class QWidget;
class QHBoxLayout;
class QVBoxLayout;

// TabbedViewContainer
// Qt
class QPoint;
class QToolButton;
class QMenu;
class QDropEvent;

// KDE
class KMenu;

namespace Konsole
{
class IncrementalSearchBar;
class ViewProperties;
class TabbedViewContainer;
class ViewContainer : public QObject
{
    Q_OBJECT

public:
    enum NavigationPosition {
        NavigationPositionTop,
        NavigationPositionBottom,
        NavigationPositionLeft,
        NavigationPositionRight
    };

    ViewContainer(NavigationPosition position , QObject* parent);

    virtual ~ViewContainer();

    virtual QWidget* containerWidget() const = 0;

    enum NavigationVisibility {
        AlwaysShowNavigation,
        ShowNavigationAsNeeded,
        AlwaysHideNavigation
    };
    /*
     * Sets the visibility of the view container's navigation widget.
     *
     * The ViewContainer sub-class is responsible for ensuring that this
     * setting is respected as views are added or removed from the
     * container.
     *
     * ViewContainer sub-classes should reimplement the
     * navigationVisibilityChanged() method to respond to changes
     * of this property.
     */
    void setNavigationVisibility(NavigationVisibility mode);
    NavigationVisibility navigationVisibility() const;

    void setNavigationPosition(NavigationPosition position);

    NavigationPosition navigationPosition() const;

    virtual QList<NavigationPosition> supportedNavigationPositions() const;

    void setNavigationTextMode(bool mode);

    virtual void setStyleSheet(const QString& styleSheet) {
        Q_UNUSED(styleSheet);
    }

    void addView(QWidget* view , ViewProperties* navigationItem, int index = -1);

    void removeView(QWidget* view);

    ViewProperties* viewProperties(QWidget* view) const;

    const QList<QWidget*> views() const;

    virtual QWidget* activeView() const = 0;

    virtual void setActiveView(QWidget* widget) = 0;

    IncrementalSearchBar* searchBar();

    void activateNextView();

    void activatePreviousView();

    void activateLastView();

    enum MoveDirection {
        MoveViewLeft,
        MoveViewRight
    };

    void moveActiveView(MoveDirection direction);

    enum Feature {
        QuickNewView = 1,
        QuickCloseView = 2
    };
    Q_DECLARE_FLAGS(Features, Feature)
    virtual void setFeatures(Features features);
    Features features() const;
    virtual Features supportedFeatures() const {
        return 0;
    }
    virtual void setNewViewMenu(QMenu* menu) {
        Q_UNUSED(menu);
    }

signals:
    void destroyed(ViewContainer* container);

    void empty(ViewContainer* container);

    void newViewRequest();

    void newViewRequest(Profile::Ptr);

    void moveViewRequest(int index, int id, bool& success, TabbedViewContainer* sourceContainer);

    void activeViewChanged(QWidget* view);

    void viewAdded(QWidget* view , ViewProperties* properties);

    void viewRemoved(QWidget* view);

protected:
    virtual void addViewWidget(QWidget* view, int index) = 0;
    virtual void removeViewWidget(QWidget* view) = 0;

    virtual void navigationVisibilityChanged(NavigationVisibility) {}

    virtual void navigationPositionChanged(NavigationPosition) {}

    virtual void navigationTextModeChanged(bool) {}

    QList<QWidget*> widgetsForItem(ViewProperties* item) const;

    virtual void moveViewWidget(int fromIndex , int toIndex);

private slots:
    void viewDestroyed(QObject* view);
    void searchBarDestroyed();

private:
    NavigationVisibility _navigationVisibility;
    NavigationPosition _navigationPosition;
    QList<QWidget*> _views;
    QHash<QWidget*, ViewProperties*> _navigation;
    Features _features;
    IncrementalSearchBar* _searchBar;
};
Q_DECLARE_OPERATORS_FOR_FLAGS(ViewContainer::Features)

class ViewContainerTabBar;
class ViewManager;

class TabbedViewContainer : public ViewContainer
{
    Q_OBJECT

public:
    TabbedViewContainer(NavigationPosition position, ViewManager* connectedViewManager, QObject* parent);
    virtual ~TabbedViewContainer();

    virtual QWidget* containerWidget() const;
    virtual QWidget* activeView() const;
    virtual void setActiveView(QWidget* view);
    virtual QList<NavigationPosition> supportedNavigationPositions() const;
    virtual void setFeatures(Features features);
    virtual Features supportedFeatures() const;
    virtual void setNewViewMenu(QMenu* menu);
    virtual void setStyleSheet(const QString& styleSheet);

    // return associated view manager
    ViewManager* connectedViewManager();

protected:
    virtual void addViewWidget(QWidget* view , int index);
    virtual void removeViewWidget(QWidget* view);
    virtual void navigationVisibilityChanged(NavigationVisibility mode);
    virtual void navigationPositionChanged(NavigationPosition position);
    virtual void navigationTextModeChanged(bool mode);
    virtual void moveViewWidget(int fromIndex , int toIndex);

private slots:
    void updateTitle(ViewProperties* item);
    void updateIcon(ViewProperties* item);
    void updateActivity(ViewProperties* item);
    void currentTabChanged(int index);
    void closeCurrentTab();
    void wheelScrolled(int delta);

    void tabDoubleClicked(int index);
    void openTabContextMenu(int index, const QPoint& point);
    void tabContextMenuCloseTab();
    void tabContextMenuRenameTab();
    void tabContextMenuDetachTab();
    void startTabDrag(int index);
    void querySourceIndex(const QDropEvent* event, int& sourceIndex);
    void onMoveViewRequest(int index, const QDropEvent* event, bool& success, TabbedViewContainer* sourceTabbedContainer);

signals:
    void detachTab(ViewContainer * self, QWidget * activeView);
    void closeTab(ViewContainer * self, QWidget * activeView);

private:
    void dynamicTabBarVisibility();
    void setTabBarVisible(bool visible);
    void setTabActivity(int index, bool activity);
    void renameTab(int index);
    void updateVisibilityOfQuickButtons();

    ViewContainerTabBar* _tabBar;
    QPointer<QStackedWidget> _stackWidget;
    QPointer<QWidget> _containerWidget;
    ViewManager* _connectedViewManager;
    QVBoxLayout* _layout;
    QHBoxLayout* _tabBarLayout;
    QToolButton* _newTabButton;
    QToolButton* _closeTabButton;
    int _contextMenuTabIndex;
    KMenu* _contextPopupMenu;
};

class StackedViewContainer : public ViewContainer
{
public:
    explicit StackedViewContainer(QObject* parent);
    virtual ~StackedViewContainer();

    virtual QWidget* containerWidget() const;
    virtual QWidget* activeView() const;
    virtual void setActiveView(QWidget* view);

protected:
    virtual void addViewWidget(QWidget* view , int index);
    virtual void removeViewWidget(QWidget* view);

private:
    QPointer<QWidget> _containerWidget;
    QPointer<QStackedWidget> _stackWidget;
};
}
#endif //VIEWCONTAINER_H