1 /****************************************************************************
2 **
3 ** Copyright (C) 2016 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the QtWidgets module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QFRAME_H
41 #define QFRAME_H
42 
43 #include <QtWidgets/qtwidgetsglobal.h>
44 #include <QtWidgets/qwidget.h>
45 
46 QT_BEGIN_NAMESPACE
47 
48 
49 class QFramePrivate;
50 class QStyleOptionFrame;
51 
52 class Q_WIDGETS_EXPORT QFrame : public QWidget
53 {
54     Q_OBJECT
55 
56     Q_PROPERTY(Shape frameShape READ frameShape WRITE setFrameShape)
57     Q_PROPERTY(Shadow frameShadow READ frameShadow WRITE setFrameShadow)
58     Q_PROPERTY(int lineWidth READ lineWidth WRITE setLineWidth)
59     Q_PROPERTY(int midLineWidth READ midLineWidth WRITE setMidLineWidth)
60     Q_PROPERTY(int frameWidth READ frameWidth)
61     Q_PROPERTY(QRect frameRect READ frameRect WRITE setFrameRect DESIGNABLE false)
62 
63 public:
64     explicit QFrame(QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
65     ~QFrame();
66 
67     int frameStyle() const;
68     void setFrameStyle(int);
69 
70     int frameWidth() const;
71 
72     QSize sizeHint() const override;
73 
74     enum Shape {
75         NoFrame  = 0, // no frame
76         Box = 0x0001, // rectangular box
77         Panel = 0x0002, // rectangular panel
78         WinPanel = 0x0003, // rectangular panel (Windows)
79         HLine = 0x0004, // horizontal line
80         VLine = 0x0005, // vertical line
81         StyledPanel = 0x0006 // rectangular panel depending on the GUI style
82     };
83     Q_ENUM(Shape)
84     enum Shadow {
85         Plain = 0x0010, // plain line
86         Raised = 0x0020, // raised shadow effect
87         Sunken = 0x0030 // sunken shadow effect
88     };
89     Q_ENUM(Shadow)
90 
91     enum StyleMask {
92         Shadow_Mask = 0x00f0, // mask for the shadow
93         Shape_Mask = 0x000f // mask for the shape
94     };
95 
96     Shape frameShape() const;
97     void setFrameShape(Shape);
98     Shadow frameShadow() const;
99     void setFrameShadow(Shadow);
100 
101     int lineWidth() const;
102     void setLineWidth(int);
103 
104     int midLineWidth() const;
105     void setMidLineWidth(int);
106 
107     QRect frameRect() const;
108     void setFrameRect(const QRect &);
109 
110 protected:
111     bool event(QEvent *e) override;
112     void paintEvent(QPaintEvent *) override;
113     void changeEvent(QEvent *) override;
114     void drawFrame(QPainter *);
115 
116 
117 protected:
118     QFrame(QFramePrivate &dd, QWidget* parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
119     void initStyleOption(QStyleOptionFrame *option) const;
120 
121 private:
122     Q_DISABLE_COPY(QFrame)
123     Q_DECLARE_PRIVATE(QFrame)
124 };
125 
126 QT_END_NAMESPACE
127 
128 #endif // QFRAME_H
129