A simple facet using a list of terms. More...

#include <Nepomuk/Utils/SimpleFacet>

Inheritance diagram for Nepomuk::Utils::SimpleFacet:

Public Slots
void	addTerm (const QString &text, const Nepomuk::Query::Term &queryTerm)
void	addTerm (const KGuiItem &item, const Nepomuk::Query::Term &queryTerm)
void	clear ()
void	clearSelection ()
bool	selectFromTerm (const Nepomuk::Query::Term &queryTerm)
void	setSelected (int index, bool selected=true)
Public Member Functions
	SimpleFacet (QObject *parent=0)
	~SimpleFacet ()
int	count () const
KGuiItem	guiItem (int index) const
bool	isSelected (int index) const
Query::Term	queryTerm () const
SelectionMode	selectionMode () const
void	setSelectionMode (SelectionMode mode)
Query::Term	termAt (int index) const

Detailed Description

A simple facet using a list of terms.

The SimpleFacet maintains a list of Query::Term objects combined with a label (or a full KGuiItem if required). The usage is very simple: Create a new instance of SimpleFacet, add terms via the addTerm() methods, choose a selection mode via setSelectionMode(), and let SimpleFacet do the rest.

SimpleFacet even implements the selectFromTerm() method which provides enhanced user experience by converting queries into facets.

Author:: Sebastian Trueg <trueg@kde.org>

Since:: 4.6

Definition at line 50 of file simplefacet.h.

Constructor & Destructor Documentation

Nepomuk::Utils::SimpleFacet::SimpleFacet ( QObject * parent = 0 )

Create a new empty facet.

Nepomuk::Utils::SimpleFacet::~SimpleFacet ( )

Destructor.

Member Function Documentation

void Nepomuk::Utils::SimpleFacet::addTerm	(	const QString &	text,
		const Nepomuk::Query::Term &	queryTerm
	)		`[slot]`

Add a new term.

This is equivalent to calling

 addTerm(KGuiItem(text), term);

void Nepomuk::Utils::SimpleFacet::addTerm	(	const KGuiItem &	item,
		const Nepomuk::Query::Term &	queryTerm
	)		`[slot]`

Add a new term.

Parameters:

item	The gui item used to present the choice to the user.
term	The query term which represents this choice.

void Nepomuk::Utils::SimpleFacet::clear ( ) [slot]

Clear the list of terms.

void Nepomuk::Utils::SimpleFacet::clearSelection ( ) [virtual, slot]

Clear the selection.

If selectionMode() is MatchOne the first choice should be selected.

Implements Nepomuk::Utils::Facet.

int Nepomuk::Utils::SimpleFacet::count ( ) const [virtual]

Returns:: The number of terms added via addTerm().

Implements Nepomuk::Utils::Facet.

KGuiItem Nepomuk::Utils::SimpleFacet::guiItem ( int index ) const [virtual]

Returns:: The gui item set via addTerm() for the Term at index or an empty KGuiItem if index is out of range.

Reimplemented from Nepomuk::Utils::Facet.

bool Nepomuk::Utils::SimpleFacet::isSelected ( int index ) const [virtual]

Returns:: true if the term at index has been selected via setSelected().

Implements Nepomuk::Utils::Facet.

Query::Term Nepomuk::Utils::SimpleFacet::queryTerm ( ) const [virtual]

Returns:: The currently selected Term. Depending on the selectionMode() this is either a single Term, a combination through Query::AndTerm, or a combination through Query::OrTerm.

Implements Nepomuk::Utils::Facet.

bool Nepomuk::Utils::SimpleFacet::selectFromTerm ( const Nepomuk::Query::Term & queryTerm ) [virtual, slot]

The term is analyzed depending on the selectionMode().