• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

Plasma

  • Plasma
  • Frame
Public Types | Public Member Functions | Protected Member Functions | Properties | List of all members
Plasma::Frame Class Reference

#include <Plasma/Widgets/Frame>

Inheritance diagram for Plasma::Frame:
Inheritance graph
[legend]

Public Types

enum  Shadow { Plain = 1, Raised = 2, Sunken = 3 }
 

Public Member Functions

 Frame (QGraphicsWidget *parent=0)
 
 ~Frame ()
 
FrameSvg::EnabledBorders enabledBorders () const
 
Shadow frameShadow () const
 
QString image () const
 
QWidget * nativeWidget () const
 
void setEnabledBorders (const FrameSvg::EnabledBorders borders)
 
void setFrameShadow (Shadow shadow)
 
void setImage (const QString &path)
 
void setStyleSheet (const QString &stylesheet)
 
void setText (QString text)
 
QString styleSheet () const
 
QString text () const
 

Protected Member Functions

void changeEvent (QEvent *event)
 
void paint (QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget=0)
 
void resizeEvent (QGraphicsSceneResizeEvent *event)
 
QSizeF sizeHint (Qt::SizeHint which, const QSizeF &constraint) const
 

Properties

Shadow frameShadow
 
QString image
 
QString styleSheet
 
QString text
 

Detailed Description

A widget that provides a simple frame.

A simple frame to group widgets, it can have a plain, sunken or raise aspect the default aspect is plain

Definition at line 43 of file frame.h.

Member Enumeration Documentation

enum Plasma::Frame::Shadow
Enumerator
Plain 
Raised 
Sunken 

Definition at line 53 of file frame.h.

Constructor & Destructor Documentation

Plasma::Frame::Frame ( QGraphicsWidget *  parent = 0)
explicit

Constructs a new Frame.

Parameters
parentthe parent of this widget

Definition at line 82 of file frame.cpp.

Plasma::Frame::~Frame ( )

Definition at line 95 of file frame.cpp.

Member Function Documentation

void Plasma::Frame::changeEvent ( QEvent *  event)
protected

Definition at line 270 of file frame.cpp.

FrameSvg::EnabledBorders Plasma::Frame::enabledBorders ( ) const

Convenience method to get the enabled borders.

Returns
what borders are painted
Since
4.4

Definition at line 134 of file frame.cpp.

Shadow Plasma::Frame::frameShadow ( ) const
Returns
the Frame's shadow style
QString Plasma::Frame::image ( ) const
Returns
the image path being displayed currently, or an empty string if none.
QWidget * Plasma::Frame::nativeWidget ( ) const
Returns
the native widget wrapped by this Frame

Definition at line 209 of file frame.cpp.

void Plasma::Frame::paint ( QPainter *  painter,
const QStyleOptionGraphicsItem *  option,
QWidget *  widget = 0 
)
protected

Definition at line 214 of file frame.cpp.

void Plasma::Frame::resizeEvent ( QGraphicsSceneResizeEvent *  event)
protected

Definition at line 239 of file frame.cpp.

void Plasma::Frame::setEnabledBorders ( const FrameSvg::EnabledBorders  borders)

Sets what borders should be painted.

Parameters
flagsborders we want to paint

Definition at line 125 of file frame.cpp.

void Plasma::Frame::setFrameShadow ( Shadow  shadow)

Sets the Frame's shadow style.

Parameters
shadowplain, raised or sunken

Definition at line 100 of file frame.cpp.

void Plasma::Frame::setImage ( const QString &  path)

Sets the path to an image to display.

Parameters
paththe path to the image; if a relative path, then a themed image will be loaded.

Definition at line 152 of file frame.cpp.

void Plasma::Frame::setStyleSheet ( const QString &  stylesheet)

Sets the stylesheet used to control the visual display of this Frame.

Parameters
stylesheeta CSS string

Definition at line 198 of file frame.cpp.

void Plasma::Frame::setText ( QString  text)

Set the text to display by this Frame.

Parameters
textthe text
Since
4.4

Definition at line 139 of file frame.cpp.

QSizeF Plasma::Frame::sizeHint ( Qt::SizeHint  which,
const QSizeF &  constraint 
) const
protected

Definition at line 250 of file frame.cpp.

QString Plasma::Frame::styleSheet ( ) const
Returns
the stylesheet currently used with this widget
QString Plasma::Frame::text ( ) const
Returns
text displayed from this Frame

Property Documentation

Frame::Shadow Plasma::Frame::frameShadow
readwrite

Definition at line 46 of file frame.h.

QString Plasma::Frame::image
readwrite

Definition at line 48 of file frame.h.

QString Plasma::Frame::styleSheet
readwrite

Definition at line 49 of file frame.h.

QString Plasma::Frame::text
readwrite

Definition at line 47 of file frame.h.


The documentation for this class was generated from the following files:
  • frame.h
  • frame.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:48:35 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Plasma

Skip menu "Plasma"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal