class KSharedPixmap

 Shared pixmap client. More...
Definition#include <ksharedpixmap.h>
InheritsKPixmap (kdecore), QWidget (qt)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Signals

Protected Methods

Detailed Description

Shared pixmap client.

A shared pixmap is a pixmap that resides on the X server, is referenced by a global id string, and can be accessed by all X clients.

This class is a client class to shared pixmaps in KDE. You can use it to copy (a part of) a shared pixmap into. KSharedPixmap inherits KPixmap for that purpose.

The server part of shared pixmaps is not implemented here. That part is provided by KPixmapServer, in the source file: kdebase/kdesktop/pixmapserver.cc.

An example: copy from a shared pixmap: 


   KSharedPixmap *pm = new KSharedPixmap;
   connect(pm, SIGNAL(done(bool)), SLOT(slotDone(bool)));
   pm->loadFromShared("My Pixmap");

 KSharedPixmap ()

Construct an empty pixmap.

~ KSharedPixmap ()

Destroys the pixmap.

bool  loadFromShared (QString name, QRect rect=QRect())

Load from a shared pixmap reference. The signal done() is emitted when the operation has finished.

Parameters:
nameThe shared pixmap name.
rectIf you pass a nonzero rectangle, a tile is generated which is able to fill up the specified rectangle completely. This is solely for optimisation: in some cases the tile will be much smaller than the original pixmap. It reflects KSharedPixmap's original use: sharing of the desktop background to achieve pseudo transparency.

Returns: True if the shared pixmap exists and loading has started successfully, false otherwise.

bool  isAvailable (QString name)

Check whether a shared pixmap is available.

Parameters:
nameThe shared pixmap name.

Returns: True if the shared pixmap is available, false otherwise.

void  done (bool success)

[signal]

This signal is raised when a pixmap load operation has finished.

Parameters:
successTrue if successfull, false otherwise.