epoc32/include/mw/apadbase.h
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
--- a/epoc32/include/mw/apadbase.h	Wed Mar 31 12:27:01 2010 +0100
+++ b/epoc32/include/mw/apadbase.h	Wed Mar 31 12:33:34 2010 +0100
@@ -1,9 +1,9 @@
 // Copyright (c) 1997-2009 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
+// under the terms of "Eclipse Public License v1.0"
 // which accompanies this distribution, and is available
-// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
 //
 // Initial Contributors:
 // Nokia Corporation - initial contribution.
@@ -11,24 +11,18 @@
 // Contributors:
 //
 // Description:
+// apadbase.h
 //
 
 #ifndef __APADBASE_H__
 #define __APADBASE_H__
 
-#if !defined(__E32STD_H__)
 #include <e32std.h>
-#endif
-#if !defined(__S32STD_H__)
 #include <s32std.h>
-#endif
-#if !defined(__GDI_H__)
 #include <gdi.h>
-#endif
-
 
-class CApaDoorBase : public CPicture
 // Base class for a wrapper for embedded CApaDocuments
+
 /** The base class for the graphic representation of an embedded document.
 
 An embedded document can be represented either as an icon or as a glass picture. 
@@ -40,9 +34,9 @@
 @released
 @see CApaDoor
 @see CApaModelDoor */
+class CApaDoorBase : public CPicture
 	{
 public:
-	
 	/** Defines the possible formats for the graphical representation of the embedded 
 	document. */
 	enum TFormat {
@@ -54,29 +48,27 @@
 		ETemporarilyIconic
 		};
 public:
-	inline TFormat Format()const;
-	inline TUid Source()const;
+	inline TFormat Format() const;
+	inline TUid Source() const;
 	inline void SetSource(TUid aSource);
-	// Virtuals from CPicture
-	IMPORT_C virtual TStreamId StoreL(CStreamStore& aStore) const;
-	IMPORT_C virtual void SetScaleFactor(TInt aScaleFactorWidth,TInt aScaleFactorHeight); 
-	IMPORT_C virtual void SetCropInTwips(const TMargins& aMargins); 
-	IMPORT_C virtual TPictureCapability Capability() const;
-	IMPORT_C virtual void GetCropInTwips(TMargins& aMargins) const; 
-	IMPORT_C virtual TInt ScaleFactorWidth() const; 
-	IMPORT_C virtual TInt ScaleFactorHeight() const; 
-	IMPORT_C virtual TBool LineBreakPossible(TUint aClass,TBool aBeforePicture,TBool aHaveSpaces) const;
-	IMPORT_C virtual TBool NativePixelSize(TSize& aPixelSize);
+public:	// from CPicture
+	IMPORT_C TStreamId StoreL(CStreamStore& aStore) const;
+	IMPORT_C void SetScaleFactor(TInt aScaleFactorWidth, TInt aScaleFactorHeight); 
+	IMPORT_C void SetCropInTwips(const TMargins& aMargins); 
+	IMPORT_C TPictureCapability Capability() const;
+	IMPORT_C void GetCropInTwips(TMargins& aMargins) const; 
+	IMPORT_C TInt ScaleFactorWidth() const; 
+	IMPORT_C TInt ScaleFactorHeight() const; 
+	IMPORT_C TBool LineBreakPossible(TUint aClass, TBool aBeforePicture, TBool aHaveSpaces) const;
+	IMPORT_C TBool NativePixelSize(TSize& aPixelSize);
 protected:
 	IMPORT_C CApaDoorBase();
 	IMPORT_C void ExternalizeBaseStreamL(CStreamStore& aStore,CStreamDictionary& aStreamDict)const;
 	IMPORT_C TSize InternalizeBaseStreamL(const CStreamStore& aStore,const CStreamDictionary& aStreamDict); // returns current size in twips
-
 private:
 	IMPORT_C virtual void CApaDoorBase_Reserved1();
 	IMPORT_C virtual void CApaDoorBase_Reserved2();
 protected:
-
 	/** Returns the size of the glass door, in twips.
 	
 	A concrete implementation of this function is provided by derived classes.
@@ -85,43 +77,44 @@
 	
 	@publishedAll 
 	@released */
-	virtual TSize GlassDoorSize()const=0;
+	virtual TSize GlassDoorSize() const = 0;
 protected:
 	TFormat iFormat;
 	TUid iSource; // foreign representation of a translated door (eg MS Word doc)
-
 private:
-	TInt iCApaDoorBase_Reserved1;
+	TInt iCApaDoorBase_Spare1;
 	};
 
 //
 // inlines
 //
 
+/** Gets the current format of the representation of the embedded document.
+
+@return The format for the representation of the embedded document. */
 inline CApaDoorBase::TFormat CApaDoorBase::Format()const
-	/** Gets the current format of the representation of the embedded document.
-	
-	@return The format for the representation of the embedded document. */
 	{ return iFormat; }
 
+/** Gets the UID that identifies this door when the source originates on a non-Symbian 
+OS device.
+
+This is used by converters.
+
+@return The UID for the non-Symbian OS source. For a source that originates 
+on a Symbian OS phone, this is KNullUid. */
 inline TUid CApaDoorBase::Source()const
-	/** Gets the UID that identifies this door when the source originates on a non-Symbian 
-	OS device.
-	
-	This is used by converters.
-	
-	@return The UID for the non-Symbian OS source. For a source that originates 
-	on a Symbian OS phone, this is KNullUid. */
 	{ return iSource; }
 
+/** Sets the UID that identifies this door when the source originates on a non-Symbian 
+OS device.
+
+This is used by converters.
+
+@param aSource The UID for the non-Symbian OS source. For a source that originates 
+on a Symbian OS phone, this is KNullUid. */
 inline void CApaDoorBase::SetSource(TUid aSource)
-	/** Sets the UID that identifies this door when the source originates on a non-Symbian 
-	OS device.
-	
-	This is used by converters.
-	
-	@param aSource The UID for the non-Symbian OS source. For a source that originates 
-	on a Symbian OS phone, this is KNullUid. */
 	{ iSource=aSource; }
 
-#endif
+#endif	// __APADBASE_H__
+
+