Main Page Modules Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members Related Pages
KRootPixmap Class Reference
#include <krootpixmap.h>
List of all members.
Detailed Description
Creates pseudo-transparent widgets.
A pseudo-transparent widget is a widget with its background pixmap set to that part of the desktop background that it is currently obscuring. This gives a transparency effect.
To create a transparent widget, construct a KRootPixmap and pass it a pointer to your widget. That's it! Moving, resizing and background changes are handled automatically.
Instead of using the default behaviour, you can ask KRootPixmap to emit a backgroundUpdated(const QPixmap &) signal whenever the background needs updating by using setCustomPainting(bool). Alternatively by reimplementing updateBackground(KSharedPixmap*) you can take complete control of the behaviour.
- Author:
-
Geert Jansen <jansen@kde.org>
- Version:
-
- Id:
-
krootpixmap.h,v 1.14 2002/03/08 18:01:07 rich Exp
Definition at line 45 of file krootpixmap.h.
Constructor & Destructor Documentation
| KRootPixmap::KRootPixmap |
( |
QWidget * |
target, |
|
|
const char * |
name = 0 |
|
) |
|
|
|
|
Constructs a KRootPixmap. The KRootPixmap will be created as a child of the target widget so it will be deleted automatically when the widget is destroyed. - Parameters:
-
| target |
A pointer to the widget that you want to make pseudo transparent. |
|
| KRootPixmap::KRootPixmap |
( |
QWidget * |
target, |
|
|
QObject * |
parent, |
|
|
const char * |
name = 0 |
|
) |
|
|
|
|
Constructs a KRootPixmap where the parent QObject and target QWidget are different. |
| virtual KRootPixmap::~KRootPixmap |
( |
|
) |
[virtual] |
|
Member Function Documentation
| void KRootPixmap::backgroundUpdated |
( |
const QPixmap & |
pm |
) |
[signal] |
|
|
|
Emitted when the background needs updating and custom painting (see setCustomPainting(bool) ) is enabled. - Parameters:
-
| pm |
A pixmap containing the new background. |
|
| bool KRootPixmap::checkAvailable |
( |
bool |
|
) |
[inline] |
|
| int KRootPixmap::currentDesktop |
( |
|
) |
|
|
|
|
Returns the number of the current desktop. |
| bool KRootPixmap::customPainting |
( |
|
) |
const [inline] |
|
| void KRootPixmap::enableExports |
( |
|
) |
[slot] |
|
|
|
Asks KDesktop to export the desktop background as a KSharedPixmap. This method uses DCOP to call KBackgroundIface/setExport(int). |
| virtual bool KRootPixmap::eventFilter |
( |
QObject * |
, |
|
|
QEvent * |
|
|
) |
[protected, virtual] |
|
|
|
Reimplemented to filter the events from the target widget and track its movements. |
| bool KRootPixmap::isActive |
( |
|
) |
const [inline] |
|
|
|
Returns true if the KRootPixmap is active.
Definition at line 80 of file krootpixmap.h. |
| bool KRootPixmap::isAvailable |
( |
|
) |
|
|
|
|
Checks if pseudo-transparency is available. - Returns:
-
true if transparency is available, false otherwise.
Referenced by checkAvailable(). |
| void KRootPixmap::repaint |
( |
|
) |
[slot] |
|
|
|
Repaints the widget background. Normally, you shouldn't need this as it is handled automatically. This is equivalent to calling repaint( false ). |
| void KRootPixmap::repaint |
( |
bool |
force |
) |
[slot] |
|
|
|
Repaints the widget background. Normally, you shouldn't need this as it is handled automatically. - Parameters:
-
| force |
Force a repaint, even if the contents did not change. |
|
| void KRootPixmap::setCustomPainting |
( |
bool |
enable |
) |
[inline, slot] |
|
|
|
Enables custom handling of the background painting. If custom painting is enabled then KRootPixmap will emit a backgroundUpdated() signal when the background for the target widget changes, instead of applying the new background.
Definition at line 145 of file krootpixmap.h. |
| void KRootPixmap::setFadeEffect |
( |
double |
strength, |
|
|
const QColor & |
color |
|
) |
[slot] |
|
|
|
Sets the fade effect.
This effect will fade the background to the specified color. - Parameters:
-
| strength |
A value between 0 and 1, indicating the strength of the fade. A value of 0 will not change the image, a value of 1 will make it the fade color everywhere, and in between. |
| color |
The color to fade to. |
|
| virtual void KRootPixmap::start |
( |
|
) |
[virtual, slot] |
|
|
|
Starts background handling. |
| virtual void KRootPixmap::stop |
( |
|
) |
[virtual, slot] |
|
|
|
Stops background handling. |
| virtual void KRootPixmap::updateBackground |
( |
KSharedPixmap * |
|
) |
[protected, virtual] |
|
|
|
Called when the pixmap has been updated. The default implementation applies the fade effect, then sets the target's background, or emits backgroundUpdated(const QPixmap &) depending on the painting mode. |
The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:22 2003 for kdelibs by
1.2.18