.TH "KSharedPixmap" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KSharedPixmap \- Shared pixmap client.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ksharedpixmap.h>\fP
.PP
Inherits \fBQWidget\fP, and \fBKPixmap\fP.
.PP
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBdone\fP (bool success)"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKSharedPixmap\fP ()"
.br
.ti -1c
.RI "\fB~KSharedPixmap\fP ()"
.br
.ti -1c
.RI "bool \fBloadFromShared\fP (const \fBQString\fP &name, const \fBQRect\fP &\fBrect\fP=\fBQRect\fP())"
.br
.ti -1c
.RI "bool \fBisAvailable\fP (const \fBQString\fP &name) const "
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "bool \fBx11Event\fP (XEvent *)"
.br
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
This class is a client class to shared pixmaps in \fBKDE\fP. You can use it to copy (a part of) a shared pixmap into. KSharedPixmap inherits \fBKPixmap\fP for that purpose.
.PP
The server part of shared pixmaps is not implemented here. That part is provided by KPixmapServer, in the source file: kdebase/kdesktop/pixmapserver.cc.
.PP
An example: copy from a shared pixmap: 
.PP
.nf
   KSharedPixmap *pm = new KSharedPixmap;
   connect(pm, SIGNAL(done(bool)), SLOT(slotDone(bool)));
   pm->loadFromShared('My Pixmap');

.fi
.PP
.PP
\fBAuthor:\fP
.RS 4
Geert Jansen <jansen@kde.org> 
.RE
.PP
\fBVersion:\fP
.RS 4
\fBId\fP.RS 4
\fBksharedpixmap.h\fP 363180 2004-11-15 14:50:36Z mueller 
.RE
.PP
.RE
.PP

.PP
Definition at line 52 of file ksharedpixmap.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KSharedPixmap::KSharedPixmap ()"
.PP
Construct an empty pixmap. 
.PP
Definition at line 64 of file ksharedpixmap.cpp.
.SS "KSharedPixmap::~\fBKSharedPixmap\fP ()"
.PP
Destroys the pixmap. 
.PP
Definition at line 72 of file ksharedpixmap.cpp.
.SH "Member Function Documentation"
.PP 
.SS "bool KSharedPixmap::loadFromShared (const \fBQString\fP & name, const \fBQRect\fP & rect = \fC\fBQRect\fP()\fP)"
.PP
Load from a shared pixmap reference. 
.PP
The signal \fBdone()\fP is emitted when the operation has finished.
.PP
\fBParameters:\fP
.RS 4
\fIname\fP The shared pixmap name. 
.br
\fIrect\fP If you pass a nonzero rectangle, a tile is generated which is able to fill up the specified rectangle completely. This is solely for optimization: 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. 
.RE
.PP
\fBReturns:\fP
.RS 4
True if the shared pixmap exists and loading has started successfully, false otherwise. 
.RE
.PP

.PP
Definition at line 98 of file ksharedpixmap.cpp.
.PP
References QString::latin1(), and QPixmap::resize().
.PP
Referenced by KRootPixmap::repaint().
.SS "bool KSharedPixmap::isAvailable (const \fBQString\fP & name) const"
.PP
Check whether a shared pixmap is available. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP The shared pixmap name. 
.RE
.PP
\fBReturns:\fP
.RS 4
True if the shared pixmap is available, false otherwise. 
.RE
.PP

.PP
Definition at line 88 of file ksharedpixmap.cpp.
.PP
References QString::latin1().
.PP
Referenced by KRootPixmap::isAvailable().
.SS "void KSharedPixmap::done (bool success)\fC [signal]\fP"
.PP
This signal is raised when a pixmap load operation has finished. 
.PP
\fBParameters:\fP
.RS 4
\fIsuccess\fP True if successful, false otherwise. 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
