Inheritance diagram for QofBackend:
Public Member Functions | |
| QofBackend (const QofBackend &)=delete | |
| QofBackend (const QofBackend &&)=delete | |
| virtual void | session_begin (QofSession *session, const char *new_uri, SessionOpenMode mode)=0 |
| Open the file or connect to the server. | |
| virtual void | session_end ()=0 |
| virtual void | load (QofBook *, QofBackendLoadType)=0 |
| Load the minimal set of application data needed for the application to be operable at initial startup. | |
| virtual void | begin (QofInstance *) |
| Called when the engine is about to make a change to a data structure. | |
| virtual void | commit (QofInstance *) |
| Commits the changes from the engine to the backend data storage. | |
| virtual void | rollback (QofInstance *) |
| Revert changes in the engine and unlock the backend. | |
| virtual void | sync (QofBook *)=0 |
| Synchronizes the engine contents to the backend. | |
| virtual void | safe_sync (QofBook *)=0 |
| Perform a sync in a way that prevents data loss on a DBI backend. | |
| virtual void | export_coa (QofBook *) |
| Extract the chart of accounts from the current database and create a new database with it. | |
| void | set_error (QofBackendError err) |
| Set the error value only if there isn't already an error already. | |
| QofBackendError | get_error () |
| Retrieve the currently-stored error and clear it. | |
| bool | check_error () |
| Report if there is an error. | |
| void | set_message (std::string &&) |
| Set a descriptive message that can be displayed to the user when there's an error. | |
| const std::string && | get_message () |
| Retrieve and clear the stored error message. | |
| void | set_percentage (QofBePercentageFunc pctfn) |
| Store and retrieve a backend-specific function for determining the progress in completing a long operation, for use with a progress meter. | |
| QofBePercentageFunc | get_percentage () |
| const std::string & | get_uri () |
| Retrieve the backend's storage URI. | |
Static Public Member Functions | |
| static bool | register_backend (const char *, const char *) |
| Class methods for dynamically loading the several backends and for freeing them at shutdown. | |
| static void | release_backends () |
Protected Attributes | |
| QofBePercentageFunc | m_percentage |
| std::string | m_fullpath |
| Each backend resolves a fully-qualified file path. | |
Detailed Description
Definition at line 170 of file qof-backend.hpp.
The documentation for this struct was generated from the following files:
