|
|
              
QOrganizerAbstractRequest ClassThe QOrganizerAbstractRequest class provides a mechanism for asynchronous requests to be made of a manager if it supports them. More... #include <QOrganizerAbstractRequest>Inherits: QObject. Inherited by: QOrganizerCollectionFetchRequest, QOrganizerCollectionRemoveRequest, QOrganizerCollectionSaveRequest, QOrganizerItemFetchByIdRequest, QOrganizerItemFetchForExportRequest, QOrganizerItemFetchRequest, QOrganizerItemIdFetchRequest, QOrganizerItemOccurrenceFetchRequest, QOrganizerItemRemoveByIdRequest, QOrganizerItemRemoveRequest, and QOrganizerItemSaveRequest. Public Types
Public Functions
Public Slots
Signals
Additional Inherited Members
Detailed DescriptionThe QOrganizerAbstractRequest class provides a mechanism for asynchronous requests to be made of a manager if it supports them. It allows a client to asynchronously request some functionality of a particular QOrganizerManager. Instances of the class will emit signals when the state of the request changes, or when more results become available. Clients should not attempt to create instances of this class directly, but should instead use the use-case-specific classes derived from this class. After creating any sort of request, the client retains ownership and must delete the request to avoid leaking memory. The client may either do this directly (if not within a slot connected to a signal emitted by the request) or by using the deleteLater() slot to schedule the request for deletion when control returns to the event loop. Member Type Documentation
|
| Constant | Value | Description |
|---|---|---|
| QOrganizerAbstractRequest::InvalidRequest | 0 | An invalid request. |
| QOrganizerAbstractRequest::ItemOccurrenceFetchRequest | 1 | A request to fetch a list of occurrences of an organizer item. |
| QOrganizerAbstractRequest::ItemFetchRequest | 2 | A request to fetch a list of organizer items. |
| QOrganizerAbstractRequest::ItemFetchForExportRequest | 3 | A request to fetch a list of persisted organizer items and exceptions. |
| QOrganizerAbstractRequest::ItemIdFetchRequest | 4 | A request to fetch a list of organizer item IDs. |
| QOrganizerAbstractRequest::ItemFetchByIdRequest | 5 | A request to fetch a list of organizer items by the given IDs. |
| QOrganizerAbstractRequest::ItemRemoveRequest | 6 | A request to remove a list of organizer items. |
| QOrganizerAbstractRequest::ItemRemoveByIdRequest | 7 | A request to remove a list of organizer items by the given IDs. |
| QOrganizerAbstractRequest::ItemSaveRequest | 8 | A request to save a list of organizer items. |
| QOrganizerAbstractRequest::CollectionFetchRequest | 9 | A request to fetch a collection. |
| QOrganizerAbstractRequest::CollectionRemoveRequest | 10 | A request to remove a collection. |
| QOrganizerAbstractRequest::CollectionSaveRequest | 11 | A request to save a collection. |
| QOrganizerAbstractRequest::ItemFetchByIdRequest | 5 | A request to fetch an organizer item by ID. |
| QOrganizerAbstractRequest::ItemRemoveByIdRequest | 7 | A request to remove an organizer item by ID. |
enum QOrganizerAbstractRequest::State
Enumerates the various states that a request may be in at any given time.
| Constant | Value | Description |
|---|---|---|
| QOrganizerAbstractRequest::InactiveState | 0 | Operation not yet started. |
| QOrganizerAbstractRequest::ActiveState | 1 | Operation started, not yet finished. |
| QOrganizerAbstractRequest::CanceledState | 2 | Operation is finished due to cancellation. |
| QOrganizerAbstractRequest::FinishedState | 3 | Operation successfully completed. |
enum QOrganizerAbstractRequest::StorageLocation
flags QOrganizerAbstractRequest::StorageLocations
flags QOrganizerAbstractRequest::StorageLocations
Defines the different storage locations for separate requests.
| Constant | Value | Description |
|---|---|---|
| QOrganizerAbstractRequest::UserDataStorage | 0x1 | A storage location where user data is usually stored. |
| QOrganizerAbstractRequest::SystemStorage | 0x2 | A storage location where system files are usually stored. |
Depending on the platform, the access rights for different storage locations might vary.
The StorageLocations type is a typedef for QFlags<StorageLocation>. It stores an OR combination of StorageLocation values.
Member Function Documentation
QOrganizerAbstractRequest::~QOrganizerAbstractRequest()
Cleans up the memory used by this request.
bool QOrganizerAbstractRequest::cancel() [slot]
Attempts to cancel the request. Returns false if the request is not in the QOrganizerAbstractRequest::Active state, or if the request is unable to be cancelled by the manager engine; otherwise returns true.
QOrganizerManager::Error QOrganizerAbstractRequest::error() const
Returns the overall error of the most recent asynchronous operation.
bool QOrganizerAbstractRequest::isActive() const
Returns true if the request is in the QOrganizerAbstractRequest::ActiveState state; otherwise, returns false.
See also state().
bool QOrganizerAbstractRequest::isCanceled() const
Returns true if the request is in the QOrganizerAbstractRequest::CanceledState; otherwise, returns false.
See also state().
bool QOrganizerAbstractRequest::isFinished() const
Returns true if the request is in the QOrganizerAbstractRequest::FinishedState; otherwise, returns false.
See also state().
bool QOrganizerAbstractRequest::isInactive() const
Returns true if the request is in the QOrganizerAbstractRequest::InactiveState state; otherwise, returns false.
See also state().
QOrganizerManager * QOrganizerAbstractRequest::manager() const
Returns a pointer to the manager of which this request instance requests operations.
See also setManager().
void QOrganizerAbstractRequest::resultsAvailable() [signal]
This signal is emitted when new results are available. Results can include the operation error which may be accessed via error(), or derived-class-specific results which are accessible through the derived class API.
See also error().
void QOrganizerAbstractRequest::setManager(QOrganizerManager * manager)
Sets the manager of which this request instance requests operations to manager.
Note that if the current request is in active state, the manager can not be changed.
See also manager().
bool QOrganizerAbstractRequest::start() [slot]
Attempts to start the request. Returns false if the request is in the QOrganizerAbstractRequest::Active state, or if the request was unable to be performed by the manager engine; otherwise returns true.
State QOrganizerAbstractRequest::state() const
Returns the current state of the request.
void QOrganizerAbstractRequest::stateChanged(QOrganizerAbstractRequest::State newState) [signal]
This signal is emitted when the state of the request is changed. The new state of the request will be contained in newState.
RequestType QOrganizerAbstractRequest::type() const
Returns the type of this asynchronous request.
bool QOrganizerAbstractRequest::waitForFinished(int msecs = 0) [slot]
Blocks until the request has been completed by the manager engine, or until msecs milliseconds has elapsed.
If msecs is zero or negative, this function will block until the request is complete, regardless of how long it takes.
Returns true if the request was cancelled or completed successfully within the given period, otherwise false. Some backends are unable to support this operation safely, and will return false immediately.