ihavetabs.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/

#ifndef INTERFACES_IHAVETABS_H
#define INTERFACES_IHAVETABS_H
#include <QMetaType>
#include <QList>
#include <QMap>
#include <QByteArray>
#include <QIcon>
#include <QtPlugin>

namespace LC
{
    enum TabFeature
    {
        TFEmpty = 0x0,

        TFOpenableByRequest = 1 << 0,

        TFSingle = 1 << 1,

        TFByDefault = 1 << 2,

        TFSuggestOpening = 1 << 3,

        TFOverridesTabClose = 1 << 4
    };

    Q_DECLARE_FLAGS (TabFeatures, LC::TabFeature);

    struct TabClassInfo
    {
        QByteArray TabClass_;

        QString VisibleName_;

        QString Description_;

        QIcon Icon_;

        quint16 Priority_;

        TabFeatures Features_;
    };

    typedef QList<TabClassInfo> TabClasses_t;
};

class QToolBar;
class QAction;

class Q_DECL_EXPORT ITabWidget
{
public:
    virtual ~ITabWidget () {}

    virtual LC::TabClassInfo GetTabClassInfo () const = 0;

    virtual QObject* ParentMultiTabs () = 0;

    virtual void Remove () = 0;

    virtual QToolBar* GetToolBar () const = 0;

    virtual QList<QAction*> GetTabBarContextMenuActions () const
    {
        return {};
    }

    virtual QMap<QString, QList<QAction*>> GetWindowMenus () const
    {
        return {};
    }

    virtual void TabMadeCurrent ()
    {
    }

    virtual void TabLostCurrent ()
    {
    }

    virtual void removeTab () = 0;

    virtual void changeTabName (const QString& name)
    {
        Q_UNUSED (name)
    }

    virtual void changeTabIcon (const QIcon& icon)
    {
        Q_UNUSED (icon)
    }

    virtual void raiseTab ()
    {
    }
};

class Q_DECL_EXPORT IHaveTabs
{
public:
    virtual ~IHaveTabs () {}

    virtual LC::TabClasses_t GetTabClasses () const = 0;

    virtual void TabOpenRequested (const QByteArray& tabClass) = 0;
};

Q_DECLARE_OPERATORS_FOR_FLAGS (LC::TabFeatures)

Q_DECLARE_INTERFACE (ITabWidget, "org.Deviant.LeechCraft.ITabWidget/1.0")
Q_DECLARE_INTERFACE (IHaveTabs, "org.Deviant.LeechCraft.IHaveTabs/1.0")

#endif