\section{KShared\-Pixmap Class Reference}
\label{classKSharedPixmap}\index{KSharedPixmap@{KSharedPixmap}}
Shared pixmap client.  


{\tt \#include $<$ksharedpixmap.h$>$}

Inheritance diagram for KShared\-Pixmap:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=82pt]{classKSharedPixmap__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KShared\-Pixmap:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=82pt]{classKSharedPixmap__coll__graph}
\end{center}
\end{figure}
\subsection*{Signals}
\begin{CompactItemize}
\item 
void {\bf done} (bool success)
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KShared\-Pixmap} ()
\item 
{\bf $\sim$KShared\-Pixmap} ()
\item 
bool {\bf load\-From\-Shared} (const {\bf QString} \&name, const {\bf QRect} \&{\bf rect}={\bf QRect}())
\item 
bool {\bf is\-Available} (const {\bf QString} \&name) const 
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
bool {\bf x11Event} (XEvent $\ast$)\label{classKSharedPixmap_b0}

\end{CompactItemize}


\subsection{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 {\bf KDE}. You can use it to copy (a part of) a shared pixmap into. KShared\-Pixmap inherits {\bf KPixmap} for that purpose.

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

An example: copy from a shared pixmap: 

\footnotesize\begin{verbatim}   KSharedPixmap *pm = new KSharedPixmap;
   connect(pm, SIGNAL(done(bool)), SLOT(slotDone(bool)));
   pm->loadFromShared("My Pixmap");
\end{verbatim}
\normalsize


\begin{Desc}
\item[Author:]Geert Jansen $<${\tt jansen@kde.org}$>$ \end{Desc}
\begin{Desc}
\item[Version:]\begin{Desc}
\item[Id]{\bf ksharedpixmap.h}{\rm (p.\,\pageref{ksharedpixmap_8h})} 363180 2004-11-15 14:50:36Z mueller \end{Desc}
\end{Desc}




Definition at line 52 of file ksharedpixmap.h.

\subsection{Constructor \& Destructor Documentation}
\index{KSharedPixmap@{KShared\-Pixmap}!KSharedPixmap@{KSharedPixmap}}
\index{KSharedPixmap@{KSharedPixmap}!KSharedPixmap@{KShared\-Pixmap}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KShared\-Pixmap::KShared\-Pixmap ()}\label{classKSharedPixmap_a0}


Construct an empty pixmap. 



Definition at line 64 of file ksharedpixmap.cpp.\index{KSharedPixmap@{KShared\-Pixmap}!~KSharedPixmap@{$\sim$KSharedPixmap}}
\index{~KSharedPixmap@{$\sim$KSharedPixmap}!KSharedPixmap@{KShared\-Pixmap}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KShared\-Pixmap::$\sim${\bf KShared\-Pixmap} ()}\label{classKSharedPixmap_a1}


Destroys the pixmap. 



Definition at line 72 of file ksharedpixmap.cpp.

\subsection{Member Function Documentation}
\index{KSharedPixmap@{KShared\-Pixmap}!loadFromShared@{loadFromShared}}
\index{loadFromShared@{loadFromShared}!KSharedPixmap@{KShared\-Pixmap}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KShared\-Pixmap::load\-From\-Shared (const {\bf QString} \& {\em name}, const {\bf QRect} \& {\em rect} = {\tt {\bf QRect}()})}\label{classKSharedPixmap_a2}


Load from a shared pixmap reference. 

The signal {\bf done()}{\rm (p.\,\pageref{classKSharedPixmap_l0})} is emitted when the operation has finished.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The shared pixmap name. \item[{\em rect}]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 KShared\-Pixmap's original use: sharing of the desktop background to achieve pseudo transparency. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if the shared pixmap exists and loading has started successfully, false otherwise. \end{Desc}


Definition at line 98 of file ksharedpixmap.cpp.

References QString::latin1(), and QPixmap::resize().

Referenced by KRoot\-Pixmap::repaint().\index{KSharedPixmap@{KShared\-Pixmap}!isAvailable@{isAvailable}}
\index{isAvailable@{isAvailable}!KSharedPixmap@{KShared\-Pixmap}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KShared\-Pixmap::is\-Available (const {\bf QString} \& {\em name}) const}\label{classKSharedPixmap_a3}


Check whether a shared pixmap is available. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The shared pixmap name. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]True if the shared pixmap is available, false otherwise. \end{Desc}


Definition at line 88 of file ksharedpixmap.cpp.

References QString::latin1().

Referenced by KRoot\-Pixmap::is\-Available().\index{KSharedPixmap@{KShared\-Pixmap}!done@{done}}
\index{done@{done}!KSharedPixmap@{KShared\-Pixmap}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KShared\-Pixmap::done (bool {\em success})\hspace{0.3cm}{\tt  [signal]}}\label{classKSharedPixmap_l0}


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

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em success}]True if successful, false otherwise. \end{description}
\end{Desc}


The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
ksharedpixmap.h\item 
ksharedpixmap.cpp\end{CompactItemize}
