1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtGui module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QSPLITTER_H

    43 #define QSPLITTER_H

    44 

    45 #include <QtGui/qframe.h>

    46 #include <QtGui/qsizepolicy.h>

    47 

    48 QT_BEGIN_HEADER

    49 

    50 QT_BEGIN_NAMESPACE

    51 

    52 QT_MODULE(Gui)

    53 

    54 #ifndef QT_NO_SPLITTER

    55 

    56 class QSplitterPrivate;

    57 class QTextStream;

    58 template <typename T> class QList;

    59 

    60 class QSplitterHandle;

    61 

    62 class Q_GUI_EXPORT QSplitter : public QFrame

    63 {

    64     Q_OBJECT

    65 

    66     Q_PROPERTY(Qt::Orientation orientation READ orientation WRITE setOrientation)

    67     Q_PROPERTY(bool opaqueResize READ opaqueResize WRITE setOpaqueResize)

    68     Q_PROPERTY(int handleWidth READ handleWidth WRITE setHandleWidth)

    69     Q_PROPERTY(bool childrenCollapsible READ childrenCollapsible WRITE setChildrenCollapsible)

    70 

    71 public:

    72     explicit QSplitter(QWidget* parent = 0);

    73     explicit QSplitter(Qt::Orientation, QWidget* parent = 0);

    74     ~QSplitter();

    75 

    76     void addWidget(QWidget *widget);

    77     void insertWidget(int index, QWidget *widget);

    78 

    79     void setOrientation(Qt::Orientation);

    80     Qt::Orientation orientation() const;

    81 

    82     void setChildrenCollapsible(bool);

    83     bool childrenCollapsible() const;

    84 

    85     void setCollapsible(int index, bool);

    86     bool isCollapsible(int index) const;

    87     void setOpaqueResize(bool opaque = true);

    88     bool opaqueResize() const;

    89     void refresh();

    90 

    91     QSize sizeHint() const;

    92     QSize minimumSizeHint() const;

    93 

    94     QList<int> sizes() const;

    95     void setSizes(const QList<int> &list);

    96 

    97     QByteArray saveState() const;

    98     bool restoreState(const QByteArray &state);

    99 

   100     int handleWidth() const;

   101     void setHandleWidth(int);

   102 

   103     int indexOf(QWidget *w) const;

   104     QWidget *widget(int index) const;

   105     int count() const;

   106 

   107     void getRange(int index, int *, int *) const;

   108     QSplitterHandle *handle(int index) const;

   109 

   110     void setStretchFactor(int index, int stretch);

   111 

   112 Q_SIGNALS:

   113     void splitterMoved(int pos, int index);

   114 

   115 protected:

   116     virtual QSplitterHandle *createHandle();

   117 

   118     void childEvent(QChildEvent *);

   119 

   120     bool event(QEvent *);

   121     void resizeEvent(QResizeEvent *);

   122 

   123     void changeEvent(QEvent *);

   124     void moveSplitter(int pos, int index);

   125     void setRubberBand(int position);

   126     int closestLegalPosition(int, int);

   127 

   128 #ifdef QT3_SUPPORT

   129 public:

   130     QT3_SUPPORT_CONSTRUCTOR QSplitter(QWidget* parent, const char* name);

   131     QT3_SUPPORT_CONSTRUCTOR QSplitter(Qt::Orientation, QWidget* parent, const char* name);

   132     enum ResizeMode { Stretch, KeepSize, FollowSizeHint, Auto };

   133     QT3_SUPPORT void setResizeMode(QWidget *w, ResizeMode mode);

   134     inline QT3_SUPPORT void moveToFirst(QWidget *w) { insertWidget(0,w); }

   135     inline QT3_SUPPORT void moveToLast(QWidget *w) { addWidget(w); }

   136     inline QT3_SUPPORT void setCollapsible(QWidget *w, bool collapse)

   137     { setCollapsible(indexOf(w), collapse); }

   138     QT3_SUPPORT void setMargin(int margin) { setContentsMargins(margin, margin, margin, margin); }

   139     QT3_SUPPORT int margin() const 

   140     { int margin; int dummy; getContentsMargins(&margin, &dummy, &dummy, &dummy);  return margin; }    

   141 #endif

   142 

   143 private:

   144     Q_DISABLE_COPY(QSplitter)

   145     Q_DECLARE_PRIVATE(QSplitter)

   146 private:

   147     friend class QSplitterHandle;

   148 };

   149 

   150 //#ifdef QT3_SUPPORT

   151 #ifndef QT_NO_TEXTSTREAM

   152 Q_GUI_EXPORT QTextStream& operator<<(QTextStream&, const QSplitter&);

   153 Q_GUI_EXPORT QTextStream& operator>>(QTextStream&, QSplitter&);

   154 #endif

   155 //#endif

   156 

   157 class QSplitterHandlePrivate;

   158 class Q_GUI_EXPORT QSplitterHandle : public QWidget

   159 {

   160     Q_OBJECT

   161 public:

   162     QSplitterHandle(Qt::Orientation o, QSplitter *parent);

   163     void setOrientation(Qt::Orientation o);

   164     Qt::Orientation orientation() const;

   165     bool opaqueResize() const;

   166     QSplitter *splitter() const;

   167 

   168     QSize sizeHint() const;

   169 

   170 protected:

   171     void paintEvent(QPaintEvent *);

   172     void mouseMoveEvent(QMouseEvent *);

   173     void mousePressEvent(QMouseEvent *);

   174     void mouseReleaseEvent(QMouseEvent *);

   175     bool event(QEvent *);

   176 

   177     void moveSplitter(int p);

   178     int closestLegalPosition(int p);

   179 

   180 private:

   181     Q_DISABLE_COPY(QSplitterHandle)

   182     Q_DECLARE_PRIVATE(QSplitterHandle)

   183 };

   184 

   185 #endif // QT_NO_SPLITTER

   186 

   187 QT_END_NAMESPACE

   188 

   189 QT_END_HEADER

   190 

   191 #endif // QSPLITTER_H