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

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kfinddialog.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
Inherited by \fBKReplaceDialog\fP.
.PP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBOptions\fP { \fBWholeWordsOnly\fP =  1, \fBFromCursor\fP =  2, \fBSelectedText\fP =  4, \fBCaseSensitive\fP =  8, \fBFindBackwards\fP =  16, \fBRegularExpression\fP =  32, \fBMinimumUserOption\fP =  65536 }"
.br
.in -1c
.SS "Signals"

.in +1c
.ti -1c
.RI "void \fBokClicked\fP ()"
.br
.RI "\fIThe OK button was pressed, the pattern was not empty, and if it is supposed to be a regular expression, it is known to be valid. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKFindDialog\fP (\fBQWidget\fP *parent=0, const  char *name=0, long options=0, const  \fBQStringList\fP &findStrings=\fBQStringList\fP(), bool hasSelection=false)"
.br
.RI "\fIConstruct a find dialog with a parent object and a name. \fP"
.ti -1c
.RI "virtual \fB~KFindDialog\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "void \fBsetFindHistory\fP (const  \fBQStringList\fP &strings)"
.br
.RI "\fIProvide the list of \fCstrings\fP to be displayed as the history of find strings. \fP"
.ti -1c
.RI "\fBQStringList\fP \fBfindHistory\fP () const "
.br
.RI "\fIReturns the list of history items. \fP"
.ti -1c
.RI "void \fBsetHasSelection\fP (bool hasSelection)"
.br
.RI "\fIEnable/disable the 'search in selection' option, depending on whether there actually is a selection. \fP"
.ti -1c
.RI "void \fBsetHasCursor\fP (bool hasCursor)"
.br
.RI "\fIHide/show the 'from cursor' option, depending on whether the application implements a cursor. \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 \fBpattern\fP () const "
.br
.RI "\fIReturns the pattern to find. \fP"
.ti -1c
.RI "void \fBsetPattern\fP (const  \fBQString\fP &pattern)"
.br
.RI "\fISets the pattern to find. \fP"
.ti -1c
.RI "\fBQWidget\fP * \fBfindExtension\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 "void \fBslotSelectedTextToggled\fP (bool)"
.br
.ti -1c
.RI "void \fBshowPatterns\fP ()"
.br
.ti -1c
.RI "void \fBshowPlaceholders\fP ()"
.br
.ti -1c
.RI "void \fBtextSearchChanged\fP (const  \fBQString\fP &)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBshowEvent\fP (\fBQShowEvent\fP *)"
.br
.in -1c
.SS "Friends"

.in +1c
.ti -1c
.RI "class \fBKReplaceDialog\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
A generic 'find' dialog. 

\fBAuthor:\fP
.RS 4
S.R.Haque <srhaque@iee.org>
.RE
.PP
.PP
\fB Detail\fP
.PP
\fB This widget inherits from \fBKDialogBase\fP and implements the following additional functionalities: a find 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 find dialog:\fP\fP
.PP
\fB\fB 
.PP
.nf

  KFindDialog dlg(....)
  if ( dlg.exec() != QDialog::Accepted )
      return;
.PP
\fP\fP
.PP
\fB\fB
.PP
.nf
  // proceed with \fBKFind\fP from here
 
.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 61 of file kfinddialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KFindDialog::KFindDialog (\fBQWidget\fP * parent = 0, const char * name = 0, long options = 0, const \fBQStringList\fP & findStrings = \fBQStringList\fP(), bool hasSelection = false)"
.PP
Construct a find dialog 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
\fIfindStrings\fP The find history, see \fBfindHistory\fP() 
.br
\fIhasSelection\fP Whether a selection exists 
.RE
.PP
Definition at line 52 of file kfinddialog.cpp.
.PP
References KStdAccel::name(), and setOptions().
.SS "KFindDialog::~\fBKFindDialog\fP ()\fC [virtual]\fP"
.PP
Destructor. Definition at line 70 of file kfinddialog.cpp.
.SH "Member Function Documentation"
.PP 
.SS "void KFindDialog::setFindHistory (const \fBQStringList\fP & strings)"
.PP
Provide the list of \fCstrings\fP to be displayed as the history of find strings. \fCstrings\fP might get truncated if it is too long.
.PP
\fBParameters:\fP
.RS 4
\fIhistory\fP The find history. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBfindHistory\fP 
.RE
.PP
Definition at line 262 of file kfinddialog.cpp.
.PP
References KHistoryCombo::clearHistory(), QComboBox::lineEdit(), and KHistoryCombo::setHistoryItems().
.SS "\fBQStringList\fP KFindDialog::findHistory () const"
.PP
Returns the list of history items. \fBSee also:\fP
.RS 4
\fBsetFindHistory\fP 
.RE
.PP
Definition at line 86 of file kfinddialog.cpp.
.PP
References KHistoryCombo::historyItems().
.SS "void KFindDialog::setHasSelection (bool hasSelection)"
.PP
Enable/disable the 'search in selection' option, depending on whether there actually is a selection. \fBParameters:\fP
.RS 4
\fIhasSelection\fP true if a selection exists 
.RE
.PP
Definition at line 274 of file kfinddialog.cpp.
.PP
References QCheckBox::setChecked().
.SS "void KFindDialog::setHasCursor (bool hasCursor)"
.PP
Hide/show the 'from cursor' option, depending on whether the application implements a cursor. \fBParameters:\fP
.RS 4
\fIhasCursor\fP true if the application features a cursor This is assumed to be the case by default. 
.RE
.PP
Definition at line 292 of file kfinddialog.cpp.
.PP
References options(), and QCheckBox::setChecked().
.SS "void KFindDialog::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 in \fBKReplaceDialog\fP.
.PP
Definition at line 299 of file kfinddialog.cpp.
.PP
References QCheckBox::setChecked().
.PP
Referenced by KFindDialog(), and KReplaceDialog::setOptions().
.SS "long KFindDialog::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 in \fBKReplaceDialog\fP.
.PP
Definition at line 230 of file kfinddialog.cpp.
.PP
References QCheckBox::isChecked(), and options().
.PP
Referenced by KReplaceDialog::options(), options(), and setHasCursor().
.SS "\fBQString\fP KFindDialog::pattern () const"
.PP
Returns the pattern to find. Definition at line 249 of file kfinddialog.cpp.
.PP
References QComboBox::currentText().
.SS "void KFindDialog::setPattern (const \fBQString\fP & pattern)"
.PP
Sets the pattern to find. Definition at line 254 of file kfinddialog.cpp.
.PP
References QComboBox::lineEdit().
.SS "\fBQWidget\fP * KFindDialog::findExtension ()"
.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 below the regular expression support widgets for the pattern string. Definition at line 75 of file kfinddialog.cpp.
.PP
References QGridLayout::addMultiCellWidget().
.SS "void KFindDialog::okClicked ()\fC [signal]\fP"
.PP
The OK button was pressed, the pattern was not empty, and if it is supposed to be a regular expression, it is known to be valid. Reimplemented from \fBKDialogBase\fP.

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