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

Plasma

  • Plasma
  • Dialog
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions

Plasma::Dialog Class Reference

A dialog that uses the Plasma style. More...

#include <Plasma/Dialog>

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

List of all members.

Public Types

enum  ResizeCorner {
  NoCorner = 0, NorthEast = 1, SouthEast = 2, NorthWest = 4,
  SouthWest = 8, All = NorthEast | SouthEast | NorthWest | SouthWest
}

Public Slots

void syncToGraphicsWidget ()

Signals

void dialogResized ()
void dialogVisible (bool status)

Public Member Functions

 Dialog (QWidget *parent=0, Qt::WindowFlags f=Qt::Window)
virtual ~Dialog ()
void animatedHide (Plasma::Direction direction)
void animatedShow (Plasma::Direction direction)
Plasma::AspectRatioMode aspectRatioMode () const
QGraphicsWidget * graphicsWidget ()
ResizeCorners resizeCorners () const
void setAspectRatioMode (Plasma::AspectRatioMode mode)
void setGraphicsWidget (QGraphicsWidget *widget)
void setResizeHandleCorners (ResizeCorners corners)

Protected Member Functions

bool event (QEvent *event)
bool eventFilter (QObject *watched, QEvent *event)
void focusInEvent (QFocusEvent *event)
void hideEvent (QHideEvent *event)
bool inControlArea (const QPoint &point)
void keyPressEvent (QKeyEvent *event)
void mouseMoveEvent (QMouseEvent *event)
void mousePressEvent (QMouseEvent *event)
void mouseReleaseEvent (QMouseEvent *event)
void moveEvent (QMoveEvent *event)
void paintEvent (QPaintEvent *e)
void resizeEvent (QResizeEvent *e)
void showEvent (QShowEvent *event)

Detailed Description

A dialog that uses the Plasma style.

Dialog provides a dialog-like widget that can be used to display additional information.

Dialog uses the plasma theme, and usually has no window decoration. It's meant as an interim solution to display widgets as extension to plasma applets, for example when you click on an applet like the devicenotifier or the clock, the widget that is then displayed, is a Dialog.

Definition at line 51 of file dialog.h.


Member Enumeration Documentation

enum Plasma::Dialog::ResizeCorner

Use these flags to choose the active resize corners.

Enumerator:
NoCorner 
NorthEast 
SouthEast 
NorthWest 
SouthWest 
All 

Definition at line 58 of file dialog.h.


Constructor & Destructor Documentation

Plasma::Dialog::Dialog ( QWidget *  parent = 0,
Qt::WindowFlags  f = Qt::Window 
) [explicit]
  • parent the parent widget, for plasmoids, this is usually 0.
  • f the Qt::WindowFlags, default is to not show a windowborder.

Definition at line 386 of file dialog.cpp.

Plasma::Dialog::~Dialog ( ) [virtual]

Definition at line 414 of file dialog.cpp.


Member Function Documentation

void Plasma::Dialog::animatedHide ( Plasma::Direction  direction)

Causes an animated hide; requires compositing to work, otherwise the dialog will simply hide.

Since:
4.3

Definition at line 754 of file dialog.cpp.

void Plasma::Dialog::animatedShow ( Plasma::Direction  direction)

Causes an animated show; requires compositing to work, otherwise the dialog will simply show.

Since:
4.3

Definition at line 783 of file dialog.cpp.

Plasma::AspectRatioMode Plasma::Dialog::aspectRatioMode ( ) const
Returns:
the preferred aspect ratio mode for placement and resizing
Since:
4.4

Definition at line 826 of file dialog.cpp.

void Plasma::Dialog::dialogResized ( ) [signal]

Fires when the dialog automatically resizes.

void Plasma::Dialog::dialogVisible ( bool  status) [signal]

Emit a signal when the dialog become visible/invisible.

bool Plasma::Dialog::event ( QEvent *  event) [protected]

Definition at line 536 of file dialog.cpp.

bool Plasma::Dialog::eventFilter ( QObject *  watched,
QEvent *  event 
) [protected]

Definition at line 664 of file dialog.cpp.

void Plasma::Dialog::focusInEvent ( QFocusEvent *  event) [protected]

Definition at line 720 of file dialog.cpp.

QGraphicsWidget * Plasma::Dialog::graphicsWidget ( )
Returns:
the graphics widget shown in this dialog

Definition at line 659 of file dialog.cpp.

void Plasma::Dialog::hideEvent ( QHideEvent *  event) [protected]

Definition at line 683 of file dialog.cpp.

bool Plasma::Dialog::inControlArea ( const QPoint &  point) [protected]

Convenience method to know whether the point is in a control area (e.g.

resize area) or not.

Returns:
true if the point is in the control area.

Definition at line 816 of file dialog.cpp.

void Plasma::Dialog::keyPressEvent ( QKeyEvent *  event) [protected]

Definition at line 529 of file dialog.cpp.

void Plasma::Dialog::mouseMoveEvent ( QMouseEvent *  event) [protected]

Definition at line 426 of file dialog.cpp.

void Plasma::Dialog::mousePressEvent ( QMouseEvent *  event) [protected]

Definition at line 501 of file dialog.cpp.

void Plasma::Dialog::mouseReleaseEvent ( QMouseEvent *  event) [protected]

Definition at line 518 of file dialog.cpp.

void Plasma::Dialog::moveEvent ( QMoveEvent *  event) [protected]

Definition at line 734 of file dialog.cpp.

void Plasma::Dialog::paintEvent ( QPaintEvent *  e) [protected]

Reimplemented from QWidget.

Definition at line 419 of file dialog.cpp.

Dialog::ResizeCorners Plasma::Dialog::resizeCorners ( ) const

Convenience method to get the enabled resize corners.

Returns:
which resize corners are active.

Definition at line 749 of file dialog.cpp.

void Plasma::Dialog::resizeEvent ( QResizeEvent *  e) [protected]

Definition at line 547 of file dialog.cpp.

void Plasma::Dialog::setAspectRatioMode ( Plasma::AspectRatioMode  mode)

Sets the preferred aspect ratio mode for placement and resizing.

Since:
4.4

Definition at line 831 of file dialog.cpp.

void Plasma::Dialog::setGraphicsWidget ( QGraphicsWidget *  widget)

Sets a QGraphicsWidget to be shown as the content in this dialog.

The dialog will then set up a QGraphicsView and coordinate geometry with the widget automatically.

  • widget the QGraphicsWidget to display in this dialog

Definition at line 605 of file dialog.cpp.

void Plasma::Dialog::setResizeHandleCorners ( ResizeCorners  corners)
  • corners the corners the resize handlers should be placed in.

Definition at line 741 of file dialog.cpp.

void Plasma::Dialog::showEvent ( QShowEvent *  event) [protected]

Definition at line 689 of file dialog.cpp.

void Plasma::Dialog::syncToGraphicsWidget ( ) [slot]

Adjusts the dialog to the associated QGraphicsWidget's geometry Should not normally need to be called by users of Dialog as Dialog does it automatically.

Event compression may cause unwanted delays, however, and so this method may be called to immediately cause a synchronization.

Since:
4.5

Definition at line 286 of file dialog.cpp.


The documentation for this class was generated from the following files:
  • dialog.h
  • dialog.cpp

Plasma

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

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal