summaryrefslogtreecommitdiff
path: root/libopie2/opiepim/core/opimaccessfactory.h
Side-by-side diff
Diffstat (limited to 'libopie2/opiepim/core/opimaccessfactory.h') (more/less context) (ignore whitespace changes)
-rw-r--r--libopie2/opiepim/core/opimaccessfactory.h22
1 files changed, 12 insertions, 10 deletions
diff --git a/libopie2/opiepim/core/opimaccessfactory.h b/libopie2/opiepim/core/opimaccessfactory.h
index ee55ba5..3cd448e 100644
--- a/libopie2/opiepim/core/opimaccessfactory.h
+++ b/libopie2/opiepim/core/opimaccessfactory.h
@@ -41,80 +41,82 @@ using namespace Opie::Pim;
namespace Opie {
/**
* This class is our factory for creating PIM access objects. You should use these objects to load, store and search
* information in our PIM databases. Currently we support objects for accessing the datebook, the contact- and the
* todolist.
* @see OPimGlobal for more information of used values.
*
* This class - as the whole PIM Api - is making use of templates
*
* Example for getting an access object for the XML database of todolist:
* <pre>
* OPimTodoAccess* access = OPimAccessFactory<OPimTodoAccess>::create( OPimGlobal::TODOLIST, OPimGlobal::XML, "example" );
* </pre>
*
* @author Stefan Eilers
* @version 0.1
*/
template<class T>
class OPimAccessFactory
{
public:
-
- // Maybe we should introduce a global class for storing such global enums
- // (something like opimglobal.h) ? (eilers)
-
OPimAccessFactory() {};
/**
* Returns the selected PIM access-object.
* @param type Type of the selected database (addressbook, todolist or datebook)
* @param dbStyle Which database style should be used (xml, sql, vcard)
* @param appName "Name" of your application. This should be any constant string which is used
* by some backends for creating special files (i.e.journal files). Please keep the
* string unique for your application !
- * @see OPimGlobal
+ * @param fileName Filename of database if something different as the default should be used.
+ * @see OPimGlobal()
*/
- static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString& appName ){
+ static T* create( OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString& appName,
+ const QString& fileName = QString::null ){
OPimBase *base;
switch ( type ){
case OPimGlobal::TODOLIST:
- base = new OPimTodoAccess( OBackendFactory<OPimTodoAccessBackend>::create( type, dbStyle, appName ) );
+ base = new OPimTodoAccess( OBackendFactory<OPimTodoAccessBackend>::create( type, dbStyle,
+ appName, fileName ) );
break;
case OPimGlobal::CONTACTLIST:
- base = new OPimContactAccess( QString::null, QString::null, OBackendFactory<OPimContactAccessBackend>::create( type, dbStyle, appName ) );
+ base = new OPimContactAccess( QString::null, QString::null,
+ OBackendFactory<OPimContactAccessBackend>::create( type, dbStyle,
+ appName, fileName ) );
break;
case OPimGlobal::DATEBOOK:
- base = new ODateBookAccess( OBackendFactory<ODateBookAccessBackend>::create( type, dbStyle, appName ) );
+ base = new ODateBookAccess( OBackendFactory<ODateBookAccessBackend>::create( type, dbStyle,
+ appName, fileName ) );
break;
default:
return 0l;
}
return static_cast<T*>( base );
}
/**
* Returns the selected PIM access-object, using the default database style
* Which style is selected is defined in the configfile "pimaccess.conf" in
* the directory "Settings"
* @param type Type of the selected database (addressbook, todolist or datebook)
* @param appName "Name" of your application. This should be any constant string which is used
* by some backends for creating special files (i.e.journal files). Please keep the
* string unique for your application !
- * @see OPimGlobal
+ * @see OPimGlobal()
*
*/
static T* defaultAccess( typename OPimGlobal::PimType type, const QString& appName ){
return create( type, OPimGlobal::DEFAULT, appName );
}
};
}
#endif