sl@0: /*
sl@0: * Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __FRMFRAME_H__
sl@0: #define __FRMFRAME_H__
sl@0: 
sl@0: #include <w32std.h>
sl@0: 
sl@0: /** A rectangular frame surrounding a picture with eight smaller, square areas
sl@0: (referred to as blobs) for moving and resizing the picture. A blob is located
sl@0: on each corner and at the centre of each side.
sl@0: 
sl@0: Each blob has a visible width and an active width. The active width allows
sl@0: easier manipulation of picture frames because the blobs may be small and difficult
sl@0: to manipulate with a pen. The active width should be set to be at least as
sl@0: large as the visible width.
sl@0: 
sl@0: A picture frame also has a set of flags which are used when drawing the frame.
sl@0: These control the frame border visibility, whether blobs should be drawn inside
sl@0: or outside the frame and whether the blobs should be filled using a solid
sl@0: brush style or using a NULL brush style, causing them to appear dimmed. For
sl@0: more information on brush styles. see CGraphicsContext::TBrushStyle.
sl@0: @publishedAll
sl@0: @released
sl@0: */
sl@0: class TFrameOverlay
sl@0: 
sl@0:     {
sl@0: public:
sl@0: /** This enumeration is used by CTextView::SetXyPosL() and by TFrameOverlay::XyPosToEdges()
sl@0: to identify which active region of the picture frame a pixel position is in. */
sl@0: enum TEdges
sl@0: 	{
sl@0: 	/** Not in an active region. */
sl@0: 	ENoEdges=0x00,
sl@0: 	/** In active region around left edge. */
sl@0: 	EEdgeLeft=0x01,
sl@0: 	/** In active region around right edge. */
sl@0: 	EEdgeRight=0x02,
sl@0: 	/** In active region around top edge. */
sl@0: 	EEdgeTop=0x04,
sl@0: 	/** In active region around bottom edge. */
sl@0: 	EEdgeBottom=0x08
sl@0: 	};
sl@0: 
sl@0: /** Frame appearance flags. */
sl@0: enum TFrameOverlayFlags
sl@0: 	{
sl@0: 	/** Controls whether blobs are drawn inside or outside the frame border. */
sl@0: 	EFrameOverlayFlagBlobsInternal=0x01,
sl@0: 	/** Controls whether the frame border is drawn or not. */
sl@0: 	EFrameOverlayFlagShowBorder=0x02,
sl@0: 	/** Controls whether the three blobs at the top of the frame are drawn dimmed. */
sl@0: 	EFrameOverlayFlagTopBlobsDimmed=0x04,
sl@0: 	/** Controls whether the three blobs at the bottom of the frame are drawn dimmed. */
sl@0: 	EFrameOverlayFlagBottomBlobsDimmed=0x08,
sl@0: 	/** Controls whether the three blobs on the left hand side of the frame are drawn
sl@0: 	dimmed. */
sl@0: 	EFrameOverlayFlagLeftBlobsDimmed=0x10,
sl@0: 	/** Controls whether the three blobs on the right hand side of the frame are drawn
sl@0: 	dimmed. */
sl@0: 	EFrameOverlayFlagRightBlobsDimmed=0x20
sl@0: 	};
sl@0: public:
sl@0: 	IMPORT_C TFrameOverlay();
sl@0:     IMPORT_C void SetBlobWidthInPixels(const TInt aWidth); //sets visible and active blob width
sl@0:     IMPORT_C void SetVisibleBlobWidthInPixels(const TInt aWidth); //default zero
sl@0:     IMPORT_C void SetActiveBlobWidthInPixels(const TInt aWidth); // default zero
sl@0: 	IMPORT_C void SetFlags(TInt aFlag);
sl@0:     IMPORT_C void ClearFlags(TInt aFlag);
sl@0:     IMPORT_C void SetRect(const TRect& aRect);
sl@0:     IMPORT_C void XorDraw(CGraphicsContext& aGc) const;
sl@0:     IMPORT_C TInt XyPosToEdges(const TPoint& aPos) const;
sl@0:     inline TRect Rect() const;		// deprecated
sl@0:     inline const TRect& RefRect() const;
sl@0:     inline TInt Flags() const;
sl@0: private:
sl@0: 	TInt VisibleBlobWidth() const;
sl@0: 	TInt ActiveMarginWidth() const;
sl@0: 	TBool DrawLeftAndRight() const;
sl@0: 	TBool DrawTopAndBottom() const;
sl@0: 	void DrawDottedRectangle(CGraphicsContext& aGc,const TRect& aRect) const;
sl@0: private:
sl@0:     TInt iFlags;
sl@0:     TInt iVisibleBlobWidth;
sl@0: 	TInt iActiveBlobWidth;
sl@0: 	TRect iRect;
sl@0:     };
sl@0: 
sl@0: /** @deprecated */	
sl@0: inline TRect TFrameOverlay::Rect() const
sl@0: 	{
sl@0: 	return(iRect);
sl@0: 	}
sl@0: 
sl@0: inline const TRect& TFrameOverlay::RefRect() const
sl@0: 	{
sl@0: 	return(iRect);
sl@0: 	}
sl@0: 
sl@0: TInt TFrameOverlay::Flags() const
sl@0: 	{
sl@0: 	return(iFlags);
sl@0: 	}
sl@0: 
sl@0: #endif