• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KReplaceDialog Class Reference

A generic "replace" dialog. More...

#include <kreplacedialog.h>

Inheritance diagram for KReplaceDialog:
KFindDialog KDialog QDialog

List of all members.

Public Types

enum  Options { PromptOnReplace = 256, BackReference = 512 }

Public Member Functions

 KReplaceDialog (QWidget *parent=0, long options=0, const QStringList &findStrings=QStringList(), const QStringList &replaceStrings=QStringList(), bool hasSelection=true)
long options () const
QWidget * replaceExtension () const
QString replacement () const
QStringList replacementHistory () const
void setOptions (long options)
void setReplacementHistory (const QStringList &history)
virtual ~KReplaceDialog ()

Protected Member Functions

virtual void showEvent (QShowEvent *)

Detailed Description

A generic "replace" dialog.

Author:
S.R.Haque <srhaque@iee.org>

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:

Definition at line 52 of file kreplacedialog.h.


Member Enumeration Documentation

enum KReplaceDialog::Options
Enumerator:
PromptOnReplace 
BackReference 

Definition at line 61 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

Reimplemented from KFindDialog.

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.

Reimplemented from KFindDialog.

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  )  [protected, virtual]

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

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal