lotuswordpro/inc/xfilter/xfframe.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  * Frame object for OOo.This is the basic object for all Shape Layer.
  59  * You can reference to the XFFrame object.
  60  ************************************************************************/
  61 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFFRAME_HXX
  62 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFFRAME_HXX
  63
  64 #include <xfilter/xfcontent.hxx>
  65 #include <xfilter/xfrect.hxx>
  66 #include <xfilter/xfcontentcontainer.hxx>
  67
  68 #define     XFFRAME_FLAG_HEIGHT         0x00000001
  69 #define     XFFRAME_FLAG_MINHEIGHT      0x00000002
  70 #define     XFFRAME_FLAG_MAXHEIGHT      0x00000004
  71 /**
  72  * @brief
  73  *  Base class for all frame object,include drawing,image,text-box.
  74  *
  75  *  Use SetX(),SetY(),SetWidth(),SetHeight() to set position for the frame.
  76  *  Only if you set anchor type to enumXFAnchorPage, the SetAnchorPage functions.
  77  */
  78 class XFFrame : public XFContentContainer
  79 {
  80 public:
  81     XFFrame();
  82     explicit XFFrame(bool isTextBox);
  83
  84     virtual ~XFFrame() override;
  85
  86 public:
  87     using XFContentContainer::Add;
  88
  89     /**
  90      * @descr   override the add function to adjust z-index.
  91      */
  92     virtual void    Add(XFContent *pContent) override;
  93
  94     /**
  95      * @descr:  Set the anchor type for the frame object.
  96      */
  97     void    SetAnchorType(enumXFAnchor type);
  98
  99     /**
 100      * @descr:  if it's page anchor,set the page number.
 101      */
 102     void    SetAnchorPage(sal_Int32 page);
 103
 104     /**
 105      * @descr   Set frame name.
 106      */
 107     void    SetName(const OUString& name);
 108
 109     /**
 110      * @descr   Set z-index of the frame.
 111      */
 112     void    SetZIndex(sal_uInt32 zIndex);
 113     /**
 114      * @descr   Set frame position X.
 115      */
 116     void    SetX(double x);
 117
 118     /**
 119      * @descr   Set frame position Y.
 120      */
 121     void    SetY(double y);
 122
 123     /**
 124      * @descr   Set frame width.
 125      */
 126     void    SetWidth(double width);
 127
 128     /**
 129      * @descr   Set frame height. Be careful SetHeight and SetMinHeight will override each other.
 130      */
 131     void    SetHeight(double height);
 132
 133     /**
 134      * @descr   Set frame min-height. Be careful SetHeight and SetMinHeight will override each other.
 135      */
 136     void    SetMinHeight(double minHeight);
 137
 138     /**
 139      * @descr   Set frame position.
 140      */
 141     void    SetPosition(double x, double y, double width, double height);
 142
 143     /**
 144      * @descr   Set frame position.
 145      */
 146     void    SetPosition(const XFRect& rect);
 147
 148     /**
 149      * @descr:  Link the text content of the two frame.
 150      */
 151     void    SetNextLink(const OUString& next);
 152
 153     /**
 154      * @descr   Get the frame type. image, drawing or text-box.
 155      */
 156     enumXFFrameType GetFrameType() const;
 157
 158     /**
 159      * @descr   Get content type, enumXFContentFrame.
 160      */
 161     virtual enumXFContent   GetContentType() override;
 162
 163     /**
 164      * @descr   serialize.
 165      */
 166     virtual void    ToXml(IXFStream *pStrm) override;
 167
 168 private:
 169     void    StartFrame(IXFStream *pStrm);
 170
 171     static void EndFrame(IXFStream *pStrm);
 172
 173     void    AdjustZIndex();
 174
 175 protected:
 176     enumXFAnchor    m_eAnchor;
 177     sal_Int32       m_nAnchorPage;
 178     OUString        m_strName;
 179     sal_uInt32      m_nZIndex;
 180     XFRect          m_aRect;
 181     double          m_fMinHeight;
 182     OUString        m_strNextLink;
 183     enumXFFrameType m_eType;
 184     sal_uInt32      m_nFrameFlag;
 185     bool            m_isTextBox;
 186 };
 187
 188 inline void XFFrame::SetAnchorType(enumXFAnchor anchor)
 189 {
 190     m_eAnchor = anchor;
 191 }
 192
 193 inline void XFFrame::SetName(const OUString& name)
 194 {
 195     m_strName = name;
 196 }
 197
 198 inline void XFFrame::SetX(double x)
 199 {
 200     m_aRect.SetX(x);
 201 }
 202
 203 inline void XFFrame::SetY(double y)
 204 {
 205     m_aRect.SetY(y);
 206 }
 207
 208 inline void XFFrame::SetWidth(double width)
 209 {
 210     m_aRect.SetWidth(width);
 211 }
 212
 213 inline void XFFrame::SetHeight(double height)
 214 {
 215     m_aRect.SetHeight(height);
 216     m_nFrameFlag |= XFFRAME_FLAG_HEIGHT;
 217     m_nFrameFlag &= XFFRAME_FLAG_HEIGHT;
 218 }
 219
 220 inline void XFFrame::SetMinHeight(double minHeight)
 221 {
 222     m_fMinHeight = minHeight;
 223     m_nFrameFlag |= XFFRAME_FLAG_MINHEIGHT;
 224     m_nFrameFlag &= XFFRAME_FLAG_MINHEIGHT;
 225 }
 226
 227 inline void XFFrame::SetPosition(double x, double y, double width, double height)
 228 {
 229     m_aRect.SetStartPoint(XFPoint(x,y));
 230     m_aRect.SetSize(width,height);
 231     m_nFrameFlag |= XFFRAME_FLAG_HEIGHT;
 232 }
 233
 234 inline void XFFrame::SetPosition(const XFRect& rect)
 235 {
 236     m_aRect = rect;
 237 }
 238
 239 inline void XFFrame::SetNextLink(const OUString& next)
 240 {
 241     m_strNextLink = next;
 242 }
 243
 244 inline void XFFrame::SetAnchorPage(sal_Int32 page)
 245 {
 246     m_nAnchorPage = page;
 247 }
 248
 249 #endif
 250
 251 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */