.TH "KReplaceDialog" 3 "28 Jan 2004" "kutils Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KReplaceDialog \- A generic 'replace' dialog.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kreplacedialog.h>\fP
.PP
Inherits \fBKFindDialog\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBOptions\fP { \fBPromptOnReplace\fP =  256, \fBBackReference\fP =  512 }"
.br
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKReplaceDialog\fP (\fBQWidget\fP *parent=0, const  char *name=0, long options=0, const  \fBQStringList\fP &findStrings=\fBQStringList\fP(), const  \fBQStringList\fP &replaceStrings=\fBQStringList\fP(), bool hasSelection=true)"
.br
.RI "\fIConstruct a replace dialog.read-only or rather select-only combo box with a parent object and a name. \fP"
.ti -1c
.RI "virtual \fB~KReplaceDialog\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBsetReplacementHistory\fP (const  \fBQStringList\fP &strings)"
.br
.RI "\fIProvide the list of \fCstrings\fP to be displayed as the history of replacement strings. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBreplacementHistory\fP () const "
.br
.RI "\fIReturns the list of history items. \fP"
.ti -1c
.RI "void \fBsetOptions\fP (long options)"
.br
.RI "\fISet the options which are enabled. \fP"
.ti -1c
.RI "long \fBoptions\fP () const "
.br
.RI "\fIReturns the state of the options. \fP"
.ti -1c
.RI "\fBQString\fP \fBreplacement\fP () const "
.br
.RI "\fIReturns the replacement string. \fP"
.ti -1c
.RI "\fBQWidget\fP * \fBreplaceExtension\fP ()"
.br
.RI "\fIReturns an empty widget which the user may fill with additional UI elements as required. \fP"
.in -1c
.SS "Protected Slots"

.in +1c
.ti -1c
.RI "void \fBslotOk\fP ()"
.br
.ti -1c
.RI "virtual void \fBshowEvent\fP (\fBQShowEvent\fP *)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A generic 'replace' dialog. 

\fBAuthor:\fP
.RS 4
S.R.Haque <srhaque@iee.org>
.RE
.PP
.PP
\fB Detail\fP
.PP
\fB This widget inherits from \fBKFindDialog\fP and implements the following additional functionalities: a replacement string object and an area for a user-defined widget to extend the dialog.\fP
.PP
\fB \fP
.PP
\fB\fB Example\fP\fP
.PP
\fB\fB To use the basic replace dialog:\fP\fP
.PP
\fB\fB 
.PP
.nf

 
.PP
\fP\fP
.PP
\fB\fB To use your own extensions:\fP\fP
.PP
\fB\fB 
.PP
.nf

 
.PP
 \fP\fP
.PP
Definition at line 57 of file kreplacedialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KReplaceDialog::KReplaceDialog (\fBQWidget\fP * parent = 0, const char * name = 0, long options = 0, const \fBQStringList\fP & findStrings = \fBQStringList\fP(), const \fBQStringList\fP & replaceStrings = \fBQStringList\fP(), bool hasSelection = true)"
.PP
Construct a replace dialog.read-only or rather select-only combo box with a parent object and a name. \fBParameters:\fP
.RS 4
\fIparent\fP The parent object of this widget 
.br
\fIname\fP The name of this widget 
.br
\fIoptions\fP A bitfield of the \fBOptions\fP to be enabled. 
.br
\fIhasSelection\fP Whether a selection exists 
.RE
.PP
Definition at line 39 of file kreplacedialog.cpp.
.PP
References KStdAccel::name(), and setOptions().
.SS "KReplaceDialog::~\fBKReplaceDialog\fP ()\fC [virtual]\fP"
.PP
Destructor. Definition at line 48 of file kreplacedialog.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KReplaceDialog::setReplacementHistory (const \fBQStringList\fP & strings)"
.PP
Provide the list of \fCstrings\fP to be displayed as the history of replacement strings. \fCstrings\fP might get truncated if it is too long.
.PP
\fBParameters:\fP
.RS 4
\fIhistory\fP The replacement history. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBreplacementHistory\fP 
.RE
.PP
Definition at line 99 of file kreplacedialog.cpp.
.SS "\fBQStringList\fP KReplaceDialog::replacementHistory () const"
.PP
Returns the list of history items. \fBSee also:\fP
.RS 4
\fBsetReplacementHistory\fP 
.RE
.PP
Definition at line 87 of file kreplacedialog.cpp.
.SS "void KReplaceDialog::setOptions (long options)"
.PP
Set the options which are enabled. \fBParameters:\fP
.RS 4
\fIoptions\fP The setting of the \fBOptions\fP. 
.RE
.PP
Reimplemented from \fBKFindDialog\fP.
.PP
Definition at line 92 of file kreplacedialog.cpp.
.PP
References KFindDialog::setOptions().
.PP
Referenced by KReplaceDialog().
.SS "long KReplaceDialog::options () const"
.PP
Returns the state of the options. Disabled options may be returned in an indeterminate state.
.PP
\fBSee also:\fP
.RS 4
\fBsetOptions\fP 
.RE
.PP
Reimplemented from \fBKFindDialog\fP.
.PP
Definition at line 59 of file kreplacedialog.cpp.
.PP
References KFindDialog::options(), and options().
.PP
Referenced by options().
.SS "\fBQString\fP KReplaceDialog::replacement () const"
.PP
Returns the replacement string. Definition at line 82 of file kreplacedialog.cpp.
.SS "\fBQWidget\fP * KReplaceDialog::replaceExtension ()"
.PP
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.

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