qframe man page on Peanut

Man page or keyword search:  
man Server   7435 pages
apropos Keyword Search (all sections)
Output format
Peanut logo
[printable version]

QFrame(3qt)							   QFrame(3qt)

NAME
       QFrame - The base class of widgets that can have a frame

SYNOPSIS
       #include <qframe.h>

       Inherits QWidget.

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

   Public Members
       QFrame ( QWidget * parent = 0, const char * name = 0, WFlags f = 0 )
       int frameStyle () const
       virtual void setFrameStyle ( int style )
       int frameWidth () const
       QRect contentsRect () const
       enum Shape { NoFrame = 0, Box = 0x0001, Panel = 0x0002, WinPanel =
	   0x0003, HLine = 0x0004, VLine = 0x0005, StyledPanel = 0x0006,
	   PopupPanel = 0x0007, MenuBarPanel = 0x0008, ToolBarPanel = 0x0009,
	   LineEditPanel = 0x000a, TabWidgetPanel = 0x000b, GroupBoxPanel =
	   0x000c, MShape = 0x000f }
       enum Shadow { Plain = 0x0010, Raised = 0x0020, Sunken = 0x0030, MShadow
	   = 0x00f0 }
       Shape frameShape () const
       void setFrameShape ( Shape )
       Shadow frameShadow () const
       void setFrameShadow ( Shadow )
       int lineWidth () const
       virtual void setLineWidth ( int )
       int margin () const
       virtual void setMargin ( int )
       int midLineWidth () const
       virtual void setMidLineWidth ( int )
       QRect frameRect () const
       virtual void setFrameRect ( const QRect & )

   Properties
       QRect contentsRect - the rectangle inside the frame  (read only)
       QRect frameRect - the frame rectangle
       Shadow frameShadow - the frame shadow value from the frame style
       Shape frameShape - the frame shape value from the frame style
       int frameWidth - the width of the frame that is drawn  (read only)
       int lineWidth - the line width
       int margin - the width of the margin
       int midLineWidth - the width of the mid-line

   Protected Members
       virtual void paintEvent ( QPaintEvent * event )
       virtual void resizeEvent ( QResizeEvent * e )
       virtual void drawFrame ( QPainter * p )
       virtual void drawContents ( QPainter * )
       virtual void frameChanged ()

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):

       <center>
				   [Image Omitted]

       </center>

       See also Abstract Widget Classes.

   Member Type Documentation
QFrame::Shadow
       This enum type defines the 3D effect used for QFrame's frame.

       QFrame::Plain - the frame and contents appear level with the
       surroundings; draws using the palette foreground color (without any 3D
       effect)

       QFrame::Raised - the frame and contents appear raised; draws a 3D
       raised line using the light and dark colors of the current color group

       QFrame::Sunken - the frame and contents appear sunken; draws a 3D
       sunken line using the light and dark colors of the current color group

       QFrame::MShadow - internal; mask for the shadow

       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.

       QFrame::NoFrame - QFrame draws nothing

       QFrame::Box - QFrame draws a box around its contents

       QFrame::Panel - QFrame draws a panel to make the contents appear raised
       or sunken

       QFrame::StyledPanel - draws a rectangular panel with a look that
       depends on the current GUI style. It can be raised or sunken.

       QFrame::HLine - QFrame draws a horizontal line that frames nothing
       (useful as separator)

       QFrame::VLine - QFrame draws a vertical line that frames nothing
       (useful as separator)

       QFrame::GroupBoxPanel - draws a rectangular panel

       QFrame::WinPanel - draws a rectangular panel that can be raised or
       sunken like those in Windows 95. Specifying this shape sets the line
       width to 2 pixels. WinPanel is provided for compatibility. For GUI
       style independence we recommend using StyledPanel instead.

       QFrame::ToolBarPanel

       QFrame::MenuBarPanel

       QFrame::PopupPanel

       QFrame::LineEditPanel - is used to draw a frame suitable for line
       edits. The look depends upon the current GUI style.

       QFrame::TabWidgetPanel - is used to draw a frame suitable for tab
       widgets. The look depends upon the current GUI style.

       QFrame::MShape - internal mask

       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:

       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:

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().

SEE ALSO
       http://doc.trolltech.com/qframe.html
       http://www.trolltech.com/faq/tech.html

COPYRIGHT
       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the
       license file included in the distribution for a complete license
       statement.

AUTHOR
       Generated automatically from the source code.

BUGS
       If you find a bug in Qt, please report it as described in
       http://doc.trolltech.com/bughowto.html.	Good bug reports help us to
       help you. Thank you.

       The definitive Qt documentation is provided in HTML format; it is
       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
       web browser. This man page is provided as a convenience for those users
       who prefer man pages, although this format is not officially supported
       by Trolltech.

       If you find errors in this manual page, please report them to qt-
       bugs@trolltech.com.  Please include the name of the manual page
       (qframe.3qt) and the Qt version (3.3.8).

Trolltech AS			2 February 2007			   QFrame(3qt)
[top]

List of man pages available for Peanut

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net