From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qframe.html | 370 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 370 insertions(+) create mode 100644 doc/html/qframe.html (limited to 'doc/html/qframe.html') diff --git a/doc/html/qframe.html b/doc/html/qframe.html new file mode 100644 index 0000000..0afe39e --- /dev/null +++ b/doc/html/qframe.html @@ -0,0 +1,370 @@ + + + + + +QFrame Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QFrame Class Reference

+ +

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

#include <qframe.h> +

Inherits QWidget. +

Inherited by QGroupBox, QScrollView, QDockWindow, QGrid, QHBox, QLabel, QLCDNumber, QLineEdit, QMenuBar, QPopupMenu, QProgressBar, QSplitter, QToolBox, and QWidgetStack. +

List of all member functions. +

Public Members

+ +

Properties

+ +

Protected Members

+ +

Detailed Description

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

+

It draws a frame and calls a virtual function, drawContents(), to +fill in the frame. This function is reimplemented by subclasses. +There are also two other less useful functions: drawFrame() and +frameChanged(). +

QPopupMenu 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. +

+    QLabel label(...);
+    label.setFrameStyle( QFrame::Panel | QFrame::Raised );
+    label.setLineWidth( 2 );
+
+    QProgressBar pbar(...);
+    label.setFrameStyle( QFrame::NoFrame );
+
+ +

The QFrame class can also be used directly for creating simple +frames without any contents, although usually you would use a +QHBox or QVBox because they automatically lay out the widgets you +put inside the frame. +

A frame widget has four attributes: frameStyle(), lineWidth(), +midLineWidth(), and margin(). +

The frame style is specified by a frame + shape and a shadow style. The +frame shapes are NoFrame, Box, Panel, StyledPanel, PopupPanel, WinPanel, ToolBarPanel, MenuBarPanel, HLine and VLine; the shadow styles are Plain, Raised and +Sunken. +

The line width is the width of the frame border. +

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 margin is the gap between the frame and the contents of the +frame. +

+This table shows the most useful combinations of styles and widths +(and some rather useless ones): +

Table of frame styles

See also Abstract Widget Classes. + +

Member Type Documentation

+

QFrame::Shadow

+ +

This enum type defines the 3D effect used for QFrame's frame. +

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

See also QFrame::Shape, lineWidth, and midLineWidth. + +

QFrame::Shape

+ +

This enum type defines the shapes of a QFrame's frame. +

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 class +description. +

See also QFrame::Shadow, QFrame::style(), and QStyle::drawPrimitive(). + +

Member Function Documentation

+

QFrame::QFrame ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 ) +

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

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

QRect QFrame::contentsRect () const +

Returns the rectangle inside the frame. +See the "contentsRect" property for details. +

void QFrame::drawContents ( QPainter * ) [virtual protected] +

+Virtual function that draws the contents of the frame. +

The QPainter is already open when you get it, and you must leave +it open. Painter transformations are switched off on entry. If you +transform the painter, remember to take the frame into account and +reset transformation before +returning. +

This function is reimplemented by subclasses that draw something +inside the frame. It should only draw inside contentsRect(). The +default function does nothing. +

See also contentsRect and QPainter::setClipRect(). + +

Reimplemented in QLabel, QLCDNumber, QMenuBar, and QPopupMenu. +

void QFrame::drawFrame ( QPainter * p ) [virtual protected] +

+Draws the frame using the painter p and the current frame +attributes and color group. The rectangle inside the frame is not +affected. +

This function is virtual, but in general you do not need to +reimplement it. If you do, note that the QPainter is already open +and must remain open. +

See also frameRect, contentsRect, drawContents(), frameStyle(), and palette. + +

void QFrame::frameChanged () [virtual protected] +

+Virtual function that is called when the frame style, line width +or mid-line width changes. +

This function can be reimplemented by subclasses that need to know +when the frame attributes change. +

The default implementation calls update(). + +

QRect QFrame::frameRect () const +

Returns the frame rectangle. +See the "frameRect" property for details. +

Shadow QFrame::frameShadow () const +

Returns the frame shadow value from the frame style. +See the "frameShadow" property for details. +

Shape QFrame::frameShape () const +

Returns the frame shape value from the frame style. +See the "frameShape" property for details. +

int QFrame::frameStyle () const +

+ +

Returns the frame style. +

The default value is QFrame::NoFrame. +

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

Example: scrollview/scrollview.cpp. +

int QFrame::frameWidth () const +

Returns the width of the frame that is drawn. +See the "frameWidth" property for details. +

int QFrame::lineWidth () const +

Returns the line width. +See the "lineWidth" property for details. +

int QFrame::margin () const +

Returns the width of the margin. +See the "margin" property for details. +

int QFrame::midLineWidth () const +

Returns the width of the mid-line. +See the "midLineWidth" property for details. +

void QFrame::paintEvent ( QPaintEvent * event ) [virtual protected] +

+Processes the paint event event. +

Paints the frame and the contents. +

Opens the painter on the frame and calls drawFrame(), then +drawContents(). + +

Examples: life/life.cpp and qfd/fontdisplayer.cpp. +

Reimplemented from QWidget. +

void QFrame::resizeEvent ( QResizeEvent * e ) [virtual protected] +

+Processes the resize event e. +

Adjusts the frame rectangle for the resized widget. The frame +rectangle is elastic, and the surrounding area is static. +

The resulting frame rectangle may be null or invalid. You can use +setMinimumSize() to avoid those possibilities. +

Nothing is done if the frame rectangle is a null rectangle already. + +

Example: life/life.cpp. +

Reimplemented from QWidget. +

void QFrame::setFrameRect ( const QRect & ) [virtual] +

Sets the frame rectangle. +See the "frameRect" property for details. +

void QFrame::setFrameShadow ( Shadow ) +

Sets the frame shadow value from the frame style. +See the "frameShadow" property for details. +

void QFrame::setFrameShape ( Shape ) +

Sets the frame shape value from the frame style. +See the "frameShape" property for details. +

void QFrame::setFrameStyle ( int style ) [virtual] +

+Sets the frame style to style. +

The style is the bitwise OR between a frame shape and a frame +shadow style. See the illustration in the +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 Illustration, frameStyle(), colorGroup, and QColorGroup. + +

Examples: cursor/cursor.cpp, layout/layout.cpp, listboxcombo/listboxcombo.cpp, rangecontrols/rangecontrols.cpp, scrollview/scrollview.cpp, tabdialog/tabdialog.cpp, and tictac/tictac.cpp. +

void QFrame::setLineWidth ( int ) [virtual] +

Sets the line width. +See the "lineWidth" property for details. +

void QFrame::setMargin ( int ) [virtual] +

Sets the width of the margin. +See the "margin" property for details. +

void QFrame::setMidLineWidth ( int ) [virtual] +

Sets the width of the mid-line. +See the "midLineWidth" property for details. +

Property Documentation

+

QRect contentsRect

+

This property holds the rectangle inside the frame. +

Get this property's value with contentsRect(). +

See also frameRect and drawContents(). + +

QRect frameRect

+

This property holds the frame rectangle. +

The frame rectangle is the rectangle the frame is drawn in. By +default, this is the entire widget. Setting this property does not cause a widget update. +

If this property is set to a null rectangle (for example +QRect(0, 0, 0, 0)), then the frame rectangle is equivalent to +the widget rectangle. +

See also contentsRect. + +

Set this property's value with setFrameRect() and get this property's value with frameRect(). +

Shadow frameShadow

+

This property holds the frame shadow value from the frame style. +

Set this property's value with setFrameShadow() and get this property's value with frameShadow(). +

See also frameStyle() and frameShape. + +

Shape frameShape

+

This property holds the frame shape value from the frame style. +

Set this property's value with setFrameShape() and get this property's value with frameShape(). +

See also frameStyle() and frameShadow. + +

int frameWidth

+

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 NoFrame +always has a frame width of 0, whereas the style Panel has a +frame width equivalent to the line width. The frame width also +includes the margin. +

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

Get this property's value with frameWidth(). +

int lineWidth

+

This property holds the line width. +

Note that the total line width for HLine and VLine is +given by frameWidth(), not lineWidth(). +

The default value is 1. +

See also midLineWidth and frameWidth. + +

Set this property's value with setLineWidth() and get this property's value with lineWidth(). +

int margin

+

This property holds the width of the margin. +

The margin is the distance between the innermost pixel of the +frame and the outermost pixel of contentsRect(). It is included in +frameWidth(). +

The margin is filled according to backgroundMode(). +

The default value is 0. +

See also margin, lineWidth, and frameWidth. + +

Set this property's value with setMargin() and get this property's value with margin(). +

int midLineWidth

+

This property holds the width of the mid-line. +

The default value is 0. +

See also lineWidth and frameWidth. + +

Set this property's value with setMidLineWidth() and get this property's value with midLineWidth(). + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.1