\section{KReplace\-Dialog Class Reference}
\label{classKReplaceDialog}\index{KReplaceDialog@{KReplaceDialog}}
A generic \char`\"{}replace\char`\"{} dialog.  


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

Inheritance diagram for KReplace\-Dialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=63pt]{classKReplaceDialog__inherit__graph}
\end{center}
\end{figure}
Collaboration diagram for KReplace\-Dialog:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=63pt]{classKReplaceDialog__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{CompactItemize}
\item 
enum {\bf Options} \{ {\bf Prompt\-On\-Replace} =  256, 
{\bf Back\-Reference} =  512
 \}
\end{CompactItemize}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KReplace\-Dialog} ({\bf QWidget} $\ast$parent=0, const  char $\ast$name=0, long options=0, const  {\bf QString\-List} \&find\-Strings={\bf QString\-List}(), const  {\bf QString\-List} \&replace\-Strings={\bf QString\-List}(), bool has\-Selection=true)
\begin{CompactList}\small\item\em Construct a replace dialog.read-only or rather select-only combo box with a parent object and a name. \item\end{CompactList}\item 
virtual {\bf $\sim$KReplace\-Dialog} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
void {\bf set\-Replacement\-History} (const  {\bf QString\-List} \&strings)
\begin{CompactList}\small\item\em Provide the list of {\tt strings} to be displayed as the history of replacement strings. \item\end{CompactList}\item 
{\bf QString\-List} {\bf replacement\-History} () const 
\begin{CompactList}\small\item\em Returns the list of history items. \item\end{CompactList}\item 
void {\bf set\-Options} (long options)
\begin{CompactList}\small\item\em Set the options which are enabled. \item\end{CompactList}\item 
long {\bf options} () const 
\begin{CompactList}\small\item\em Returns the state of the options. \item\end{CompactList}\item 
{\bf QString} {\bf replacement} () const 
\begin{CompactList}\small\item\em Returns the replacement string. \item\end{CompactList}\item 
{\bf QWidget} $\ast$ {\bf replace\-Extension} ()
\begin{CompactList}\small\item\em Returns an empty widget which the user may fill with additional UI elements as required. \item\end{CompactList}\end{CompactItemize}
\subsection*{Protected Slots}
\begin{CompactItemize}
\item 
void {\bf slot\-Ok} ()\label{classKReplaceDialog_j0}

\item 
virtual void {\bf show\-Event} ({\bf QShow\-Event} $\ast$)\label{classKReplaceDialog_j1}

\end{CompactItemize}


\subsection{Detailed Description}
A generic \char`\"{}replace\char`\"{} dialog. 

\begin{Desc}
\item[Author:]S.R.Haque $<${\tt srhaque@iee.org}$>$\end{Desc}


{\bf  Detail}

{\bf  This widget inherits from {\bf KFind\-Dialog}{\rm (p.\,\pageref{classKFindDialog})} and implements the following additional functionalities: a replacement string object and an area for a user-defined widget to extend the dialog.}

{\bf  }

{\bf {\bf  Example}}

{\bf {\bf  To use the basic replace dialog:}}

{\bf {\bf  \small\begin{alltt}
 \end{alltt}\normalsize 
}}

{\bf {\bf  To use your own extensions:}}

{\bf {\bf  \small\begin{alltt}
 \end{alltt}\normalsize 
 }}



Definition at line 57 of file kreplacedialog.h.

\subsection{Constructor \& Destructor Documentation}
\index{KReplaceDialog@{KReplace\-Dialog}!KReplaceDialog@{KReplaceDialog}}
\index{KReplaceDialog@{KReplaceDialog}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KReplace\-Dialog::KReplace\-Dialog ({\bf QWidget} $\ast$ {\em parent} = 0, const char $\ast$ {\em name} = 0, long {\em options} = 0, const {\bf QString\-List} \& {\em find\-Strings} = {\bf QString\-List}(), const {\bf QString\-List} \& {\em replace\-Strings} = {\bf QString\-List}(), bool {\em has\-Selection} = true)}\label{classKReplaceDialog_a0}


Construct a replace dialog.read-only or rather select-only combo box with a parent object and a name. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em parent}]The parent object of this widget \item[{\em name}]The name of this widget \item[{\em options}]A bitfield of the Options to be enabled. \item[{\em has\-Selection}]Whether a selection exists \end{description}
\end{Desc}


Definition at line 39 of file kreplacedialog.cpp.

References KStd\-Accel::name(), and set\-Options().\index{KReplaceDialog@{KReplace\-Dialog}!~KReplaceDialog@{$\sim$KReplaceDialog}}
\index{~KReplaceDialog@{$\sim$KReplaceDialog}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KReplace\-Dialog::$\sim${\bf KReplace\-Dialog} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKReplaceDialog_a1}


Destructor. 



Definition at line 48 of file kreplacedialog.cpp.

\subsection{Member Function Documentation}
\index{KReplaceDialog@{KReplace\-Dialog}!setReplacementHistory@{setReplacementHistory}}
\index{setReplacementHistory@{setReplacementHistory}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KReplace\-Dialog::set\-Replacement\-History (const {\bf QString\-List} \& {\em strings})}\label{classKReplaceDialog_a2}


Provide the list of {\tt strings} to be displayed as the history of replacement strings. 

{\tt strings} might get truncated if it is too long.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em history}]The replacement history. \end{description}
\end{Desc}
\begin{Desc}
\item[See also:]{\bf replacement\-History}{\rm (p.\,\pageref{classKReplaceDialog_a3})} \end{Desc}


Definition at line 99 of file kreplacedialog.cpp.\index{KReplaceDialog@{KReplace\-Dialog}!replacementHistory@{replacementHistory}}
\index{replacementHistory@{replacementHistory}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString\-List} KReplace\-Dialog::replacement\-History () const}\label{classKReplaceDialog_a3}


Returns the list of history items. 

\begin{Desc}
\item[See also:]{\bf set\-Replacement\-History}{\rm (p.\,\pageref{classKReplaceDialog_a2})} \end{Desc}


Definition at line 87 of file kreplacedialog.cpp.\index{KReplaceDialog@{KReplace\-Dialog}!setOptions@{setOptions}}
\index{setOptions@{setOptions}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KReplace\-Dialog::set\-Options (long {\em options})}\label{classKReplaceDialog_a4}


Set the options which are enabled. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em options}]The setting of the Options. \end{description}
\end{Desc}


Reimplemented from {\bf KFind\-Dialog} {\rm (p.\,\pageref{classKFindDialog_a6})}.

Definition at line 92 of file kreplacedialog.cpp.

References KFind\-Dialog::set\-Options().

Referenced by KReplace\-Dialog().\index{KReplaceDialog@{KReplace\-Dialog}!options@{options}}
\index{options@{options}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}long KReplace\-Dialog::options () const}\label{classKReplaceDialog_a5}


Returns the state of the options. 

Disabled options may be returned in an indeterminate state.

\begin{Desc}
\item[See also:]{\bf set\-Options}{\rm (p.\,\pageref{classKReplaceDialog_a4})} \end{Desc}


Reimplemented from {\bf KFind\-Dialog} {\rm (p.\,\pageref{classKFindDialog_a7})}.

Definition at line 59 of file kreplacedialog.cpp.

References KFind\-Dialog::options(), and options().

Referenced by options().\index{KReplaceDialog@{KReplace\-Dialog}!replacement@{replacement}}
\index{replacement@{replacement}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KReplace\-Dialog::replacement () const}\label{classKReplaceDialog_a6}


Returns the replacement string. 



Definition at line 82 of file kreplacedialog.cpp.\index{KReplaceDialog@{KReplace\-Dialog}!replaceExtension@{replaceExtension}}
\index{replaceExtension@{replaceExtension}!KReplaceDialog@{KReplace\-Dialog}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QWidget} $\ast$ KReplace\-Dialog::replace\-Extension ()}\label{classKReplaceDialog_a7}


Returns an empty widget which the user may fill with additional UI elements as required. 

The widget occupies the width of the dialog, and is positioned immediately the regular expression support widgets for the replacement string. 

Definition at line 71 of file kreplacedialog.cpp.

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