The QFrame class is the base class of widgets that can have a frame. More...

#include <qframe.h>

Inheritance diagram for QFrame:

Collaboration diagram for QFrame:

Public Types
enum	Shape { NoFrame = 0 , Box = 0x0001 , Panel = 0x0002 , WinPanel = 0x0003 , HLine = 0x0004 , VLine = 0x0005 , StyledPanel = 0x0006 }

enum	Shadow { Plain = 0x0010 , Raised = 0x0020 , Sunken = 0x0030 }

enum	StyleMask { Shadow_Mask = 0x00f0 , Shape_Mask = 0x000f }

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Member Functions
	QFrame (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QFrame ()

int	frameStyle () const

void	setFrameStyle (int)

int	frameWidth () const

QSize	sizeHint () const override

Shape	frameShape () const

void	setFrameShape (Shape)

Shadow	frameShadow () const

void	setFrameShadow (Shadow)

int	lineWidth () const

void	setLineWidth (int)

int	midLineWidth () const

void	setMidLineWidth (int)

QRect	frameRect () const

void	setFrameRect (const QRect &)

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

	~QWidget ()

int	devType () const override

WId	winId () const

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)

bool	isWindow () const

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)

void	setFixedSize (const QSize &)

void	setFixedSize (int w, int h)

void	setFixedWidth (int w)

void	setFixedHeight (int h)

QPointF	mapToGlobal (const QPointF &) const

QPoint	mapToGlobal (const QPoint &) const

QPointF	mapFromGlobal (const QPointF &) const

QPoint	mapFromGlobal (const QPoint &) const

QPointF	mapToParent (const QPointF &) const

QPoint	mapToParent (const QPoint &) const

QPointF	mapFromParent (const QPointF &) const

QPoint	mapFromParent (const QPoint &) const

QPointF	mapTo (const QWidget *, const QPointF &) const

QPoint	mapTo (const QWidget *, const QPoint &) const

QPointF	mapFrom (const QWidget *, const QPointF &) const

QPoint	mapFrom (const QWidget *, const QPoint &) const

QWidget *	window () const

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)

QPalette::ColorRole	backgroundRole () const

void	setForegroundRole (QPalette::ColorRole)

QPalette::ColorRole	foregroundRole () const

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const

QFontInfo	fontInfo () const

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)

void	setMask (const QRegion &)

QRegion	mask () const

void	clearMask ()

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())

void	ungrabGesture (Qt::GestureType type)

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)

QString	windowRole () const

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

QString	accessibleName () const

void	setAccessibleName (const QString &name)

QString	accessibleDescription () const

void	setAccessibleDescription (const QString &description)

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()

void	clearFocus ()

void	setFocus (Qt::FocusReason reason)

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)

QWidget *	focusProxy () const

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()

void	grabMouse (const QCursor &)

void	releaseMouse ()

void	grabKeyboard ()

void	releaseKeyboard ()

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)

void	releaseShortcut (int id)

void	setShortcutEnabled (int id, bool enable=true)

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)

void	update (const QRect &)

void	update (const QRegion &)

void	repaint (int x, int y, int w, int h)

void	repaint (const QRect &)

void	repaint (const QRegion &)

void	stackUnder (QWidget *)

void	move (int x, int y)

void	move (const QPoint &)

void	resize (int w, int h)

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const

bool	isHidden () const

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const

void	setWindowState (Qt::WindowStates state)

void	overrideWindowState (Qt::WindowStates state)

virtual QSize	minimumSizeHint () const

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)

virtual int	heightForWidth (int) const

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const

void	setContentsMargins (int left, int top, int right, int bottom)

void	setContentsMargins (const QMargins &margins)
	The setContentsMargins function sets the margins around the widget's contents. More...

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins. More...

QRect	contentsRect () const

QLayout *	layout () const

void	setLayout (QLayout *)

void	updateGeometry ()

void	setParent (QWidget *parent)

void	setParent (QWidget *parent, Qt::WindowFlags f)

void	scroll (int dx, int dy)

void	scroll (int dx, int dy, const QRect &)

QWidget *	focusWidget () const

QWidget *	nextInFocusChain () const

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain. More...

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)

void	addActions (const QList< QAction * > &actions)

void	insertActions (QAction before, const QList< QAction > &actions)

void	insertAction (QAction before, QAction action)

void	removeAction (QAction *action)

QList< QAction * >	actions () const

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)

Qt::WindowType	windowType () const

QWidget *	childAt (int x, int y) const

QWidget *	childAt (const QPoint &p) const

void	setAttribute (Qt::WidgetAttribute, bool on=true)

bool	testAttribute (Qt::WidgetAttribute) const

QPaintEngine *	paintEngine () const override

void	ensurePolished () const

bool	isAncestorOf (const QWidget *child) const

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const

QScreen *	screen () const

void	setScreen (QScreen *)

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)

virtual	~QObject ()

virtual bool	eventFilter (QObject watched, QEvent event)

QString	objectName () const

void	setObjectName (const QString &name)

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const

bool	isWindowType () const

bool	signalsBlocked () const noexcept

bool	blockSignals (bool b) noexcept

QThread *	thread () const

void	moveToThread (QThread *thread)

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const

const QObjectList &	children () const

void	setParent (QObject *parent)

void	installEventFilter (QObject *filterObj)

void	removeEventFilter (QObject *obj)

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const

void	dumpObjectInfo () const

bool	setProperty (const char *name, const QVariant &value)

QVariant	property (const char *name) const

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const

bool	inherits (const char *classname) const

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
bool	event (QEvent *e) override

void	paintEvent (QPaintEvent *) override

void	changeEvent (QEvent *) override

void	drawFrame (QPainter *)

	QFrame (QFramePrivate &dd, QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())

virtual void	initStyleOption (QStyleOptionFrame *option) const

Protected Member Functions inherited from QWidget
virtual void	mousePressEvent (QMouseEvent *event)

virtual void	mouseReleaseEvent (QMouseEvent *event)

virtual void	mouseDoubleClickEvent (QMouseEvent *event)

virtual void	mouseMoveEvent (QMouseEvent *event)

virtual void	keyPressEvent (QKeyEvent *event)

virtual void	keyReleaseEvent (QKeyEvent *event)

virtual void	focusInEvent (QFocusEvent *event)

virtual void	focusOutEvent (QFocusEvent *event)

virtual void	enterEvent (QEnterEvent *event)

virtual void	leaveEvent (QEvent *event)

virtual void	moveEvent (QMoveEvent *event)

virtual void	resizeEvent (QResizeEvent *event)

virtual void	closeEvent (QCloseEvent *event)

virtual void	contextMenuEvent (QContextMenuEvent *event)

virtual void	actionEvent (QActionEvent *event)

virtual void	showEvent (QShowEvent *event)

virtual void	hideEvent (QHideEvent *event)

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)

int	metric (PaintDeviceMetric) const override

void	initPainter (QPainter *painter) const override

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)

virtual bool	focusNextPrevChild (bool next)

bool	focusNextChild ()

bool	focusPreviousChild ()

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const

int	senderSignalIndex () const

int	receivers (const char *signal) const

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)

virtual void	childEvent (QChildEvent *event)

virtual void	customEvent (QEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

Properties
Shape	frameShape
	the frame shape value from the frame style More...

Shadow	frameShadow
	the frame shadow value from the frame style More...

int	lineWidth
	the line width More...

int	midLineWidth
	the width of the mid-line More...

int	frameWidth
	the width of the frame that is drawn. More...

QRect	frameRect
	the frame's rectangle More...

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget More...

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget More...

bool	enabled
	whether the widget is enabled More...

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame More...

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame More...

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget More...

int	x
	the x coordinate of the widget relative to its parent including any window frame More...

int	y
	the y coordinate of the widget relative to its parent and including any window frame More...

QPoint	pos
	the position of the widget within its parent widget More...

QSize	frameSize
	the size of the widget including any window frame More...

QSize	size
	the size of the widget excluding any window frame More...

int	width
	the width of the widget excluding any window frame More...

int	height
	the height of the widget excluding any window frame More...

QRect	rect
	the internal geometry of the widget excluding any window frame More...

QRect	childrenRect
	the bounding rectangle of the widget's children More...

QRegion	childrenRegion
	the combined region occupied by the widget's children More...

QSizePolicy	sizePolicy
	the default layout behavior of the widget More...

QSize	minimumSize
	the widget's minimum size More...

QSize	maximumSize
	the widget's maximum size in pixels More...

int	minimumWidth
	the widget's minimum width in pixels More...

int	minimumHeight
	the widget's minimum height in pixels More...

int	maximumWidth
	the widget's maximum width in pixels More...

int	maximumHeight
	the widget's maximum height in pixels More...

QSize	sizeIncrement
	the size increment of the widget More...

QSize	baseSize
	the base size of the widget More...

QPalette	palette
	the widget's palette More...

QFont	font
	the font currently set for the widget More...

QCursor	cursor
	the cursor shape for this widget More...

bool	mouseTracking
	whether mouse tracking is enabled for the widget More...

bool	tabletTracking
	whether tablet tracking is enabled for the widget More...

bool	isActiveWindow
	whether this widget's window is the active window More...

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus More...

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus More...

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu More...

bool	updatesEnabled
	whether updates are enabled More...

bool	visible
	whether the widget is visible More...

bool	minimized
	whether this widget is minimized (iconified) More...

bool	maximized
	whether this widget is maximized More...

bool	fullScreen
	whether the widget is shown in full screen mode More...

QSize	sizeHint
	the recommended size for the widget More...

QSize	minimumSizeHint
	the recommended minimum size for the widget More...

bool	acceptDrops
	whether drop events are enabled for this widget More...

QString	windowTitle
	the window title (caption) More...

QIcon	windowIcon
	the widget's icon More...

QString	windowIconText
	the text to be displayed on the icon of a minimized window More...

double	windowOpacity
	The level of opacity for the window. More...

bool	windowModified
	whether the document shown in the window has unsaved changes More...

QString	accessibleName
	the widget's name as seen by assistive technologies More...

QString	accessibleDescription
	the widget's description as seen by assistive technologies More...

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget. More...

bool	autoFillBackground
	whether the widget background is filled automatically More...

QString	styleSheet
	the widget's style sheet More...

QLocale	locale
	the widget's locale More...

QString	windowFilePath
	the file path associated with a widget More...

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has. More...

Properties inherited from QObject
QString	objectName
	the name of this object More...

Additional Inherited Members
Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()

void	update ()

void	repaint ()

virtual void	setVisible (bool visible)

void	setHidden (bool hidden)

void	show ()

void	hide ()

void	showMinimized ()

void	showMaximized ()

void	showFullScreen ()

void	showNormal ()

bool	close ()

void	raise ()

void	lower ()

Public Slots inherited from QObject
void	deleteLater ()

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)

void	windowIconChanged (const QIcon &icon)

void	windowIconTextChanged (const QString &iconText)

void	customContextMenuRequested (const QPoint &pos)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)

void	objectNameChanged (const QString &objectName, QPrivateSignal)

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )

static QWidget *	mouseGrabber ()

static QWidget *	keyboardGrabber ()

static QWidget *	find (WId)

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

static QMetaObject::Connection ::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 slot)

template<typename Func1 , typename Func2 >
static std::enable_if< QtPrivate::FunctionPointer< Func2 >::ArgumentCount==-1 &&!std::is_convertible_v< Func2, const char * >, QMetaObject::Connection >::type	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject context, Func2 slot, Qt::ConnectionType type=Qt::AutoConnection)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Related Functions inherited from QWidget
	setupUi (QWidget *widget)

Related Functions inherited from QObject
template< class T > T	qobject_cast (const QObject *object)

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList

Detailed Description

The QFrame class is the base class of widgets that can have a frame.

\inmodule QtWidgets

QMenu uses this to "raise" the menu above the surrounding screen. QProgressBar has a "sunken" look. QLabel has a flat look. The frames of widgets like these can be changed.

The QFrame class can also be used directly for creating simple placeholder frames without any contents.

The frame style is specified by a \l{QFrame::Shape}{frame shape} and a \l{QFrame::Shadow}{shadow style} that is used to visually separate the frame from surrounding widgets. These properties can be set together using the setFrameStyle() function and read with frameStyle().

The frame shapes are \l NoFrame, \l Box, \l Panel, \l StyledPanel, HLine and \l VLine; the shadow styles are \l Plain, \l Raised and \l Sunken.

A frame widget has three attributes that describe the thickness of the border: \l lineWidth, \l midLineWidth, and \l frameWidth.

\list

The line width is the width of the frame border. It can be modified to customize the frame's appearance.

The mid-line width specifies the width of an extra line in the middle of the frame, which uses a third color to obtain a special 3D effect. Notice that a mid-line is only drawn for \l Box, \l HLine and \l VLine frames that are raised or sunken.

The frame width is determined by the frame style, and the frameWidth() function is used to obtain the value defined for the style used. \endlist

The margin between the frame and the contents of the frame can be customized with the QWidget::setContentsMargins() function.

\target picture This table shows some of the combinations of styles and line widths:

Table of frame styles

Definition at line 52 of file qframe.h.

Member Enumeration Documentation

◆ Shadow

enum QFrame::Shadow

This enum type defines the types of shadow that are used to give a 3D effect to frames.

\value Plain the frame and contents appear level with the surroundings; draws using the palette QPalette::WindowText color (without any 3D effect)

\value Raised the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group \value Sunken the frame and contents appear sunken; draws a 3D sunken line using the light and dark colors of the current color group

Shadow interacts with QFrame::Shape, the lineWidth() and the midLineWidth(). See the picture of the frames in the main class documentation.

See also: QFrame::Shape, lineWidth(), midLineWidth()

Enumerator
Plain
Raised
Sunken

Definition at line 84 of file qframe.h.

◆ Shape

enum QFrame::Shape

This enum type defines the shapes of frame available.

\value NoFrame QFrame draws nothing \value Box QFrame draws a box around its contents \value Panel QFrame draws a panel to make the contents appear raised or sunken \value StyledPanel draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken. \value HLine QFrame draws a horizontal line that frames nothing (useful as separator) \value VLine QFrame draws a vertical line that frames nothing (useful as separator) \value WinPanel draws a rectangular panel that can be raised or sunken like those in Windows 2000. Specifying this shape sets the line width to 2 pixels. WinPanel is provided for compatibility. For GUI style independence we recommend using StyledPanel instead.

When it does not call QStyle, Shape interacts with QFrame::Shadow, the lineWidth() and the midLineWidth() to create the total result. See the picture of the frames in the main class documentation.

See also: QFrame::Shadow, QFrame::style(), QStyle::drawPrimitive()

Enumerator
NoFrame
Box
Panel
WinPanel
HLine
VLine
StyledPanel

Definition at line 74 of file qframe.h.

◆ StyleMask

enum QFrame::StyleMask

This enum defines two constants that can be used to extract the two components of frameStyle():

\value Shadow_Mask The \l Shadow part of frameStyle() \value Shape_Mask The \l Shape part of frameStyle()

Normally, you don't need to use these, since frameShadow() and frameShape() already extract the \l Shadow and the \l Shape parts of frameStyle().

See also: frameStyle(), setFrameStyle()

Enumerator
Shadow_Mask
Shape_Mask

Definition at line 91 of file qframe.h.

Constructor & Destructor Documentation

◆ QFrame() [1/2]

QFrame::QFrame	(	QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `Qt::WindowFlags()`
	)

explicit

Constructs a frame widget with frame style \l NoFrame and a 1-pixel frame width.

The parent and f arguments are passed to the QWidget constructor.

Definition at line 200 of file qframe.cpp.

◆ ~QFrame()

QFrame::~QFrame ( )

Destroys the frame.

Definition at line 262 of file qframe.cpp.

◆ QFrame() [2/2]

QFrame::QFrame	(	QFramePrivate &	dd,
		QWidget *	parent = `nullptr`,
		Qt::WindowFlags	f = `Qt::WindowFlags()`
	)

protected

Definition at line 208 of file qframe.cpp.

Member Function Documentation

◆ changeEvent()

void QFrame::changeEvent ( QEvent * ev )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in QToolBox, QSplitter, and QLabel.

Definition at line 533 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ drawFrame()

void QFrame::drawFrame ( QPainter * p )

protected

Definition at line 523 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ event()

bool QFrame::event ( QEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in ContextMenuWidget, QToolBox, QStackedWidget, QLCDNumber, QLabel, and QSplitter.

Definition at line 546 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ frameRect()

QRect QFrame::frameRect ( ) const

Definition at line 475 of file qframe.cpp.

Here is the call graph for this function:

◆ frameShadow()

QFrame::Shadow QFrame::frameShadow ( ) const

Definition at line 305 of file qframe.cpp.

◆ frameShape()

QFrame::Shape QFrame::frameShape ( ) const

Definition at line 286 of file qframe.cpp.

◆ frameStyle()

int QFrame::frameStyle ( ) const

Returns the frame style.

The default value is QFrame::Plain.

See also: setFrameStyle(), frameShape(), frameShadow()

Definition at line 273 of file qframe.cpp.

◆ frameWidth()

int QFrame::frameWidth ( ) const

Definition at line 454 of file qframe.cpp.

◆ initStyleOption()

void QFrame::initStyleOption ( QStyleOptionFrame * option ) const

protectedvirtual

Since: 5.5

Initializes option with the values from this QFrame. This method is useful for subclasses when they need a QStyleOptionFrame but don't want to fill in all the information themselves.

See also: QStyleOption::initFrom()

Definition at line 224 of file qframe.cpp.

Here is the caller graph for this function:

◆ lineWidth()

int QFrame::lineWidth ( ) const

Definition at line 380 of file qframe.cpp.

◆ midLineWidth()

int QFrame::midLineWidth ( ) const

Definition at line 404 of file qframe.cpp.

◆ paintEvent()

void QFrame::paintEvent ( QPaintEvent * )

overrideprotectedvirtual

\reimp

Reimplemented from QWidget.

Reimplemented in View, View, DragWidget, QLCDNumber, and QLabel.

Definition at line 512 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrameRect()

void QFrame::setFrameRect ( const QRect & r )

Definition at line 483 of file qframe.cpp.

Here is the call graph for this function:

◆ setFrameShadow()

void QFrame::setFrameShadow ( QFrame::Shadow s )

Definition at line 311 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrameShape()

void QFrame::setFrameShape ( Shape )

Definition at line 292 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFrameStyle()

void QFrame::setFrameStyle ( int style )

Sets the frame style to style.

The style is the bitwise OR between a frame shape and a frame shadow style. See the picture of the frames in the main class documentation.

The frame shapes are given in \l{QFrame::Shape} and the shadow styles in \l{QFrame::Shadow}.

If a mid-line width greater than 0 is specified, an additional line is drawn for \l Raised or \l Sunken \l Box, \l HLine, and \l VLine frames. The mid-color of the current color group is used for drawing middle lines.

See also: frameStyle()

Definition at line 335 of file qframe.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLineWidth()

void QFrame::setLineWidth ( int w )

Definition at line 371 of file qframe.cpp.

Here is the caller graph for this function:

◆ setMidLineWidth()

void QFrame::setMidLineWidth ( int w )

Definition at line 395 of file qframe.cpp.

◆ sizeHint()

QSize QFrame::sizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QWidget.

Reimplemented in SizeHinterFrame, SizeHinterFrame, QSplitter, QLCDNumber, and QLabel.

Definition at line 493 of file qframe.cpp.

Property Documentation

◆ frameRect

QFrame::frameRect

readwrite

the frame's rectangle

The frame's rectangle is the rectangle the frame is drawn in. By default, this is the entire widget. Setting the rectangle does does not cause a widget update. The frame rectangle is automatically adjusted when the widget changes size.

If you set the rectangle to a null rectangle (for example, QRect(0, 0, 0, 0)), then the resulting frame rectangle is equivalent to the \l{QWidget::rect()}{widget rectangle}.

Definition at line 128 of file qframe.h.

◆ frameShadow

QFrame::frameShadow

readwrite

the frame shadow value from the frame style

See also: frameStyle(), frameShape()

Definition at line 128 of file qframe.h.

◆ frameShape

QFrame::frameShape

readwrite

the frame shape value from the frame style

See also: frameStyle(), frameShadow()

Definition at line 128 of file qframe.h.

◆ frameWidth

QFrame::frameWidth

read

the width of the frame that is drawn.

Note that the frame width depends on the \l{QFrame::setFrameStyle()}{frame style}, not only the line width and the mid-line width. For example, the style specified by \l NoFrame always has a frame width of 0, whereas the style \l Panel has a frame width equivalent to the line width.

See also: lineWidth(), midLineWidth(), frameStyle()

Definition at line 128 of file qframe.h.

◆ lineWidth

QFrame::lineWidth

readwrite

the line width

Note that the total line width for frames used as separators (\l HLine and \l VLine) is specified by \l frameWidth.

The default value is 1.

See also: midLineWidth, frameWidth

Definition at line 128 of file qframe.h.

◆ midLineWidth

QFrame::midLineWidth

readwrite

the width of the mid-line

The default value is 0.

See also: lineWidth, frameWidth

Definition at line 128 of file qframe.h.

The documentation for this class was generated from the following files:

src/widgets/widgets/qframe.h
src/widgets/widgets/qframe.cpp

Public Types

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Shadow

◆ Shape

◆ StyleMask

Constructor & Destructor Documentation

◆ QFrame() [1/2]

◆ ~QFrame()

◆ QFrame() [2/2]

Member Function Documentation

◆ changeEvent()

◆ drawFrame()

◆ event()

◆ frameRect()

◆ frameShadow()

◆ frameShape()

◆ frameStyle()

◆ frameWidth()

◆ initStyleOption()

◆ lineWidth()

◆ midLineWidth()

◆ paintEvent()

◆ setFrameRect()

◆ setFrameShadow()

◆ setFrameShape()

◆ setFrameStyle()

◆ setLineWidth()

◆ setMidLineWidth()

◆ sizeHint()

Property Documentation

◆ frameRect

◆ frameShadow

◆ frameShape

◆ frameWidth

◆ lineWidth

◆ midLineWidth