emailcontacts/contactactionservice/inc/CFscPresentationContactField.h
changeset 0 8466d47a6819
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/emailcontacts/contactactionservice/inc/CFscPresentationContactField.h	Thu Dec 17 08:39:21 2009 +0200
@@ -0,0 +1,179 @@
+/*
+* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:  Presentation level contact field.
+ *
+*/
+
+
+#ifndef CFSCPRESENTATIONCONTACTFIELD_H
+#define CFSCPRESENTATIONCONTACTFIELD_H
+
+//  INCLUDES
+#include <e32base.h>
+#include <MVPbkStoreContactField.h>
+
+// FORWARD DECLARATIONS
+class MPbk2FieldProperty;
+class MVPbkStoreContact;
+class MVPbkContactFieldData;
+
+// CLASS DECLARATION
+
+/**
+ * Phonebook 2 presentation level contact field.
+ */
+class CFscPresentationContactField : public CBase,
+    public MVPbkStoreContactField
+    {
+public:
+    // Constructors and destructor
+
+    /**
+     * Creates a new instance of this class.
+     *
+     * @param aFieldProperty    Phonebook 2 field property.
+     * @param aStoreField       The field from the contact store.
+     * @param aParentContact    The parent contact of the field.
+     * @return  A new instance of this class.
+     */
+    static CFscPresentationContactField* NewL(
+            const MPbk2FieldProperty& aFieldProperty,
+            const MVPbkStoreContactField& aStoreField,
+            MVPbkStoreContact& aParentContact );
+
+    /**
+     * Creates a new instance of this class.
+     *
+     * @param aFieldProperty    Phonebook 2 field property.
+     * @param aStoreField       The field from the contact store.
+     * @param aParentContact    The parent contact of the field.
+     * @return  A new instance of this class.
+     */
+    static CFscPresentationContactField* NewLC(
+            const MPbk2FieldProperty& aFieldProperty,
+            const MVPbkStoreContactField& aStoreField,
+            MVPbkStoreContact& aParentContact );
+
+    /**
+     * Destructor.
+     */
+    ~CFscPresentationContactField();
+
+public: // Interface
+
+    /**
+     * Returns the maximum length of the field data.
+     *
+     * @return  Maximum length of field data.
+     */
+    TInt MaxDataLength() const;
+
+    /**
+     * Checks if the field contains data.
+     *
+     * @return  ETrue if the field doesn't contain data.
+     */
+    TBool IsEmpty() const;
+
+    /**
+     * Checks is the field editable.
+     *
+     * @return  ETrue if the field can be edited.
+     */
+    TBool IsEditable() const;
+
+    /**
+     * Checks is the field removable.
+     *
+     * @return  ETrue if the field can not be removed from the
+     *          contact. This is a static property of the field.
+     */
+    TBool IsRemovable() const;
+
+    /**
+     * Returns the field's property.
+     *
+     * @return  The field's property.
+     */
+    inline const MPbk2FieldProperty& FieldProperty() const;
+
+    /**
+     * Returns corresponding store contact field.
+     *
+     * @return T    he contact store field.
+     */
+    inline MVPbkStoreContactField& StoreField() const;
+
+public: // From MVPbkObjectHierarchy
+    MVPbkObjectHierarchy& ParentObject() const;
+
+public: // From MVPbkBaseContactField
+    MVPbkBaseContact& ParentContact() const;
+    const MVPbkFieldType* MatchFieldType(
+            TInt aMatchPriority ) const;
+    const MVPbkFieldType* BestMatchingFieldType() const;
+    const MVPbkContactFieldData& FieldData() const;
+    TBool IsSame(
+            const MVPbkBaseContactField& aOther ) const;
+
+public: // From MVPbkStoreContactField
+    TBool SupportsLabel() const;
+    TPtrC FieldLabel() const;
+    void SetFieldLabelL(
+            const TDesC& aText );
+    TInt MaxLabelLength() const;
+    MVPbkContactFieldData& FieldData();
+    MVPbkStoreContactField* CloneLC() const;
+    MVPbkContactLink* CreateLinkLC() const;
+
+private: // Construction
+    CFscPresentationContactField(
+            const MPbk2FieldProperty& aFieldProperty,
+            MVPbkStoreContact& aParentContact );
+    void ConstructL(
+            const MVPbkStoreContactField& aStoreField );
+
+private: // Data
+    /// Ref: Phonebook 2 field property
+    const MPbk2FieldProperty& iFieldProperty;
+    /// Own: The field that is used to access actual field data
+    MVPbkStoreContactField* iStoreField;
+    /// Ref: The parent contact of the field
+    MVPbkStoreContact& iParentContact;
+    /// Ref: Presentation contact field text data
+    MVPbkContactFieldData* iData;
+    };
+
+// INLINE IMPLEMENTATION
+
+// --------------------------------------------------------------------------
+// CFscPresentationContactField::FieldProperty
+// --------------------------------------------------------------------------
+//
+inline const MPbk2FieldProperty& CFscPresentationContactField::FieldProperty() const
+    {
+    return iFieldProperty;
+    }
+
+// --------------------------------------------------------------------------
+// CFscPresentationContactField::StoreField
+// --------------------------------------------------------------------------
+//
+inline MVPbkStoreContactField& CFscPresentationContactField::StoreField() const
+    {
+    return *iStoreField;
+    }
+
+#endif // CFSCPRESENTATIONCONTACTFIELD_H
+// End of File