1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/textandloc/textrendering/textformatting/inc/FRMFRAME.H	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,121 @@
     1.4 +/*
     1.5 +* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of "Eclipse Public License v1.0"
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description: 
    1.18 +*
    1.19 +*/
    1.20 +
    1.21 +
    1.22 +#ifndef __FRMFRAME_H__
    1.23 +#define __FRMFRAME_H__
    1.24 +
    1.25 +#include <w32std.h>
    1.26 +
    1.27 +/** A rectangular frame surrounding a picture with eight smaller, square areas
    1.28 +(referred to as blobs) for moving and resizing the picture. A blob is located
    1.29 +on each corner and at the centre of each side.
    1.30 +
    1.31 +Each blob has a visible width and an active width. The active width allows
    1.32 +easier manipulation of picture frames because the blobs may be small and difficult
    1.33 +to manipulate with a pen. The active width should be set to be at least as
    1.34 +large as the visible width.
    1.35 +
    1.36 +A picture frame also has a set of flags which are used when drawing the frame.
    1.37 +These control the frame border visibility, whether blobs should be drawn inside
    1.38 +or outside the frame and whether the blobs should be filled using a solid
    1.39 +brush style or using a NULL brush style, causing them to appear dimmed. For
    1.40 +more information on brush styles. see CGraphicsContext::TBrushStyle.
    1.41 +@publishedAll
    1.42 +@released
    1.43 +*/
    1.44 +class TFrameOverlay
    1.45 +
    1.46 +    {
    1.47 +public:
    1.48 +/** This enumeration is used by CTextView::SetXyPosL() and by TFrameOverlay::XyPosToEdges()
    1.49 +to identify which active region of the picture frame a pixel position is in. */
    1.50 +enum TEdges
    1.51 +	{
    1.52 +	/** Not in an active region. */
    1.53 +	ENoEdges=0x00,
    1.54 +	/** In active region around left edge. */
    1.55 +	EEdgeLeft=0x01,
    1.56 +	/** In active region around right edge. */
    1.57 +	EEdgeRight=0x02,
    1.58 +	/** In active region around top edge. */
    1.59 +	EEdgeTop=0x04,
    1.60 +	/** In active region around bottom edge. */
    1.61 +	EEdgeBottom=0x08
    1.62 +	};
    1.63 +
    1.64 +/** Frame appearance flags. */
    1.65 +enum TFrameOverlayFlags
    1.66 +	{
    1.67 +	/** Controls whether blobs are drawn inside or outside the frame border. */
    1.68 +	EFrameOverlayFlagBlobsInternal=0x01,
    1.69 +	/** Controls whether the frame border is drawn or not. */
    1.70 +	EFrameOverlayFlagShowBorder=0x02,
    1.71 +	/** Controls whether the three blobs at the top of the frame are drawn dimmed. */
    1.72 +	EFrameOverlayFlagTopBlobsDimmed=0x04,
    1.73 +	/** Controls whether the three blobs at the bottom of the frame are drawn dimmed. */
    1.74 +	EFrameOverlayFlagBottomBlobsDimmed=0x08,
    1.75 +	/** Controls whether the three blobs on the left hand side of the frame are drawn
    1.76 +	dimmed. */
    1.77 +	EFrameOverlayFlagLeftBlobsDimmed=0x10,
    1.78 +	/** Controls whether the three blobs on the right hand side of the frame are drawn
    1.79 +	dimmed. */
    1.80 +	EFrameOverlayFlagRightBlobsDimmed=0x20
    1.81 +	};
    1.82 +public:
    1.83 +	IMPORT_C TFrameOverlay();
    1.84 +    IMPORT_C void SetBlobWidthInPixels(const TInt aWidth); //sets visible and active blob width
    1.85 +    IMPORT_C void SetVisibleBlobWidthInPixels(const TInt aWidth); //default zero
    1.86 +    IMPORT_C void SetActiveBlobWidthInPixels(const TInt aWidth); // default zero
    1.87 +	IMPORT_C void SetFlags(TInt aFlag);
    1.88 +    IMPORT_C void ClearFlags(TInt aFlag);
    1.89 +    IMPORT_C void SetRect(const TRect& aRect);
    1.90 +    IMPORT_C void XorDraw(CGraphicsContext& aGc) const;
    1.91 +    IMPORT_C TInt XyPosToEdges(const TPoint& aPos) const;
    1.92 +    inline TRect Rect() const;		// deprecated
    1.93 +    inline const TRect& RefRect() const;
    1.94 +    inline TInt Flags() const;
    1.95 +private:
    1.96 +	TInt VisibleBlobWidth() const;
    1.97 +	TInt ActiveMarginWidth() const;
    1.98 +	TBool DrawLeftAndRight() const;
    1.99 +	TBool DrawTopAndBottom() const;
   1.100 +	void DrawDottedRectangle(CGraphicsContext& aGc,const TRect& aRect) const;
   1.101 +private:
   1.102 +    TInt iFlags;
   1.103 +    TInt iVisibleBlobWidth;
   1.104 +	TInt iActiveBlobWidth;
   1.105 +	TRect iRect;
   1.106 +    };
   1.107 +
   1.108 +/** @deprecated */	
   1.109 +inline TRect TFrameOverlay::Rect() const
   1.110 +	{
   1.111 +	return(iRect);
   1.112 +	}
   1.113 +
   1.114 +inline const TRect& TFrameOverlay::RefRect() const
   1.115 +	{
   1.116 +	return(iRect);
   1.117 +	}
   1.118 +
   1.119 +TInt TFrameOverlay::Flags() const
   1.120 +	{
   1.121 +	return(iFlags);
   1.122 +	}
   1.123 +
   1.124 +#endif