epoc32/include/app/cpbkidlefinder.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
--- a/epoc32/include/app/cpbkidlefinder.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/app/cpbkidlefinder.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,104 @@
-cpbkidlefinder.h
+/*
+* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+* which accompanies this distribution, and is available
+* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description: 
+*      Abstract Phonebook entry interface.
+*
+*/
+
+
+#ifndef __CPbkIdleFinder_H__
+#define __CPbkIdleFinder_H__
+
+// INCLUDES
+#include <e32base.h>    // CBase
+
+// FORWARD DECLARATIONS
+class CIdleFinder;
+class CContactItemFieldDef;
+class CContactIdArray;
+
+// CLASS DECLARATION
+
+/**
+ * Phonebook idle finder class. Wrapper for Contact Model's CIdleFinder.
+ * @see CIdleFinder.
+ */
+class CPbkIdleFinder : public CBase
+	{
+    public:  // Constructors and destructors
+        /**
+         * Constructor. Not exported because objects of this class are created
+         * only by CPbkContactEngine.
+         *
+         * @param aFinder   Contact Model idle finder object. This takes 
+         *                  ownership of aFinder.
+         * @param aFieldDef Field defintion passed to aFinder. This takes
+         *                  ownership of aFieldDef.
+         */
+        CPbkIdleFinder(CIdleFinder* aFinder, CContactItemFieldDef* aFieldDef);
+
+        /**
+         * Destructor.
+         */
+        ~CPbkIdleFinder();
+	    
+    public:  // CIdleFinder interface
+        /**
+         * Tests whether a search is complete.
+         * @return ETrue if complete, EFalse if not.
+         * @see CIdleFinder::IsCompelete().
+         */
+	    IMPORT_C TBool IsComplete() const;
+
+        /**
+         * Gives access and ownership of the contact ids found in the search.
+         * @return Contacts id's found in the search.
+         * @see CIdleFinder::TakeContactIds().
+         */
+	    IMPORT_C CContactIdArray* TakeContactIds();
+
+        /**
+         * Check for errors when search is complete.
+         * @return Error code. KErrNone if no errors occurred during the search.
+         * @see CIdleFinder::Error().
+         */
+	    IMPORT_C TInt Error() const;
+
+    public:  // Additional interface
+        /**
+         * Returns the CIdleFinder passed to constructor. Ownership not
+         * transferred.
+         * @return Symbian Contacts model Idle finder object. NULL if not set.
+         */ 
+        IMPORT_C CIdleFinder* IdleFinder() const;
+
+        /**
+         * Returns the CContactItemFieldDef passed to constructor. Ownership
+         * not transferred.
+         * @return Symbian Contacts model contact item field definition. NULL 
+         *         if not set.
+         */ 
+        IMPORT_C CContactItemFieldDef* FieldDef() const;
+    
+    private:  // Data
+		/// Own: idle finder object
+        CIdleFinder* iFinder;
+		/// Own: field definition (array of field types)
+        CContactItemFieldDef* iFieldDef;
+    };
+
+
+#endif // __CPbkIdleFinder_H__
+
+// End of File