ads_globals.h

Go to the documentation of this file.

#ifndef ads_globalsH
#define ads_globalsH
/*******************************************************************************
** Qt Advanced Docking System
** Copyright (C) 2017 Uwe Kindler
** 
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Lesser General Public
** License as published by the Free Software Foundation; either
** version 2.1 of the License, or (at your option) any later version.
** 
** This library 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
** Lesser General Public License for more details.
** 
** You should have received a copy of the GNU Lesser General Public
** License along with this library; If not, see <http://www.gnu.org/licenses/>.
******************************************************************************/


//============================================================================
//============================================================================


//============================================================================
//                                   INCLUDES
//============================================================================
#include <QPair>
#include <QtCore/QtGlobal>
#include <QPixmap>
#include <QWidget>
#include <QDebug>
#include <QStyle>

#ifdef Q_OS_LINUX
#include <xcb/xcb.h>
#endif

QT_FORWARD_DECLARE_CLASS(QAbstractButton)

#ifndef ADS_STATIC
#ifdef ADS_SHARED_EXPORT
#define ADS_EXPORT Q_DECL_EXPORT
#else
#define ADS_EXPORT Q_DECL_IMPORT
#endif
#else
#define ADS_EXPORT
#endif

// Define ADS_DEBUG_PRINT to enable a lot of debug output
#ifdef ADS_DEBUG_PRINT
#define ADS_PRINT(s) qDebug() << s
#else
#define ADS_PRINT(s)
#endif

// Set ADS_DEBUG_LEVEL to enable additional debug output and to enable layout
// dumps to qDebug and std::cout after layout changes
#define ADS_DEBUG_LEVEL 0

QT_FORWARD_DECLARE_CLASS(QSplitter)

namespace ads
{
class CDockSplitter;

enum DockWidgetArea
{
        NoDockWidgetArea = 0x00,
        LeftDockWidgetArea = 0x01,
        RightDockWidgetArea = 0x02,
        TopDockWidgetArea = 0x04,
        BottomDockWidgetArea = 0x08,
        CenterDockWidgetArea = 0x10,

        InvalidDockWidgetArea = NoDockWidgetArea,
        OuterDockAreas = TopDockWidgetArea | LeftDockWidgetArea | RightDockWidgetArea | BottomDockWidgetArea,
        AllDockAreas = OuterDockAreas | CenterDockWidgetArea
};
Q_DECLARE_FLAGS(DockWidgetAreas, DockWidgetArea)


enum TitleBarButton
{
        TitleBarButtonTabsMenu,
        TitleBarButtonUndock,
        TitleBarButtonClose
};

enum eDragState
{
        DraggingInactive,     
        DraggingMousePressed, 
        DraggingTab,          
        DraggingFloatingWidget
};

enum eIcon
{
        TabCloseIcon,      
        DockAreaMenuIcon,  
        DockAreaUndockIcon,
        DockAreaCloseIcon, 

        IconCount,         
};

enum eBitwiseOperator
{
        BitwiseAnd,
        BitwiseOr
};


namespace internal
{
static const bool RestoreTesting = true;
static const bool Restore = false;
static const char* const ClosedProperty = "close";
static const char* const DirtyProperty = "dirty";

#ifdef Q_OS_LINUX
// Utils to directly communicate with the X server
xcb_atom_t xcb_get_atom(const char *name);

void xcb_add_prop(bool state, WId window, const char *type, const char *prop);
void xcb_update_prop(bool set, WId window, const char *type, const char *prop, const char *prop2 = nullptr);
bool xcb_dump_props(WId window, const char *type);
QString windowManager();
#endif

void replaceSplitterWidget(QSplitter* Splitter, QWidget* From, QWidget* To);

void hideEmptyParentSplitters(CDockSplitter* FirstParentSplitter);

class CDockInsertParam : public QPair<Qt::Orientation, bool>
{
public:
        using QPair::QPair;
        Qt::Orientation orientation() const {return this->first;}
        bool append() const {return this->second;}
        int insertOffset() const {return append() ? 1 : 0;}
};

CDockInsertParam dockAreaInsertParameters(DockWidgetArea Area);

template <class T>
T findParent(const QWidget* w)
{
        QWidget* parentWidget = w->parentWidget();
        while (parentWidget)
        {
                T ParentImpl = qobject_cast<T>(parentWidget);
                if (ParentImpl)
                {
                        return ParentImpl;
                }
                parentWidget = parentWidget->parentWidget();
        }
        return 0;
}

QPixmap createTransparentPixmap(const QPixmap& Source, qreal Opacity);


template <class T>
void setFlag(T& Flags, typename T::enum_type flag, bool on = true)
{
#if QT_VERSION >= 0x050700
        Flags.setFlag(flag, on);
#else
    if(on)
    {
        Flags |= flag;
    }
    else
    {
        Flags &= ~flag;
    }
#endif
}


template <class QObjectPtr>
void setToolTip(QObjectPtr obj, const QString &tip)
{
#ifndef QT_NO_TOOLTIP
        obj->setToolTip(tip);
#else
        Q_UNUSED(obj);
        Q_UNUSED(tip);
#endif
}


void setButtonIcon(QAbstractButton* Button, QStyle::StandardPixmap StandarPixmap,
        ads::eIcon CustomIconId);


enum eRepolishChildOptions
{
        RepolishIgnoreChildren,
        RepolishDirectChildren,
        RepolishChildrenRecursively
};

void repolishStyle(QWidget* w, eRepolishChildOptions Options = RepolishIgnoreChildren);


} // namespace internal
} // namespace ads

//---------------------------------------------------------------------------
#endif // ads_globalsH