Akonadi::ItemMonitor
#include <itemmonitor.h>
Public Member Functions | |
ItemMonitor () | |
virtual | ~ItemMonitor () |
Item | item () const |
void | setItem (const Item &item) |
Protected Member Functions | |
ItemFetchScope & | fetchScope () |
virtual void | itemChanged (const Item &item) |
virtual void | itemRemoved () |
void | setFetchScope (const ItemFetchScope &fetchScope) |
Detailed Description
A convenience class to monitor a single item for changes.
This class can be used as a base class for classes that want to show a single item to the user and keep track of status changes of the item without having to using a Monitor object themself.
Example:
Definition at line 69 of file itemmonitor.h.
Constructor & Destructor Documentation
◆ ItemMonitor()
ItemMonitor::ItemMonitor | ( | ) |
Creates a new item monitor.
Definition at line 14 of file itemmonitor.cpp.
◆ ~ItemMonitor()
|
virtualdefault |
Destroys the item monitor.
Member Function Documentation
◆ fetchScope()
|
protected |
Returns the item fetch scope.
Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.
- Returns
- a reference to the current item fetch scope
- See also
- setFetchScope() for replacing the current item fetch scope
Definition at line 66 of file itemmonitor.cpp.
◆ item()
Item ItemMonitor::item | ( | ) | const |
Returns the currently monitored item.
Definition at line 47 of file itemmonitor.cpp.
◆ itemChanged()
|
protectedvirtual |
This method is called whenever the monitored item has changed.
- Parameters
-
item The changed item.
Definition at line 52 of file itemmonitor.cpp.
◆ itemRemoved()
|
protectedvirtual |
This method is called whenever the monitored item has been removed.
Definition at line 57 of file itemmonitor.cpp.
◆ setFetchScope()
|
protected |
Sets the item fetch scope.
Controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.
- Parameters
-
fetchScope The new scope for item fetch operations.
- See also
- fetchScope()
Definition at line 61 of file itemmonitor.cpp.
◆ setItem()
void ItemMonitor::setItem | ( | const Item & | item | ) |
Sets the item
that shall be monitored.
Definition at line 21 of file itemmonitor.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 18 2024 12:08:30 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.