KDE 4.6 API Reference Nepomuk
Nepomuk::Utils::DynamicResourceFacet Class Reference
A facet that presents a dynamic lists of resources with the possibility to search for more. More...
#include <Nepomuk/Utils/DynamicResourceFacet>
Detailed Description
A facet that presents a dynamic lists of resources with the possibility to search for more.
The DynamicResourceFacet provides a way for the user to choose one or more resources which in combination with a property are used to construct Query::ComparisonTerm instances that make up the facet's term.
A typical use case would be the relation to a project or a person or a tag. The latter, however, is already provided via Facet::createTagFacet().
Usage is simple: set the property to use via setRelation() and optionally a resource type via setResourceType().
For customized query terms and resource listing DynamicResourceFacet might also be used as a base class for a new facet by reimplementing methods like resourceTerm() or getMoreResources().
- Warning:
- DynamicResourceFacet will create a local event loop in order to show a dialog when the user wants to search for more resource candidates.
- Since:
- 4.6
Definition at line 70 of file dynamicresourcefacet.h.
Constructor & Destructor Documentation
| Nepomuk::Utils::DynamicResourceFacet::DynamicResourceFacet | ( | QObject * | parent = 0 | ) |
Create a new empty facet.
| virtual Nepomuk::Utils::DynamicResourceFacet::~DynamicResourceFacet | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| void Nepomuk::Utils::DynamicResourceFacet::clearSelection | ( | ) | [virtual, slot] |
Clear the selection.
If selectionMode() is MatchOne the first choice will be selected.
Implements Nepomuk::Utils::Facet.
| int Nepomuk::Utils::DynamicResourceFacet::count | ( | ) | const [virtual] |
- Returns:
- The number of choices in the facet.
Implements Nepomuk::Utils::Facet.
| virtual QList<Resource> Nepomuk::Utils::DynamicResourceFacet::getMoreResources | ( | ) | const [protected, virtual] |
Used to query additional resources if maxRows() is too small to fit all candidates.
The default implementation simply uses SearchWidget to let the user query additional resources.
- Warning:
- The default implementation opens a dialog which will start a local event loop.
Reimplementations may use clientQuery() to optimize the resource selection.
- Returns:
- The list of resources that should be selected in addition to the already selected ones.
| KGuiItem Nepomuk::Utils::DynamicResourceFacet::guiItem | ( | int | index | ) | const [virtual] |
The parameters used to render the choice at index.
Reimplemented from Nepomuk::Utils::Facet.
| void Nepomuk::Utils::DynamicResourceFacet::handleClientQueryChange | ( | ) | [protected, virtual] |
Reimplemented to properly update the resource list on client query change.
Reimplemented from Nepomuk::Utils::Facet.
| bool Nepomuk::Utils::DynamicResourceFacet::isSelected | ( | int | index | ) | const [virtual] |
- Returns:
trueif the choice atindexis selected,falseotherwise.
Implements Nepomuk::Utils::Facet.
| int Nepomuk::Utils::DynamicResourceFacet::maxRows | ( | ) | const |
- Returns:
- The number of maximum rows set via setMaxRows().
| Query::Term Nepomuk::Utils::DynamicResourceFacet::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.
| Types::Property Nepomuk::Utils::DynamicResourceFacet::relation | ( | ) | const |
- Returns:
- The property set via setRelation()
| Nepomuk::Resource Nepomuk::Utils::DynamicResourceFacet::resourceAt | ( | int | i | ) | const |
- Returns:
- The resource that is represented by the choice at index
ior an invalid Resource in case is out of bounds or points to the "more" action.
| virtual Nepomuk::Resource Nepomuk::Utils::DynamicResourceFacet::resourceForTerm | ( | const Nepomuk::Query::Term & | queryTerm | ) | const [protected, virtual] |
Used by selectFromTerm() to convert terms into resources.
This is the counterpart to termForResource(). The default implementation checks if term is a Query::ComparisonTerm which uses relation().
When reimplementing this method termForResource() also needs to be reimplemented.
- Returns:
- The resource that is represented by
termif the latter has the form as terms generated by termForResource(), an invalid Resource otherwise.
| virtual Query::Query Nepomuk::Utils::DynamicResourceFacet::resourceQuery | ( | const Query::Query & | clientQuery | ) | const [protected, virtual] |
Construct the query that will be used to determine the resources that are presented as choices in the facet.
The default implementation uses resourceType() in combination with clientQuery to determine the resources that can actually change the final query results.
- Parameters:
-
clientQuery The query set via setClientQuery(). Reimplementations should use this to restrict the query to resources that actually change the final query results.
Reimplementations might also call the default implementation to simply add additional restrictions to the query like so:
Query::Query query = DynamicResourceFacet::resourceQuery( clientQuery ); query.setTerm( query.term() && myFancyQueryTerm );
- Returns:
- The query that is used to fetch resources to be provided as choices in this facet.
| Types::Class Nepomuk::Utils::DynamicResourceFacet::resourceType | ( | ) | const |
- Returns:
- The resource type set via setResourceType() or the range of relation() in case no specific resource type was set.
| QList<Resource> Nepomuk::Utils::DynamicResourceFacet::selectedResources | ( | ) | const |
- Returns:
- The currently selected resources.
| bool Nepomuk::Utils::DynamicResourceFacet::selectFromTerm | ( | const Nepomuk::Query::Term & | queryTerm | ) | [virtual, slot] |
The term is analyzed depending on the selectionMode().
- See also:
- Facet::selectFromTerm()
Implements Nepomuk::Utils::Facet.
| SelectionMode Nepomuk::Utils::DynamicResourceFacet::selectionMode | ( | ) | const [virtual] |
The selection mode set via setSelectionMode()
Implements Nepomuk::Utils::Facet.
| void Nepomuk::Utils::DynamicResourceFacet::setMaxRows | ( | int | max | ) |
Set the maximum rows to show by default.
Further resources are accessible through a search dialog. By default the number of max rows is 5.
| void Nepomuk::Utils::DynamicResourceFacet::setRelation | ( | const Types::Property & | prop | ) |
Set the property to use in the facet.
| void Nepomuk::Utils::DynamicResourceFacet::setResourceType | ( | const Types::Class & | type | ) |
This is optional and defaults to the property's range if not set.
| void Nepomuk::Utils::DynamicResourceFacet::setSelected | ( | int | index, |
| bool | selected = true |
||
| ) | [virtual, slot] |
Select or deselect the resource at index.
Implements Nepomuk::Utils::Facet.
| void Nepomuk::Utils::DynamicResourceFacet::setSelected | ( | const Nepomuk::Resource & | res, |
| bool | selected = true |
||
| ) | [slot] |
Select or deselect res.
If res is not of the correct type nothing happens.
| void Nepomuk::Utils::DynamicResourceFacet::setSelectionMode | ( | SelectionMode | mode | ) |
Set the selection mode to use in this facet.
The default is MatchAny.
| virtual Nepomuk::Query::Term Nepomuk::Utils::DynamicResourceFacet::termForResource | ( | const Resource & | res | ) | const [protected, virtual] |
Used by term() to construct the final query term this facet provides.
Reimplementing this method allows to customize the way the term is built.
The default implementation uses relation() in a Query::ComparisonTerm.
When reimplementing this method resourceForTerm() also needs to be reimplemented.
The documentation for this class was generated from the following file:
