• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

Nepomuk

  • nepomuk
  • utils
dynamicresourcefacet.h
Go to the documentation of this file.
1 /*
2  This file is part of the Nepomuk KDE project.
3  Copyright (C) 2010 Sebastian Trueg <trueg@kde.org>
4 
5  This library is free software; you can redistribute it and/or
6  modify it under the terms of the GNU Lesser General Public
7  License as published by the Free Software Foundation; either
8  version 2.1 of the License, or (at your option) version 3, or any
9  later version accepted by the membership of KDE e.V. (or its
10  successor approved by the membership of KDE e.V.), which shall
11  act as a proxy defined in Section 6 of version 3 of the license.
12 
13  This library is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16  Lesser General Public License for more details.
17 
18  You should have received a copy of the GNU Lesser General Public
19  License along with this library. If not, see <http://www.gnu.org/licenses/>.
20 */
21 
22 #ifndef _NEPOMUK_QUERY_DYNAMIC_RESOURCE_FACET_H_
23 #define _NEPOMUK_QUERY_DYNAMIC_RESOURCE_FACET_H_
24 
25 #include "facet.h"
26 #include "nepomukutils_export.h"
27 
28 #include <QtCore/QList>
29 
30 namespace Nepomuk {
31  class Resource;
32  namespace Types {
33  class Property;
34  class Class;
35  }
36  namespace Query {
37  class Result;
38  }
39 
40  namespace Utils {
70  class NEPOMUKUTILS_EXPORT DynamicResourceFacet : public Facet
71  {
72  Q_OBJECT
73 
74  public:
78  DynamicResourceFacet( QObject* parent = 0 );
79 
83  virtual ~DynamicResourceFacet();
84 
90  Query::Term queryTerm() const;
91 
95  void setSelectionMode( SelectionMode mode );
96 
100  SelectionMode selectionMode() const;
101 
105  int count() const;
106 
110  KGuiItem guiItem( int index ) const;
111 
115  bool isSelected( int index ) const;
116 
120  void setRelation( const Types::Property& prop );
121 
126  void setResourceType( const Types::Class& type );
127 
133  void setMaxRows( int max );
134 
138  Types::Property relation() const;
139 
144  Types::Class resourceType() const;
145 
149  int maxRows() const;
150 
156  Nepomuk::Resource resourceAt( int i ) const;
157 
161  QList<Resource> selectedResources() const;
162 
163  public Q_SLOTS:
168  void clearSelection();
169 
173  void setSelected( int index, bool selected = true );
174 
179  void setSelected( const Nepomuk::Resource& res, bool selected = true );
180 
186  bool selectFromTerm( const Nepomuk::Query::Term& queryTerm );
187 
188  protected:
211  virtual Query::Query resourceQuery( const Query::Query& clientQuery ) const;
212 
221  virtual Nepomuk::Query::Term termForResource( const Resource& res ) const;
222 
233  virtual Nepomuk::Resource resourceForTerm( const Nepomuk::Query::Term& queryTerm ) const;
234 
250  virtual QList<Resource> getMoreResources() const;
251 
255  void handleClientQueryChange();
256 
257 #ifdef BUILDING_NEPOMUK_TESTS
258  protected:
259 #else
260  private:
261 #endif
262  class Private;
263  Private* d;
264 
265  Q_PRIVATE_SLOT( d, void _k_newEntries( const QList<Nepomuk::Query::Result>& ) )
266  Q_PRIVATE_SLOT( d, void _k_populateFinished() )
267  };
268  }
269 }
270 
271 #endif
Nepomuk::Query::Query
A Nepomuk desktop query.
Definition: query.h:77
Nepomuk::Query::Term
The base class for all term types.
Definition: term.h:65
Nepomuk::Resource
Resource is the central object type in Nepomuk.
Definition: resource.h:95
Nepomuk::Types::Class
A Class is a resource of type rdf:Class.
Definition: class.h:50
Nepomuk::Types::Property
A property is a resource of type rdf:Property which relates a domain with a range.
Definition: property.h:53
Nepomuk::Utils::DynamicResourceFacet
A facet that presents a dynamic lists of resources with the possibility to search for more.
Definition: dynamicresourcefacet.h:71
Nepomuk::Utils::DynamicResourceFacet::maxRows
int maxRows() const
Nepomuk::Utils::DynamicResourceFacet::resourceQuery
virtual Query::Query resourceQuery(const Query::Query &clientQuery) const
Construct the query that will be used to determine the resources that are presented as choices in the...
Nepomuk::Utils::DynamicResourceFacet::setResourceType
void setResourceType(const Types::Class &type)
This is optional and defaults to the property's range if not set.
Nepomuk::Utils::DynamicResourceFacet::DynamicResourceFacet
DynamicResourceFacet(QObject *parent=0)
Create a new empty facet.
Nepomuk::Utils::DynamicResourceFacet::~DynamicResourceFacet
virtual ~DynamicResourceFacet()
Destructor.
Nepomuk::Utils::DynamicResourceFacet::handleClientQueryChange
void handleClientQueryChange()
Reimplemented to properly update the resource list on client query change.
Nepomuk::Utils::DynamicResourceFacet::setSelected
void setSelected(int index, bool selected=true)
Select or deselect the resource at index.
Nepomuk::Utils::DynamicResourceFacet::resourceForTerm
virtual Nepomuk::Resource resourceForTerm(const Nepomuk::Query::Term &queryTerm) const
Used by selectFromTerm() to convert terms into resources.
Nepomuk::Utils::DynamicResourceFacet::setSelectionMode
void setSelectionMode(SelectionMode mode)
Set the selection mode to use in this facet.
Nepomuk::Utils::DynamicResourceFacet::getMoreResources
virtual QList< Resource > getMoreResources() const
Used to query additional resources if maxRows() is too small to fit all candidates.
Nepomuk::Utils::DynamicResourceFacet::setMaxRows
void setMaxRows(int max)
Set the maximum rows to show by default.
Nepomuk::Utils::DynamicResourceFacet::selectFromTerm
bool selectFromTerm(const Nepomuk::Query::Term &queryTerm)
The term is analyzed depending on the selectionMode().
Nepomuk::Utils::DynamicResourceFacet::setSelected
void setSelected(const Nepomuk::Resource &res, bool selected=true)
Select or deselect res.
Nepomuk::Utils::DynamicResourceFacet::termForResource
virtual Nepomuk::Query::Term termForResource(const Resource &res) const
Used by term() to construct the final query term this facet provides.
Nepomuk::Utils::DynamicResourceFacet::isSelected
bool isSelected(int index) const
Nepomuk::Utils::DynamicResourceFacet::resourceAt
Nepomuk::Resource resourceAt(int i) const
Nepomuk::Utils::DynamicResourceFacet::selectionMode
SelectionMode selectionMode() const
The selection mode set via setSelectionMode()
Nepomuk::Utils::DynamicResourceFacet::resourceType
Types::Class resourceType() const
Nepomuk::Utils::DynamicResourceFacet::relation
Types::Property relation() const
Nepomuk::Utils::DynamicResourceFacet::clearSelection
void clearSelection()
Clear the selection.
Nepomuk::Utils::DynamicResourceFacet::queryTerm
Query::Term queryTerm() const
Nepomuk::Utils::DynamicResourceFacet::guiItem
KGuiItem guiItem(int index) const
The parameters used to render the choice at index.
Nepomuk::Utils::DynamicResourceFacet::count
int count() const
Nepomuk::Utils::DynamicResourceFacet::setRelation
void setRelation(const Types::Property &prop)
Set the property to use in the facet.
Nepomuk::Utils::DynamicResourceFacet::selectedResources
QList< Resource > selectedResources() const
Nepomuk::Utils::Facet
The base class for all facets used to create query filters.
Definition: facet.h:75
Nepomuk::Utils::Facet::SelectionMode
SelectionMode
A Facet can have one of three selection modes which is provided by selectionMode().
Definition: facet.h:93
QObject
facet.h
nepomukutils_export.h
NEPOMUKUTILS_EXPORT
#define NEPOMUKUTILS_EXPORT
Definition: nepomukutils_export.h:36
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Feb 3 2022 00:00:00 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Nepomuk

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

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal