|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef __FRMFRAME_H__
|
|
sl@0
|
20 |
#define __FRMFRAME_H__
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#include <w32std.h>
|
|
sl@0
|
23 |
|
|
sl@0
|
24 |
/** A rectangular frame surrounding a picture with eight smaller, square areas
|
|
sl@0
|
25 |
(referred to as blobs) for moving and resizing the picture. A blob is located
|
|
sl@0
|
26 |
on each corner and at the centre of each side.
|
|
sl@0
|
27 |
|
|
sl@0
|
28 |
Each blob has a visible width and an active width. The active width allows
|
|
sl@0
|
29 |
easier manipulation of picture frames because the blobs may be small and difficult
|
|
sl@0
|
30 |
to manipulate with a pen. The active width should be set to be at least as
|
|
sl@0
|
31 |
large as the visible width.
|
|
sl@0
|
32 |
|
|
sl@0
|
33 |
A picture frame also has a set of flags which are used when drawing the frame.
|
|
sl@0
|
34 |
These control the frame border visibility, whether blobs should be drawn inside
|
|
sl@0
|
35 |
or outside the frame and whether the blobs should be filled using a solid
|
|
sl@0
|
36 |
brush style or using a NULL brush style, causing them to appear dimmed. For
|
|
sl@0
|
37 |
more information on brush styles. see CGraphicsContext::TBrushStyle.
|
|
sl@0
|
38 |
@publishedAll
|
|
sl@0
|
39 |
@released
|
|
sl@0
|
40 |
*/
|
|
sl@0
|
41 |
class TFrameOverlay
|
|
sl@0
|
42 |
|
|
sl@0
|
43 |
{
|
|
sl@0
|
44 |
public:
|
|
sl@0
|
45 |
/** This enumeration is used by CTextView::SetXyPosL() and by TFrameOverlay::XyPosToEdges()
|
|
sl@0
|
46 |
to identify which active region of the picture frame a pixel position is in. */
|
|
sl@0
|
47 |
enum TEdges
|
|
sl@0
|
48 |
{
|
|
sl@0
|
49 |
/** Not in an active region. */
|
|
sl@0
|
50 |
ENoEdges=0x00,
|
|
sl@0
|
51 |
/** In active region around left edge. */
|
|
sl@0
|
52 |
EEdgeLeft=0x01,
|
|
sl@0
|
53 |
/** In active region around right edge. */
|
|
sl@0
|
54 |
EEdgeRight=0x02,
|
|
sl@0
|
55 |
/** In active region around top edge. */
|
|
sl@0
|
56 |
EEdgeTop=0x04,
|
|
sl@0
|
57 |
/** In active region around bottom edge. */
|
|
sl@0
|
58 |
EEdgeBottom=0x08
|
|
sl@0
|
59 |
};
|
|
sl@0
|
60 |
|
|
sl@0
|
61 |
/** Frame appearance flags. */
|
|
sl@0
|
62 |
enum TFrameOverlayFlags
|
|
sl@0
|
63 |
{
|
|
sl@0
|
64 |
/** Controls whether blobs are drawn inside or outside the frame border. */
|
|
sl@0
|
65 |
EFrameOverlayFlagBlobsInternal=0x01,
|
|
sl@0
|
66 |
/** Controls whether the frame border is drawn or not. */
|
|
sl@0
|
67 |
EFrameOverlayFlagShowBorder=0x02,
|
|
sl@0
|
68 |
/** Controls whether the three blobs at the top of the frame are drawn dimmed. */
|
|
sl@0
|
69 |
EFrameOverlayFlagTopBlobsDimmed=0x04,
|
|
sl@0
|
70 |
/** Controls whether the three blobs at the bottom of the frame are drawn dimmed. */
|
|
sl@0
|
71 |
EFrameOverlayFlagBottomBlobsDimmed=0x08,
|
|
sl@0
|
72 |
/** Controls whether the three blobs on the left hand side of the frame are drawn
|
|
sl@0
|
73 |
dimmed. */
|
|
sl@0
|
74 |
EFrameOverlayFlagLeftBlobsDimmed=0x10,
|
|
sl@0
|
75 |
/** Controls whether the three blobs on the right hand side of the frame are drawn
|
|
sl@0
|
76 |
dimmed. */
|
|
sl@0
|
77 |
EFrameOverlayFlagRightBlobsDimmed=0x20
|
|
sl@0
|
78 |
};
|
|
sl@0
|
79 |
public:
|
|
sl@0
|
80 |
IMPORT_C TFrameOverlay();
|
|
sl@0
|
81 |
IMPORT_C void SetBlobWidthInPixels(const TInt aWidth); //sets visible and active blob width
|
|
sl@0
|
82 |
IMPORT_C void SetVisibleBlobWidthInPixels(const TInt aWidth); //default zero
|
|
sl@0
|
83 |
IMPORT_C void SetActiveBlobWidthInPixels(const TInt aWidth); // default zero
|
|
sl@0
|
84 |
IMPORT_C void SetFlags(TInt aFlag);
|
|
sl@0
|
85 |
IMPORT_C void ClearFlags(TInt aFlag);
|
|
sl@0
|
86 |
IMPORT_C void SetRect(const TRect& aRect);
|
|
sl@0
|
87 |
IMPORT_C void XorDraw(CGraphicsContext& aGc) const;
|
|
sl@0
|
88 |
IMPORT_C TInt XyPosToEdges(const TPoint& aPos) const;
|
|
sl@0
|
89 |
inline TRect Rect() const; // deprecated
|
|
sl@0
|
90 |
inline const TRect& RefRect() const;
|
|
sl@0
|
91 |
inline TInt Flags() const;
|
|
sl@0
|
92 |
private:
|
|
sl@0
|
93 |
TInt VisibleBlobWidth() const;
|
|
sl@0
|
94 |
TInt ActiveMarginWidth() const;
|
|
sl@0
|
95 |
TBool DrawLeftAndRight() const;
|
|
sl@0
|
96 |
TBool DrawTopAndBottom() const;
|
|
sl@0
|
97 |
void DrawDottedRectangle(CGraphicsContext& aGc,const TRect& aRect) const;
|
|
sl@0
|
98 |
private:
|
|
sl@0
|
99 |
TInt iFlags;
|
|
sl@0
|
100 |
TInt iVisibleBlobWidth;
|
|
sl@0
|
101 |
TInt iActiveBlobWidth;
|
|
sl@0
|
102 |
TRect iRect;
|
|
sl@0
|
103 |
};
|
|
sl@0
|
104 |
|
|
sl@0
|
105 |
/** @deprecated */
|
|
sl@0
|
106 |
inline TRect TFrameOverlay::Rect() const
|
|
sl@0
|
107 |
{
|
|
sl@0
|
108 |
return(iRect);
|
|
sl@0
|
109 |
}
|
|
sl@0
|
110 |
|
|
sl@0
|
111 |
inline const TRect& TFrameOverlay::RefRect() const
|
|
sl@0
|
112 |
{
|
|
sl@0
|
113 |
return(iRect);
|
|
sl@0
|
114 |
}
|
|
sl@0
|
115 |
|
|
sl@0
|
116 |
TInt TFrameOverlay::Flags() const
|
|
sl@0
|
117 |
{
|
|
sl@0
|
118 |
return(iFlags);
|
|
sl@0
|
119 |
}
|
|
sl@0
|
120 |
|
|
sl@0
|
121 |
#endif
|