| -rw-r--r-- | development/pim/pim_howto/pim_howto.lyx | 112 |
1 files changed, 60 insertions, 52 deletions
diff --git a/development/pim/pim_howto/pim_howto.lyx b/development/pim/pim_howto/pim_howto.lyx index 4571996..1e43d63 100644 --- a/development/pim/pim_howto/pim_howto.lyx +++ b/development/pim/pim_howto/pim_howto.lyx @@ -54,4 +54,4 @@ \end_preamble -\language german -\inputencoding auto +\language american +\inputencoding default \fontscheme ae @@ -72,3 +72,3 @@ \defskip medskip -\quotes_language german +\quotes_language english \quotes_times 2 @@ -99,3 +99,3 @@ The Opie-Pim API provides a powerfull access interface to the PIM (Personal Information Management) data which contains your contact information, the - dates in your calender tool (in this paper called datebook events) and + dates in your calendar tool (in this paper called datebook events) and your todo events. @@ -108,3 +108,3 @@ The Opie-Pim API provides a powerfull access interface to the PIM (Personal While starting to read the automatically generated API-documentation, the - user may be confused by a lot of unneccessary classes and details which + user may be confused by a lot of unnecessary classes and details which makes the quick start not as easy as possible. @@ -126,3 +126,3 @@ Introduction -Before starting to jump into the work, we should introduce some specialities +Before starting to jump into the work, we should introduce some specialties of the PIM API, first. @@ -135,3 +135,3 @@ The PIM-API heavily uses C++ templates (as known as generic classes), but they work! Most of the API works without even seeing the templates. - In some cases whe have to use them (for instance to use the factory classes), + In some cases we have to use them (for instance to use the factory classes), but this guide will provide examples which should help to find the path @@ -139,3 +139,3 @@ The PIM-API heavily uses C++ templates (as known as generic classes), but But it is a good idea to read some short introduction of templates to avoid - unneccessary mistakes. + unnecessary mistakes. \layout Enumerate @@ -153,3 +153,3 @@ backend. how to access the databases and what to do with the data. - As we just want to access data, this paper just focusses the frontend. + As we just want to access data, this paper just focuses the frontend. Thus, you should ignore all classes which contains something like @@ -162,4 +162,4 @@ backend - in its name! Backends are just interessting for people who want to extend - or implement new possiblities about how to access databases, which will + in its name! Backends are just interesting for people who want to extend + or implement new possibilities about how to access databases, which will be discussed at the end of this paper. @@ -219,3 +219,3 @@ OPimAccessFactory -T* defaultAccess (typename OPimGlobal::PimType type, const QString &appName) +T* defaultAccess (typename OPimGlobal::PimType type, const QString &appName) \layout Standard @@ -243,3 +243,3 @@ If everything works as expected, you will receive a pointer to the contact \begin_inset Foot -collapsed true +collapsed false @@ -277,5 +277,5 @@ defaultAccess() \emph default -, the default dabase is accessed automatically +, the default database is accessed automatically \begin_inset Foot -collapsed true +collapsed false @@ -362,3 +362,3 @@ data-class \begin_inset Foot -collapsed true +collapsed false @@ -376,3 +376,3 @@ see \begin_inset Foot -collapsed true +collapsed false @@ -390,3 +390,3 @@ see \begin_inset Foot -collapsed true +collapsed false @@ -408,3 +408,3 @@ bool load (); -bool reload (); +bool reload (); \layout LyX-Code @@ -416,9 +416,9 @@ bool save (); -bool add (const T& t); +bool add (const T& t); \layout LyX-Code -bool remove (const T& t); +bool remove (const T& t); \layout LyX-Code -bool replace (const T& t); +bool replace (const T& t); \layout Standard @@ -462,3 +462,3 @@ without \begin_inset Foot -collapsed true +collapsed false @@ -466,3 +466,3 @@ collapsed true -We should check whether all dabases behave like this! (se) +We should check whether all databases behave like this! (se) \end_inset @@ -498,3 +498,3 @@ OPimRecordList -List allRecords (); +List allRecords(); \layout Standard @@ -506,6 +506,6 @@ List just contains a list of uid's to take care of memory space. - As every record is identified by an unique identifaction number which is - called UID (Unique IDentification), these numbers just exists once in the - database which is currently on access! To receive the real record, you - have to use the operation + As every record is identified by an unique identification number which + is called UID (Unique Identification), these numbers just exists once in + the database which is currently on access! To receive the real record, + you have to use the operation \begin_inset Quotes gld @@ -517,6 +517,6 @@ find() - with a valid UID as paramter: + with a valid UID as parameter: \layout LyX-Code -T find (UID uid); +T find (UID uid); \layout Standard @@ -560,3 +560,3 @@ As shown in the previous chapter, all we need to access the PIM-Database -But first we will start with intoducing some features of the +But first we will start with introducing some features of the \series bold @@ -583,3 +583,3 @@ defaultAccess() - to request an access-object to the dafault backend. + to request an access-object to the default backend. Whether this default backend will access the XML, VCard or SQLite database @@ -618,3 +618,3 @@ defaultAccess() If the developer wants to select a special database type for sure without - unnecessary side effects, he has to use the oparation + unnecessary side effects, he has to use the operation \emph on @@ -625,3 +625,3 @@ create() -T * create (OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, +T* create (OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, const QString &appName, const QString &fileName=QString::null) @@ -629,3 +629,3 @@ T * create (OPimGlobal::PimType type, OPimGlobal::DatabaseStyle dbStyle, -Some paramters are already known, like type and appName (see section +Some parameters are already known, like type and appName (see section \begin_inset LatexCommand \ref{sec:Instantiate-the-Access} @@ -748,6 +748,6 @@ In most cases it is not sufficient to receive just a list of all information able to sort it. - For this kind of excercise we provide some special operations which provide + For this kind of exercise we provide some special operations which provide searching and sorting in an incremental manner \begin_inset Foot -collapsed true +collapsed false @@ -842,3 +842,3 @@ The function is defined like this: -List matchRegexp (const QRegExp &r); +List matchRegexp (const QRegExp& r); \layout Standard @@ -899,3 +899,3 @@ OPimContact searchQuery; searchQuery.setLastName( -\begin_inset Quotes gld +\begin_inset Quotes eld \end_inset @@ -903,3 +903,3 @@ searchQuery.setLastName( Eilers -\begin_inset Quotes grd +\begin_inset Quotes erd \end_inset @@ -910,3 +910,3 @@ Eilers searchQuery.setHomeZip( -\begin_inset Quotes gld +\begin_inset Quotes eld \end_inset @@ -914,3 +914,3 @@ searchQuery.setHomeZip( 3* -\begin_inset Quotes grd +\begin_inset Quotes srd \end_inset @@ -961,4 +961,4 @@ The next step is to put this query into the operation which is defined like -List queryByExample (const T& query, int querySettings, const QDateTime - &startperiod=QDateTime()) +List queryByExample (const T& query, int querySettings, const QDateTime& + startperiod=QDateTime()) \layout Standard @@ -982,3 +982,11 @@ querySettings to configure the search properly. - This settings are defined by the enum QuerySettings in the class + This settings are defined by the enumeration +\begin_inset Quotes gld +\end_inset + +QuerySettings +\begin_inset Quotes grd +\end_inset + + in the class \series bold @@ -1084,3 +1092,3 @@ It should be clear at this stage, that this query is very powerful and - \begin_inset Foot -collapsed true +collapsed false @@ -1099,6 +1107,6 @@ At this time, just the contact database for XML and VCard is supporting -bool hasQuerySettings( uint querySettings ); +bool hasQuerySettings( uint querySettings ); \layout LyX-Code -uint querySettings(); +uint querySettings(); \layout Standard @@ -1204,3 +1212,3 @@ List as the first parameter. - The search operation will just occure on this set of uid's! + The search operation will just occur on this set of uid's! \layout Subsection @@ -1214,3 +1222,3 @@ To sort a given dataset, you should use the following operation (or one -List sorted (const List& list, bool ascending, int sortOrder, int sortFilter, +List sorted (const List& list, bool ascending, int sortOrder, int sortFilter, const QArray< UID >& cats); @@ -1403,3 +1411,3 @@ Internal Signal Handling: Automatic Propagation of Changes -Need to be written and is not implemented completly! +Need to be written and is not implemented completely! \layout Chapter |