Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KCompletionMatches Class Reference

List for keeping matches returned from KCompletion. More...

#include <kcompletion.h>

Inheritance diagram for KCompletionMatches:

KSortableValueList< QString > List of all members.

Public Methods

void removeDuplicates ()
QStringList list (bool sort=true) const
bool sorting () const

Detailed Description

List for keeping matches returned from KCompletion.

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();
 

Definition at line 606 of file kcompletion.h.


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

void KCompletionMatches::removeDuplicates  
 

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

bool KCompletionMatches::sorting   const [inline]
 

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 633 of file kcompletion.h.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:07 2003 for kdelibs by doxygen1.2.18