lotuswordpro/inc/xfilter/xfbgimage.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  * Background image.
  59  ************************************************************************/
  60 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFBGIMAGE_HXX
  61 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFBGIMAGE_HXX
  62
  63 #include <xfilter/xfstyle.hxx>
  64
  65 /**
  66  * @brief
  67  * Background image object.
  68  */
  69 class XFBGImage : public XFStyle
  70 {
  71 public:
  72     XFBGImage();
  73
  74 public:
  75     /**
  76      * @descr   Use file link as image source.
  77      */
  78     void SetFileLink(const OUString& fileName);
  79
  80     /**
  81      * @descr   Use base64 stream as image source.
  82      */
  83     void SetImageData(sal_uInt8 const* buf, int len);
  84
  85     /**
  86      * @descr   Set the image position type.
  87      */
  88     void SetPosition(enumXFAlignType horiAlign = enumXFAlignCenter,
  89                      enumXFAlignType vertAlign = enumXFAlignCenter);
  90
  91     /**
  92      * @descr   Set background image repeat style.
  93      */
  94     void SetRepeate();
  95
  96     /**
  97      * @descr   Set whether the image should be stretched to fill the owner object.
  98      */
  99     void SetStretch();
 100
 101     /**
 102      * @descr   decide whether there has been a style that is the same as this object.
 103      *          If it use base64 stream, i'll simply return sal_False because it's too slow to compare two base64 stream.
 104      */
 105     virtual bool Equal(IXFStyle* pStyle) override;
 106
 107     virtual void ToXml(IXFStream* pStrm) override;
 108
 109     friend bool operator==(XFBGImage const& img1, XFBGImage const& img2);
 110     friend bool operator!=(XFBGImage const& img1, XFBGImage const& img2);
 111
 112 private:
 113     OUString m_strFileName;
 114     OUString m_strData;
 115     bool m_bUserFileLink;
 116     bool m_bRepeate;
 117     bool m_bStretch;
 118     bool m_bPosition;
 119     enumXFAlignType m_eHoriAlign;
 120     enumXFAlignType m_eVertAlign;
 121 };
 122
 123 inline void XFBGImage::SetFileLink(const OUString& fileName)
 124 {
 125     m_strFileName = fileName;
 126     m_bUserFileLink = true;
 127 }
 128
 129 inline void XFBGImage::SetPosition(enumXFAlignType horiAlign, enumXFAlignType vertAlign)
 130 {
 131     m_bPosition = true;
 132     m_eHoriAlign = horiAlign;
 133     m_eVertAlign = vertAlign;
 134
 135     m_bStretch = false;
 136     m_bRepeate = false;
 137 }
 138
 139 inline void XFBGImage::SetRepeate()
 140 {
 141     m_bRepeate = true;
 142     m_bStretch = false;
 143     m_bPosition = false;
 144 }
 145
 146 inline void XFBGImage::SetStretch()
 147 {
 148     m_bStretch = true;
 149     m_bRepeate = false;
 150     m_bPosition = false;
 151 }
 152
 153 #endif
 154
 155 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */