KReplaceDialog Class Reference

#include <kreplacedialog.h>

Inheritance diagram for KReplaceDialog:

Public Types
enum	Options { PromptOnReplace = 256, BackReference = 512 }
Public Types inherited from KDialog
enum	ButtonCode {   None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,   Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,   No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,   User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }

Public Member Functions
	KReplaceDialog (QWidget *parent=0, long options=0, const QStringList &findStrings=QStringList(), const QStringList &replaceStrings=QStringList(), bool hasSelection=true)
virtual	~KReplaceDialog ()
long	options () const
QWidget *	replaceExtension () const
QString	replacement () const
QStringList	replacementHistory () const
void	setOptions (long options)
void	setReplacementHistory (const QStringList &history)
Public Member Functions inherited from KFindDialog
	KFindDialog (QWidget *parent=0, long options=0, const QStringList &findStrings=QStringList(), bool hasSelection=false, bool replaceDialog=false)
virtual	~KFindDialog ()
QWidget *	findExtension () const
QStringList	findHistory () const
long	options () const
QString	pattern () const
void	setFindHistory (const QStringList &history)
void	setHasCursor (bool hasCursor)
void	setHasSelection (bool hasSelection)
void	setOptions (long options)
void	setPattern (const QString &pattern)
void	setSupportsBackwardsFind (bool supports)
void	setSupportsCaseSensitiveFind (bool supports)
void	setSupportsRegularExpressionFind (bool supports)
void	setSupportsWholeWordsFind (bool supports)
Public Member Functions inherited from KDialog
	KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~KDialog ()
KPushButton *	button (ButtonCode id) const
KIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
QWidget *	mainWidget ()
virtual QSize	minimumSizeHint () const
void	restoreDialogSize (const KConfigGroup &config)
void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const KIcon &icon)
void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
virtual QSize	sizeHint () const

Protected Member Functions
virtual void	showEvent (QShowEvent *)
Protected Member Functions inherited from KDialog
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void	closeEvent (QCloseEvent *e)
virtual void	hideEvent (QHideEvent *)
virtual void	keyPressEvent (QKeyEvent *)

Additional Inherited Members
Public Slots inherited from KDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Signals inherited from KFindDialog
void	optionsChanged ()
Signals inherited from KDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()
Static Public Member Functions inherited from KDialog
static bool	avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void	centerOnScreen (QWidget *widget, int screen=-1)
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int	spacingHint ()
Protected Slots inherited from KDialog
virtual void	slotButtonClicked (int button)
void	updateGeometry ()
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

A generic "replace" dialog.

Author

S.R.Haque srhaq.nosp@m.ue@i.nosp@m.ee.or.nosp@m.g

Detail:

This widget inherits from KFindDialog and implements the following additional functionalities: a replacement string object and an area for a user-defined widget to extend the dialog.

Example:

To use the basic replace dialog:

To use your own extensions:

KDE Replace Dialog

Definition at line 54 of file kreplacedialog.h.

Member Enumeration Documentation

enum KReplaceDialog::Options

Enumerator
PromptOnReplace
BackReference

Definition at line 63 of file kreplacedialog.h.

Constructor & Destructor Documentation

KReplaceDialog::KReplaceDialog ( QWidget *  parent = 0, long  options = 0, const QStringList &  findStrings = QStringList(), const QStringList &  replaceStrings = QStringList(), bool  hasSelection = true  )

explicit

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

Parameters

parent	The parent object of this widget
options	A bitfield of the Options to be enabled.
findStrings	A QStringList to insert in the combo box of text to find
replaceStrings	A QStringList to insert in the combo box of text to replace with
hasSelection	Whether a selection exists

Definition at line 58 of file kreplacedialog.cpp.

KReplaceDialog::~KReplaceDialog ( )

virtual

Destructor.

Definition at line 66 of file kreplacedialog.cpp.

Member Function Documentation

long KReplaceDialog::options

(

)

const

Returns the state of the options.

Disabled options may be returned in an indeterminate state.

See also

setOptions

Definition at line 87 of file kreplacedialog.cpp.

QWidget * KReplaceDialog::replaceExtension

(

)

const

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 99 of file kreplacedialog.cpp.

QString KReplaceDialog::replacement

(

)

const

Returns the replacement string.

Definition at line 110 of file kreplacedialog.cpp.

QStringList KReplaceDialog::replacementHistory

(

)

const

Returns the list of history items.

See also

setReplacementHistory

Definition at line 115 of file kreplacedialog.cpp.

void KReplaceDialog::setOptions

(

long

options

)

Set the options which are enabled.

Parameters

options

The setting of the Options.

Definition at line 124 of file kreplacedialog.cpp.

void KReplaceDialog::setReplacementHistory

(

const QStringList &

history

)

Provide the list of strings to be displayed as the history of replacement strings.

strings might get truncated if it is too long.

Parameters

history

The replacement history.

See also

replacementHistory

Definition at line 131 of file kreplacedialog.cpp.

void KReplaceDialog::showEvent ( QShowEvent *  e )

protectedvirtual

Reimplemented from KFindDialog.

Definition at line 71 of file kreplacedialog.cpp.

---

The documentation for this class was generated from the following files:

• kreplacedialog.h
• kreplacedialog.cpp