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

KDEUI

KCompletionMatches Class Reference

This structure is returned by KCompletion::allWeightedMatches . More...

#include <kcompletion.h>

Inheritance diagram for KCompletionMatches:
KSortableList< QString >

List of all members.

Public Member Functions

 KCompletionMatches (const KCompletionMatchesWrapper &matches)
 KCompletionMatches (const KCompletionMatches &)
 KCompletionMatches (bool sort)
QStringList list (bool sort=true) const
KCompletionMatches & operator= (const KCompletionMatches &)
void removeDuplicates ()
bool sorting () const
 ~KCompletionMatches ()

Detailed Description

This structure is returned by KCompletion::allWeightedMatches .

It also keeps the weight of the matches, allowing you to modify some matches or merge them with matches from another call to allWeightedMatches(), and sort the matches after that in order to have the matches ordered correctly

Example (a simplified example of what Konqueror's completion does):

 KCompletionMatches matches = completion->allWeightedMatches( location );
 if( !location.startsWith( "www." ))
 matches += completion->allWeightedmatches( "www." + location" );
 matches.removeDuplicates();
 QStringList list = matches.list();

List for keeping matches returned from KCompletion

Definition at line 579 of file kcompletion.h.


Constructor & Destructor Documentation

KCompletionMatches::KCompletionMatches ( bool  sort  ) 

Default constructor.

Parameters:
sort if false, the matches won't be sorted before the conversion, use only if you're sure the sorting is not needed

Definition at line 859 of file kcompletion.cpp.

KCompletionMatches::KCompletionMatches ( const KCompletionMatches &  o  ) 

copy constructor.

Definition at line 842 of file kcompletion.cpp.

KCompletionMatches::KCompletionMatches ( const KCompletionMatchesWrapper &  matches  ) 

For internal use only.

Definition at line 864 of file kcompletion.cpp.

KCompletionMatches::~KCompletionMatches (  ) 

default destructor.

Definition at line 878 of file kcompletion.cpp.


Member Function Documentation

QStringList KCompletionMatches::list ( bool  sort = true  )  const

Returns the matches as a QStringList.

Parameters:
sort if false, the matches won't be sorted before the conversion, use only if you're sure the sorting is not needed
Returns:
the list of matches

Definition at line 883 of file kcompletion.cpp.

KCompletionMatches & KCompletionMatches::operator= ( const KCompletionMatches &  o  ) 

assignment operator.

Definition at line 849 of file kcompletion.cpp.

void KCompletionMatches::removeDuplicates (  ) 

Removes duplicate matches.

Needed only when you merged several matches results and there's a possibility of duplicates.

Definition at line 899 of file kcompletion.cpp.

bool KCompletionMatches::sorting (  )  const

If sorting() returns false, the matches aren't sorted by their weight, even if true is passed to list().

Returns:
true if the matches won't be sorted

Definition at line 894 of file kcompletion.cpp.


The documentation for this class was generated from the following files:
  • kcompletion.h
  • kcompletion.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