summaryrefslogtreecommitdiff
path: root/lotuswordpro/source/filter/xfilter/xfframe.hxx
blob: 8918f661673e63357692bdd10b0a00d46d1bcfbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: IBM Corporation
 *
 *  Copyright: 2008 by IBM Corporation
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
/*************************************************************************
 * @file
 * Frame object for OOo.This is the basic object for all Shape Layer.
 * You can reference to the XFFrame object.
 ************************************************************************/
/*************************************************************************
 * Change History
 * 2005-01-10 create and implements.
 ************************************************************************/
#ifndef		_XFFRAME_HXX
#define		_XFFRAME_HXX

#include	"xfglobal.hxx"
#include	"xfcontent.hxx"
#include	"xfrect.hxx"
#include	"xfcontentcontainer.hxx"

#define		XFFRAME_FLAG_HEIGHT			0x00000001
#define		XFFRAME_FLAG_MINHEIGHT		0x00000002
#define		XFFRAME_FLAG_MAXHEIGHT		0x00000004
/**
 * @brief
 *	Base class for all frame object,include drawing,image,text-box.
 *
 *	Use SetX(),SetY(),SetWidth(),SetHeight() to set postion for the frame.
 *	Only if you set anchor type to enumXFAnchorPage, the SetAnchorPage functions.
 */
class XFFrame : public XFContentContainer
{
public:
    XFFrame();
    XFFrame(sal_Bool isTextBox);

    virtual ~XFFrame();

public:
    /**
     * @descr	override the add function to adjust z-index.
     */
    virtual void	Add(IXFContent *pContent);

    /**
     * @descr:	Set the anchor type for the frame object.
     */
    void	SetAnchorType(enumXFAnchor type);

    /**
     * @descr:	if it's page anchor,set the page number.
     */
    void	SetAnchorPage(sal_Int32	page);

    /**
     * @descr	Set frame name.
     */
    void	SetName(rtl::OUString name);

    /**
     * @descr	Set z-index of the frame.
     */
    void	SetZIndex(sal_uInt32 zIndex);
    /**
     * @descr	Set frame position X.
     */
    void	SetX(double x);

    /**
     * @descr	Set frame position Y.
     */
    void	SetY(double y);

    /**
     * @descr	Set frame wieth.
     */
    void	SetWidth(double width);

    /**
     * @descr	Set frame height. Be careful SetHeight and SetMinHeight will override each other.
     */
    void	SetHeight(double height);

    /**
     * @descr	Set frame min-height. Be careful SetHeight and SetMinHeight will override each other.
     */
    void	SetMinHeight(double minHeight);

    /**
     * @descr	Set frame max-height.
     */
    void	SetMaxHeight(double minHeight);

    /**
     * @descr	Set frame position.
     */
    void	SetPosition(double x, double y, double width, double height);

    /**
     * @descr	Set frame position.
     */
    void	SetPosition(const XFRect& rect);

    /**
     * @descr:	Link the text content of the two frame.
     */
    void	SetNextLink(rtl::OUString next);

    /**
     * @descr	Get the frame type. image, drawing or text-box.
     */
    virtual enumXFFrameType	GetFrameType();

    /**
     * @descr	Get content type, enumXFContentFrame.
     */
    virtual enumXFContent	GetContentType();

    /**
     * @descr	serialize.
     */
    virtual void	ToXml(IXFStream *pStrm);

private:
    void	StartFrame(IXFStream *pStrm);

    void	EndFrame(IXFStream *pStrm);

    void	AdjustZIndex();

protected:
    enumXFAnchor	m_eAnchor;
    sal_Int32		m_nAnchorPage;
    rtl::OUString	m_strName;
    sal_uInt32		m_nZIndex;
    XFRect			m_aRect;
    double			m_fMinHeight;
    double			m_fMaxHeight;
    rtl::OUString	m_strNextLink;
    enumXFFrameType	m_eType;
    sal_uInt32		m_nFlag;
    sal_Bool			m_isTextBox;
};

inline void	XFFrame::SetAnchorType(enumXFAnchor anchor)
{
    m_eAnchor = anchor;
}

inline void	XFFrame::SetName(rtl::OUString name)
{
    m_strName = name;
}

inline void	XFFrame::SetX(double x)
{
    m_aRect.SetX(x);
}

inline void	XFFrame::SetY(double y)
{
    m_aRect.SetY(y);
}

inline void	XFFrame::SetWidth(double width)
{
    m_aRect.SetWidth(width);
}

inline void	XFFrame::SetHeight(double height)
{
    m_aRect.SetHeight(height);
    m_nFlag |= XFFRAME_FLAG_HEIGHT;
    m_nFlag &= XFFRAME_FLAG_HEIGHT;
}

inline void	XFFrame::SetMinHeight(double minHeight)
{
    m_fMinHeight = minHeight;
    m_nFlag |= XFFRAME_FLAG_MINHEIGHT;
    m_nFlag &= XFFRAME_FLAG_MINHEIGHT;
}

inline void	XFFrame::SetMaxHeight(double maxHeight)
{
    m_fMaxHeight = maxHeight;
    m_nFlag |= XFFRAME_FLAG_MAXHEIGHT;
    m_nFlag &= XFFRAME_FLAG_MAXHEIGHT;
}

inline void	XFFrame::SetPosition(double x, double y, double width, double height)
{
    m_aRect.SetStartPoint(XFPoint(x,y));
    m_aRect.SetSize(width,height);
    m_nFlag |= XFFRAME_FLAG_HEIGHT;
}

inline void	XFFrame::SetPosition(const XFRect& rect)
{
    m_aRect = rect;
}

inline void XFFrame::SetNextLink(rtl::OUString next)
{
    m_strNextLink = next;
}

inline void XFFrame::SetAnchorPage(sal_Int32 page)
{
    m_nAnchorPage = page;
}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */