\section{UIServer Class Reference}
\label{classUIServer}\index{UIServer@{UIServer}}
It's purpose is to show progress of IO operations. Graphical server for progress information with an optional all-in-one progress window.  


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

Inheritance diagram for UIServer:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=182pt]{classUIServer__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for UIServer:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=254pt]{classUIServer__coll__graph}
\end{center}
\end{figure}
\subsection*{DCOP Member Functions}
\begin{CompactItemize}
\item 
int {\bf new\-Job} ({\bf QCString} app\-Id, bool show\-Progress)
\begin{CompactList}\small\item\em Signal a new job. \item\end{CompactList}\item 
ASYNC {\bf job\-Finished} (int id)\label{classUIServer_z1}

\item 
ASYNC {\bf total\-Size} (int id, unsigned long size)\label{classUIServer_z2}

\item 
ASYNC {\bf total\-Size64} (int id, KIO::filesize\_\-t size)\label{classUIServer_z3}

\item 
ASYNC {\bf total\-Files} (int id, unsigned long files)\label{classUIServer_z4}

\item 
ASYNC {\bf total\-Dirs} (int id, unsigned long dirs)\label{classUIServer_z5}

\item 
ASYNC {\bf processed\-Size} (int id, unsigned long bytes)\label{classUIServer_z6}

\item 
ASYNC {\bf processed\-Size64} (int id, KIO::filesize\_\-t bytes)\label{classUIServer_z7}

\item 
ASYNC {\bf processed\-Files} (int id, unsigned long files)\label{classUIServer_z8}

\item 
ASYNC {\bf processed\-Dirs} (int id, unsigned long dirs)\label{classUIServer_z9}

\item 
ASYNC {\bf percent} (int id, unsigned long ipercent)\label{classUIServer_z10}

\item 
ASYNC {\bf speed} (int id, unsigned long bytes\_\-per\_\-second)\label{classUIServer_z11}

\item 
ASYNC {\bf info\-Message} (int id, const  {\bf QString} \&msg)\label{classUIServer_z12}

\item 
ASYNC {\bf copying} (int id, {\bf KURL} from, {\bf KURL} to)\label{classUIServer_z13}

\item 
ASYNC {\bf moving} (int id, {\bf KURL} from, {\bf KURL} to)\label{classUIServer_z14}

\item 
ASYNC {\bf deleting} (int id, {\bf KURL} url)\label{classUIServer_z15}

\item 
ASYNC {\bf transferring} (int id, {\bf KURL} url)\label{classUIServer_z16}

\item 
ASYNC {\bf creating\-Dir} (int id, {\bf KURL} dir)\label{classUIServer_z17}

\item 
ASYNC {\bf stating} (int id, {\bf KURL} url)\label{classUIServer_z18}

\item 
ASYNC {\bf mounting} (int id, {\bf QString} dev, {\bf QString} point)\label{classUIServer_z19}

\item 
ASYNC {\bf unmounting} (int id, {\bf QString} point)\label{classUIServer_z20}

\item 
ASYNC {\bf can\-Resume} (int id, unsigned long offset)\label{classUIServer_z21}

\item 
ASYNC {\bf can\-Resume64} (int id, KIO::filesize\_\-t offset)\label{classUIServer_z22}

\item 
{\bf QByte\-Array} {\bf open\-Pass\-Dlg} (const  {\bf KIO::Auth\-Info} \&info)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). \item\end{CompactList}\item 
int {\bf message\-Box} (int id, int type, const  {\bf QString} \&text, const  {\bf QString} \&caption, const  {\bf QString} \&button\-Yes, const  {\bf QString} \&button\-No)
\begin{CompactList}\small\item\em Popup a message box. \item\end{CompactList}\item 
{\bf QByte\-Array} {\bf open\_\-Rename\-Dlg64} (int id, const  {\bf QString} \&caption, const  {\bf QString} \&src, const  {\bf QString} \&dest, int mode, KIO::filesize\_\-t size\-Src, KIO::filesize\_\-t size\-Dest, unsigned long ctime\-Src, unsigned long ctime\-Dest, unsigned long mtime\-Src, unsigned long mtime\-Dest)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). \item\end{CompactList}\item 
{\bf QByte\-Array} {\bf open\_\-Rename\-Dlg} (int id, const  {\bf QString} \&caption, const  {\bf QString} \&src, const  {\bf QString} \&dest, int mode, unsigned long size\-Src, unsigned long size\-Dest, unsigned long ctime\-Src, unsigned long ctime\-Dest, unsigned long mtime\-Src, unsigned long mtime\-Dest)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). \item\end{CompactList}\item 
int {\bf open\_\-Skip\-Dlg} (int id, int multi, const  {\bf QString} \&error\_\-text)
\begin{CompactList}\small\item\em {\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). \item\end{CompactList}\item 
void {\bf set\-List\-Mode} (bool list)
\begin{CompactList}\small\item\em Switch to or from list mode - called by the kcontrol module. \item\end{CompactList}\item 
void {\bf set\-Job\-Visible} (int id, bool visible)
\begin{CompactList}\small\item\em Hide or show a job. \item\end{CompactList}\item 
void {\bf show\-SSLInfo\-Dialog} (const  {\bf QString} \&url, const  KIO::Meta\-Data \&data)
\begin{CompactList}\small\item\em Show a SSL Information Dialog. \item\end{CompactList}\item 
KSSLCert\-Dlg\-Ret {\bf show\-SSLCert\-Dialog} (const  {\bf QString} \&host, const  {\bf QString\-List} \&cert\-List)\label{classUIServer_z31}

\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Update} ()\label{classUIServer_j0}

\item 
void {\bf cancel\-Current} ()\label{classUIServer_j1}

\item 
void {\bf slot\-Toggle\-Default\-Progress} ({\bf QList\-View\-Item} $\ast$)\label{classUIServer_j2}

\item 
void {\bf slot\-Selection} ()\label{classUIServer_j3}

\item 
void {\bf slot\-Job\-Canceled} ({\bf Progress\-Item} $\ast$)\label{classUIServer_j4}

\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf Progress\-Item} $\ast$ {\bf find\-Item} (int id)\label{classUIServer_b0}

\item 
void {\bf close\-Event} ({\bf QClose\-Event} $\ast$)\label{classUIServer_b1}

\item 
void {\bf set\-Item\-Visible} ({\bf Progress\-Item} $\ast$item, bool visible)\label{classUIServer_b2}

\item 
void {\bf read\-Settings} ()\label{classUIServer_b3}

\end{CompactItemize}
\subsection*{Protected Attributes}
\begin{CompactItemize}
\item 
{\bf QTimer} $\ast$ {\bf update\-Timer}\label{classUIServer_p0}

\item 
{\bf List\-Progress} $\ast$ {\bf list\-Progress}\label{classUIServer_p1}

\item 
{\bf KTool\-Bar::Bar\-Position} {\bf toolbar\-Pos}\label{classUIServer_p2}

\item 
{\bf QString} {\bf properties}\label{classUIServer_p3}

\end{CompactItemize}


\subsection{Detailed Description}
It's purpose is to show progress of IO operations. Graphical server for progress information with an optional all-in-one progress window. 

There is only one instance of this window for all jobs.

All IO operations ( jobs ) are displayed in this window, one line per operation. User can cancel operations with Cancel button on toolbar.

Double clicking an item in the list opens a small download window ( Default\-Progress ).

\begin{Desc}
\item[Author:]David Faure $<${\tt faure@kde.org}$>$ 

Matej Koss $<${\tt koss@miesto.sk}$>$ \end{Desc}




Definition at line 186 of file uiserver.h.

\subsection{Member Function Documentation}
\index{UIServer@{UIServer}!newJob@{newJob}}
\index{newJob@{newJob}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int UIServer::new\-Job ({\bf QCString} {\em app\-Id}, bool {\em show\-Progress})}\label{classUIServer_z0}


Signal a new job. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em the}]DCOP application id of the job's parent application \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]KIO::Observer::new\-Job \end{Desc}
\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em show\-Progress}]whether to popup the progress for the job. Usually true, but may be false when we use kio\_\-uiserver for other things, like SSL dialogs. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]the job id \end{Desc}


Definition at line 441 of file uiserver.cpp.\index{UIServer@{UIServer}!openPassDlg@{openPassDlg}}
\index{openPassDlg@{openPassDlg}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QByte\-Array} UIServer::open\-Pass\-Dlg (const {\bf KIO::Auth\-Info} \& {\em info})}\label{classUIServer_z23}


{\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). 

Use {\bf KIO::Password\-Dialog::get\-Name\-And\-Password}{\rm (p.\,\pageref{classKIO_1_1PasswordDialog_e0})} instead. To be removed in {\bf KDE} 4.0. 

Definition at line 841 of file uiserver.cpp.\index{UIServer@{UIServer}!messageBox@{messageBox}}
\index{messageBox@{messageBox}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int UIServer::message\-Box (int {\em id}, int {\em type}, const {\bf QString} \& {\em text}, const {\bf QString} \& {\em caption}, const {\bf QString} \& {\em button\-Yes}, const {\bf QString} \& {\em button\-No})}\label{classUIServer_z24}


Popup a message box. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em type}]type of message box: Question\-Yes\-No, Warning\-Yes\-No, Warning\-Continue\-Cancel... This enum is defined in {\bf slavebase.h}{\rm (p.\,\pageref{slavebase_8h})}, it currently is: Question\-Yes\-No = 1, Warning\-Yes\-No = 2, Warning\-Continue\-Cancel = 3, Warning\-Yes\-No\-Cancel = 4, Information = 5, SSLMessage\-Box = 6 \item[{\em text}]Message string. May contain newlines. \item[{\em caption}]Message box title. \item[{\em button\-Yes}]The text for the first button. The default is i18n(\char`\"{}\&Yes\char`\"{}). \item[{\em button\-No}]The text for the second button. The default is i18n(\char`\"{}\&No\char`\"{}). Note: for Continue\-Cancel, button\-Yes is the continue button and button\-No is unused. and for Information, none is used. \end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]a button code, as defined in {\bf KMessage\-Box}, or 0 on communication error. \end{Desc}


Definition at line 860 of file uiserver.cpp.\index{UIServer@{UIServer}!open_RenameDlg64@{open\_\-RenameDlg64}}
\index{open_RenameDlg64@{open\_\-RenameDlg64}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QByte\-Array} UIServer::open\_\-Rename\-Dlg64 (int {\em id}, const {\bf QString} \& {\em caption}, const {\bf QString} \& {\em src}, const {\bf QString} \& {\em dest}, int {\em mode}, KIO::filesize\_\-t {\em size\-Src}, KIO::filesize\_\-t {\em size\-Dest}, unsigned long {\em ctime\-Src}, unsigned long {\em ctime\-Dest}, unsigned long {\em mtime\-Src}, unsigned long {\em mtime\-Dest})}\label{classUIServer_z25}


{\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). 

Use KIO::open\_\-Rename\-Dlg instead. To be removed in {\bf KDE} 4.0. 

Definition at line 940 of file uiserver.cpp.\index{UIServer@{UIServer}!open_RenameDlg@{open\_\-RenameDlg}}
\index{open_RenameDlg@{open\_\-RenameDlg}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QByte\-Array} UIServer::open\_\-Rename\-Dlg (int {\em id}, const {\bf QString} \& {\em caption}, const {\bf QString} \& {\em src}, const {\bf QString} \& {\em dest}, int {\em mode}, unsigned long {\em size\-Src}, unsigned long {\em size\-Dest}, unsigned long {\em ctime\-Src}, unsigned long {\em ctime\-Dest}, unsigned long {\em mtime\-Src}, unsigned long {\em mtime\-Dest})}\label{classUIServer_z26}


{\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). 

Use KIO::open\_\-Rename\-Dlg instead. To be removed in {\bf KDE} 4.0. 

Definition at line 925 of file uiserver.cpp.\index{UIServer@{UIServer}!open_SkipDlg@{open\_\-SkipDlg}}
\index{open_SkipDlg@{open\_\-SkipDlg}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}int UIServer::open\_\-Skip\-Dlg (int {\em id}, int {\em multi}, const {\bf QString} \& {\em error\_\-text})}\label{classUIServer_z27}


{\bf This class or method is obsolete, it is provided for compatibility only.} (it blocks other apps). 

Use KIO::open\_\-Skip\-Dlg instead. To be removed in {\bf KDE} 4.0. 

Definition at line 972 of file uiserver.cpp.\index{UIServer@{UIServer}!setListMode@{setListMode}}
\index{setListMode@{setListMode}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void UIServer::set\-List\-Mode (bool {\em list})}\label{classUIServer_z28}


Switch to or from list mode - called by the kcontrol module. 



Definition at line 800 of file uiserver.cpp.\index{UIServer@{UIServer}!setJobVisible@{setJobVisible}}
\index{setJobVisible@{setJobVisible}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void UIServer::set\-Job\-Visible (int {\em id}, bool {\em visible})}\label{classUIServer_z29}


Hide or show a job. 

Typically, we hide a job while a \char`\"{}skip\char`\"{} or \char`\"{}rename\char`\"{} dialog is being shown for this job. This prevents killing it from the uiserver. 

Definition at line 501 of file uiserver.cpp.\index{UIServer@{UIServer}!showSSLInfoDialog@{showSSLInfoDialog}}
\index{showSSLInfoDialog@{showSSLInfoDialog}!UIServer@{UIServer}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void UIServer::show\-SSLInfo\-Dialog (const {\bf QString} \& {\em url}, const KIO::Meta\-Data \& {\em data})}\label{classUIServer_z30}


Show a SSL Information Dialog. 



Definition at line 865 of file uiserver.cpp.

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