lotuswordpro/inc/xfilter/xfshadow.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  * Shadow object,now only used by paragraph object.
  59  ************************************************************************/
  60 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFSHADOW_HXX
  61 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFSHADOW_HXX
  62
  63 #include <xfilter/ixfstream.hxx>
  64 #include <xfilter/xfcolor.hxx>
  65 #include <xfilter/xfdefs.hxx>
  66
  67 /**
  68  * @brief
  69  * Shadow object.
  70  */
  71 class XFShadow
  72 {
  73 public:
  74     XFShadow();
  75
  76 public:
  77     /**
  78      * @descr   set shadow position. You can refer to enumXFShadowPos to get all possible positions.
  79      */
  80     void    SetPosition(enumXFShadowPos pos);
  81
  82     /**
  83      * @descr   return shadow position.
  84      */
  85     enumXFShadowPos GetPosition() const;
  86
  87     /**
  88      * @descr   Set shadow offset from owner object.
  89      */
  90     void    SetOffset(double offset);
  91
  92     /**
  93      * @descr   return shadow offset.
  94      */
  95     double  GetOffset() const;
  96
  97     /**
  98      * @descr   Set shadow color.
  99      */
 100     void    SetColor(const XFColor& color);
 101
 102     /**
 103      * @descr   return shadow color.
 104      */
 105     const XFColor& GetColor() const;
 106
 107     OUString   ToString();
 108
 109     void    ToXml(IXFStream *pStrm);
 110
 111     friend bool operator==(XFShadow const & s1, XFShadow const & s2);
 112     friend bool operator!=(XFShadow const & s1, XFShadow const & s2);
 113 private:
 114     enumXFShadowPos m_ePosition;
 115     double          m_fOffset;
 116     XFColor         m_aColor;
 117 };
 118
 119 inline void XFShadow::SetPosition(enumXFShadowPos pos)
 120 {
 121     m_ePosition = pos;
 122 }
 123
 124 inline enumXFShadowPos XFShadow::GetPosition() const
 125 {
 126     return m_ePosition;
 127 }
 128
 129 inline void XFShadow::SetOffset(double offset)
 130 {
 131     m_fOffset = offset;
 132 }
 133
 134 inline double   XFShadow::GetOffset() const
 135 {
 136     return m_fOffset;
 137 }
 138
 139 inline void XFShadow::SetColor(const XFColor& color)
 140 {
 141     m_aColor = color;
 142 }
 143
 144 inline const XFColor& XFShadow::GetColor() const
 145 {
 146     return m_aColor;
 147 }
 148
 149 #endif
 150 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */