QFrame Class Reference

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

  1. #include <QFrame>

Inherits: QWidget.

Inherited by: Q3Frame, Q3ProgressBar, QAbstractScrollArea, QLabel, QLCDNumber, QSplitter, QStackedWidget, and QToolBox.

Detailed Description

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

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.

  1.                 QLabel label(...);
  2. label.setFrameStyle(QFrame::Panel | QFrame::Raised);
  3. label.setLineWidth(2);
  4.  
  5. QProgressBar pbar(...);
  6. label.setFrameStyle(QFrame::NoFrame);

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

The frame style is specified by a frame shape and a 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 NoFrame, Box, Panel, StyledPanel, HLine and VLine; the shadow styles are Plain, Raised and Sunken.

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

  • 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 Box, HLine and 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.

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

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

Table of frame styles

Table of frame styles

Public Types

Toggle detailsenum QFrame::

ShadowShadow { Plain , Raised , Sunken 0x0030 ...} { Plain , Raised , Sunken 0x0030 }

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

ConstantValueDescription
QFrame::Plain 0x0010 the frame and contents appear level with the surroundings; draws using the palette QPalette::WindowText color (without any 3D effect)
QFrame::Raised 0x0020 the frame and contents appear raised; draws a 3D raised line using the light and dark colors of the current color group
QFrame::Sunken 0x0030 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(), and midLineWidth().

Look up this member in the source code.

Toggle detailsenum QFrame::

ShapeShape { NoFrame , Box , Panel , WinPanel , HLine , VLine , StyledPanel , PopupPanel , MenuBarPanel , ToolBarPanel , LineEditPanel , TabWidgetPanel , GroupBoxPanel StyledPanel ...} { NoFrame , Box , Panel , WinPanel , HLine , VLine , StyledPanel , PopupPanel , MenuBarPanel , ToolBarPanel , LineEditPanel , TabWidgetPanel , GroupBoxPanel StyledPanel }

This enum type defines the shapes of frame available.

ConstantValueDescription
QFrame::NoFrame 0 QFrame draws nothing
QFrame::Box 0x0001 QFrame draws a box around its contents
QFrame::Panel 0x0002 QFrame draws a panel to make the contents appear raised or sunken
QFrame::StyledPanel 0x0006 draws a rectangular panel with a look that depends on the current GUI style. It can be raised or sunken.
QFrame::HLine 0x0004 QFrame draws a horizontal line that frames nothing (useful as separator)
QFrame::VLine 0x0005 QFrame draws a vertical line that frames nothing (useful as separator)
QFrame::WinPanel 0x0003 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(), and QStyle::drawPrimitive().

Look up this member in the source code.

Toggle detailsenum QFrame::

StyleMaskStyleMask { Shadow_Mask , Shape_Mask , MShadow , MShape Shape_Mask ...} { Shadow_Mask , Shape_Mask , MShadow , MShape Shape_Mask }

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

ConstantValueDescription
QFrame::Shadow_Mask 0x00f0 The Shadow part of frameStyle()
QFrame::Shape_Mask 0x000f The Shape part of frameStyle()

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

See also frameStyle() and setFrameStyle().

Look up this member in the source code.

    Properties

    Toggle detailsframeRectframeRect : QRect

    This property holds 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 widget rectangle.

    Access functions:

    Look up this member in the source code.

    Toggle detailsframeShadowframeShadow : Shadow

    This property holds the frame shadow value from the frame style

    See also frameStyle() and frameShape().

    Access functions:

    Look up this member in the source code.

    Toggle detailsframeShapeframeShape : Shape

    This property holds the frame shape value from the frame style

    See also frameStyle() and frameShadow().

    Access functions:

    Look up this member in the source code.

    Toggle detailsframeWidthframeWidth : const int

    This property holds the width of the frame that is drawn.

    Note that the frame width depends on the frame style, not only the line width and the mid-line width. For example, the style specified by NoFrame always has a frame width of 0, whereas the style Panel has a frame width equivalent to the line width.

    See also lineWidth(), midLineWidth(), and frameStyle().

    Access functions:

    Look up this member in the source code.

    Toggle detailslineWidthlineWidth : int

    This property holds the line width

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

    The default value is 1.

    See also midLineWidth and frameWidth.

    Access functions:

    Look up this member in the source code.

    Toggle detailsmidLineWidthmidLineWidth : int

    This property holds the width of the mid-line

    The default value is 0.

    See also lineWidth and frameWidth.

    Access functions:

    Look up this member in the source code.

      Public Functions

      Toggle details QFrame

      QFrameQFrame ( QWidget *parent=0 , Qt::WindowFlags f=0 ( QWidget *parent=0 , Qt::WindowFlags f=0 )

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

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

      Look up this member in the source code.

      Toggle details QFrame

      ~QFrame~QFrame () ()

      Destroys the frame.

      Look up this member in the source code.

      Toggle details void QFrame

      changeEventchangeEvent ( QEvent *ev ) ( QEvent *ev ) [virtual protected]

      Reimplemented from QWidget::changeEvent().

      Look up this member in the source code.

      Toggle details bool QFrame

      eventevent ( QEvent *e ) ( QEvent *e ) [virtual protected]

      Reimplemented from QObject::event().

      Look up this member in the source code.

      Toggle details int QFrame

      frameStyleframeStyle () ()const

      Returns the frame style.

      The default value is QFrame::Plain.

      See also setFrameStyle(), frameShape(), and frameShadow().

      Look up this member in the source code.

      Toggle details void QFrame

      paintEventpaintEvent ( QPaintEvent * ) ( QPaintEvent * ) [virtual protected]

      Reimplemented from QWidget::paintEvent().

      Look up this member in the source code.

      Toggle details void QFrame

      setFrameStylesetFrameStyle ( int style ) ( 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 QFrame::Shape and the shadow styles in QFrame::Shadow.

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

      See also frameStyle().

      Look up this member in the source code.

      Toggle details QSize QFrame

      sizeHintsizeHint () ()const [virtual]

      Reimplemented from QWidget::sizeHint().

      Look up this member in the source code.

      Toggle details QFrame

      QFrameQFrame ( QWidget *parent , const char *name , Qt::WindowFlags f=0 ...) ( QWidget *parent , const char *name , Qt::WindowFlags f=0 ) Qt3-support

      Use one of the constructors that doesn't take the name argument and then use setObjectName() instead.

      Look up this member in the source code.

      Notes provided by the Qt Community

      No notes