• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeutils
 

tdeutils

Public Types | Public Member Functions | Protected Slots | List of all members
KReplaceDialog Class Reference
Main classes | Find and Replace classes

#include <kreplacedialog.h>

Inheritance diagram for KReplaceDialog:
KFindDialog KDialogBase KDialog

Public Types

enum  Options { PromptOnReplace = 256, BackReference = 512 }
 
- Public Types inherited from KFindDialog
enum  Options {
  WholeWordsOnly = 1, FromCursor = 2, SelectedText = 4, CaseSensitive = 8,
  FindBackwards = 16, RegularExpression = 32, FindIncremental = 64, MinimumUserOption = 65536
}
 

Public Member Functions

 KReplaceDialog (TQWidget *parent=0, const char *name=0, long options=0, const TQStringList &findStrings=TQStringList(), const TQStringList &replaceStrings=TQStringList(), bool hasSelection=true)
 
virtual ~KReplaceDialog ()
 
void setReplacementHistory (const TQStringList &history)
 
TQStringList replacementHistory () const
 
void setOptions (long options)
 
long options () const
 
TQString replacement () const
 
TQWidget * replaceExtension ()
 
- Public Member Functions inherited from KFindDialog
 KFindDialog (TQWidget *parent=0, const char *name=0, long options=0, const TQStringList &findStrings=TQStringList(), bool hasSelection=false)
 
 KFindDialog (bool modal, TQWidget *parent=0, const char *name=0, long options=0, const TQStringList &findStrings=TQStringList(), bool hasSelection=false)
 
virtual ~KFindDialog ()
 
void setFindHistory (const TQStringList &history)
 
TQStringList findHistory () const
 
void setHasSelection (bool hasSelection)
 
void setHasCursor (bool hasCursor)
 
void setSupportsBackwardsFind (bool supports)
 
void setSupportsCaseSensitiveFind (bool supports)
 
void setSupportsWholeWordsFind (bool supports)
 
void setSupportsRegularExpressionFind (bool supports)
 
void setOptions (long options)
 
long options () const
 
TQString pattern () const
 
void setPattern (const TQString &pattern)
 
TQWidget * findExtension ()
 

Protected Slots

void slotOk ()
 
virtual void showEvent (TQShowEvent *)
 
- Protected Slots inherited from KFindDialog
void slotOk ()
 
void slotSelectedTextToggled (bool)
 
void showPatterns ()
 
void showPlaceholders ()
 
void textSearchChanged (const TQString &)
 
void slotRegexCheckBoxToggled (bool checked)
 
void slotPlaceholdersCheckBoxToggled (bool checked)
 

Additional Inherited Members

- Protected Member Functions inherited from KFindDialog
virtual void showEvent (TQShowEvent *)
 
- Protected Member Functions inherited from KDialog
virtual void keyPressEvent (TQKeyEvent *)
 

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:

Definition at line 59 of file kreplacedialog.h.

Constructor & Destructor Documentation

KReplaceDialog::KReplaceDialog ( TQWidget *  parent = 0,
const char *  name = 0,
long  options = 0,
const TQStringList &  findStrings = TQStringList(),
const TQStringList &  replaceStrings = TQStringList(),
bool  hasSelection = true 
)

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

Parameters
parentThe parent object of this widget
nameThe name of this widget
optionsA bitfield of the Options to be enabled.
findStringsA TQStringList to insert in the combo box of text to find
replaceStringsA TQStringList to insert in the combo box of text to replace with
hasSelectionWhether a selection exists

Definition at line 45 of file kreplacedialog.cpp.

KReplaceDialog::~KReplaceDialog ( )
virtual

Destructor.

Definition at line 54 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.

Returns
The options.
See also
setOptions, Options, KFindDialog::Options

Definition at line 75 of file kreplacedialog.cpp.

TQWidget * KReplaceDialog::replaceExtension ( )

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.

Returns
An extensible TQWidget.

Definition at line 87 of file kreplacedialog.cpp.

TQString KReplaceDialog::replacement ( ) const

Returns the replacement string.

Returns
The replacement string.

Definition at line 98 of file kreplacedialog.cpp.

TQStringList KReplaceDialog::replacementHistory ( ) const

Returns the list of history items.

Returns
The replacement history.
See also
setReplacementHistory

Definition at line 103 of file kreplacedialog.cpp.

void KReplaceDialog::setOptions ( long  options)

Set the options which are enabled.

Parameters
optionsThe setting of the Options.
See also
Options, KFindDialog::Options

Definition at line 112 of file kreplacedialog.cpp.

void KReplaceDialog::setReplacementHistory ( const TQStringList &  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
historyThe replacement history.
See also
replacementHistory

Definition at line 119 of file kreplacedialog.cpp.


The documentation for this class was generated from the following files:
  • kreplacedialog.h
  • kreplacedialog.cpp

tdeutils

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

tdeutils

Skip menu "tdeutils"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  •     tdecore
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  • tdeioslave
  •   http
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeutils by doxygen 1.8.8
This website is maintained by Timothy Pearson.