Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions

qdockarea.h

This is the verbatim text of the qdockarea.h include file. It is provided only for illustration; the copyright remains with Trolltech.

/****************************************************************************
** $Id: qt/qdockarea.h   3.3.8   edited Jan 11 14:38 $
**
** Definition of the TQDockArea class
**
** Created : 001010
**
** Copyright (C) 1992-2007 Trolltech ASA.  All rights reserved.
**
** This file is part of the workspace module of the TQt GUI Toolkit.
**
** This file may be used under the terms of the GNU General Public
** License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Alternatively you may (at your option) use any
** later version of the GNU General Public License if such license has
** been publicly approved by Trolltech ASA (or its successors, if any)
** and the KDE Free TQt Foundation.
**
** Please review the following information to ensure GNU General
** Public Licensing retquirements will be met:
** http://trolltech.com/products/qt/licenses/licensing/opensource/.
** If you are unsure which license is appropriate for your use, please
** review the following information:
** http://trolltech.com/products/qt/licenses/licensing/licensingoverview
** or contact the sales department at sales@trolltech.com.
**
** This file may be used under the terms of the Q Public License as
** defined by Trolltech ASA and appearing in the file LICENSE.TQPL
** included in the packaging of this file.  Licensees holding valid TQt
** Commercial licenses may use this file in accordance with the TQt
** Commercial License Agreement provided with the Software.
**
** This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
** INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE. Trolltech reserves all rights not granted
** herein.
**
**********************************************************************/

#ifndef TQDOCKAREA_H
#define TQDOCKAREA_H

#ifndef QT_H
#include "qwidget.h"
#include "qptrlist.h"
#include "qdockwindow.h"
#include "qlayout.h"
#include "qvaluelist.h"
#include "qguardedptr.h"
#include "qtextstream.h"
#endif // QT_H

#ifndef QT_NO_MAINWINDOW

class TQSplitter;
class TQBoxLayout;
class TQDockAreaLayout;
class TQMouseEvent;
class TQDockWindowResizeHandle;
class TQDockAreaPrivate;

class Q_EXPORT TQDockAreaLayout : public TQLayout
{
    Q_OBJECT
    friend class TQDockArea;

public:
    TQDockAreaLayout( TQWidget* parent, TQt::Orientation o, TQPtrList<TQDockWindow> *wl, int space = -1, int margin = -1, const char *name = 0 )
	: TQLayout( parent, space, margin, name ), orient( o ), dockWindows( wl ), parentWidget( parent ) { init(); }
    ~TQDockAreaLayout() {}

    void addItem( TQLayoutItem * ) {}
    bool hasHeightForWidth() const;
    int heightForWidth( int ) const;
    int widthForHeight( int ) const;
    TQSize sizeHint() const;
    TQSize minimumSize() const;
    TQLayoutIterator iterator();
    TQSizePolicy::ExpandData expanding() const { return TQSizePolicy::NoDirection; }
    void invalidate();
    TQt::Orientation orientation() const { return orient; }
    TQValueList<TQRect> lineList() const { return lines; }
    TQPtrList<TQDockWindow> lineStarts() const { return ls; }

protected:
    void setGeometry( const TQRect& );

private:
    void init();
    int layoutItems( const TQRect&, bool testonly = FALSE );
    TQt::Orientation orient;
    bool dirty;
    int cached_width, cached_height;
    int cached_hfw, cached_wfh;
    TQPtrList<TQDockWindow> *dockWindows;
    TQWidget *parentWidget;
    TQValueList<TQRect> lines;
    TQPtrList<TQDockWindow> ls;
#if defined(Q_DISABLE_COPY) // Disabled copy constructor and operator=
    TQDockAreaLayout( const TQDockAreaLayout & );
    TQDockAreaLayout &operator=( const TQDockAreaLayout & );
#endif
};

class Q_EXPORT TQDockArea : public TQWidget
{
    Q_OBJECT
    Q_ENUMS( HandlePosition )
    Q_PROPERTY( Orientation orientation READ orientation )
    Q_PROPERTY( int count READ count )
    Q_PROPERTY( bool empty READ isEmpty )
    Q_PROPERTY( HandlePosition handlePosition READ handlePosition )

    friend class TQDockWindow;
    friend class TQDockWindowResizeHandle;
    friend class TQDockAreaLayout;

public:
    enum HandlePosition { Normal, Reverse };

    TQDockArea( Orientation o, HandlePosition h = Normal, TQWidget* parent=0, const char* name=0 );
    ~TQDockArea();

    void moveDockWindow( TQDockWindow *w, const TQPoint &globalPos, const TQRect &rect, bool swap );
    void removeDockWindow( TQDockWindow *w, bool makeFloating, bool swap, bool fixNewLines = TRUE );
    void moveDockWindow( TQDockWindow *w, int index = -1 );
    bool hasDockWindow( TQDockWindow *w, int *index = 0 );

    void invalidNextOffset( TQDockWindow *dw );

    Orientation orientation() const { return orient; }
    HandlePosition handlePosition() const { return hPos; }

    bool eventFilter( TQObject *, TQEvent * );
    bool isEmpty() const;
    int count() const;
    TQPtrList<TQDockWindow> dockWindowList() const;

    bool isDockWindowAccepted( TQDockWindow *dw );
    void setAcceptDockWindow( TQDockWindow *dw, bool accept );

public slots:
    void lineUp( bool keepNewLines );

private:
    struct DockWindowData
    {
	int index;
	int offset;
	int line;
	TQSize fixedExtent;
	TQGuardedPtr<TQDockArea> area;
    };

    int findDockWindow( TQDockWindow *w );
    int lineOf( int index );
    DockWindowData *dockWindowData( TQDockWindow *w );
    void dockWindow( TQDockWindow *dockWindow, DockWindowData *data );
    void updateLayout();
    void invalidateFixedSizes();
    int maxSpace( int hint, TQDockWindow *dw );
    void setFixedExtent( int d, TQDockWindow *dw );
    bool isLastDockWindow( TQDockWindow *dw );

private:
    Orientation orient;
    TQPtrList<TQDockWindow> *dockWindows;
    TQDockAreaLayout *layout;
    HandlePosition hPos;
    TQPtrList<TQDockWindow> forbiddenWidgets;
    TQDockAreaPrivate *d;

private:	// Disabled copy constructor and operator=
#if defined(Q_DISABLE_COPY)
    TQDockArea( const TQDockArea & );
    TQDockArea& operator=( const TQDockArea & );
#endif

};

#ifndef QT_NO_TEXTSTREAM
Q_EXPORT TQTextStream &operator<<( TQTextStream &, const TQDockArea & );
Q_EXPORT TQTextStream &operator>>( TQTextStream &, TQDockArea & );
#endif

#define Q_DEFINED_QDOCKAREA
#include "qwinexport.h"
#endif

#endif //QT_NO_MAINWINDOW