lotuswordpro/inc/xfilter/xfcellstyle.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  * Table cell style. Number format, string value, and so on...
  59  ************************************************************************/
  60 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCELLSTYLE_HXX
  61 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCELLSTYLE_HXX
  62
  63 #include <sal/config.h>
  64
  65 #include <rtl/ref.hxx>
  66
  67 #include <xfilter/xfstyle.hxx>
  68 #include <xfilter/xfcolor.hxx>
  69 #include <xfilter/xfmargins.hxx>
  70 #include <xfilter/xfpadding.hxx>
  71 #include <xfilter/xfshadow.hxx>
  72
  73 #include <memory>
  74
  75 class XFBorders;
  76 class XFFont;
  77 class XFBorders;
  78 class XFMargins;
  79 class XFBGImage;
  80
  81 /**
  82  * @descr   Style object for cell.
  83  */
  84 class XFCellStyle : public XFStyle
  85 {
  86 public:
  87     XFCellStyle();
  88
  89     virtual ~XFCellStyle() override;
  90
  91 public:
  92     /**
  93      * @descr   Set cell data format style name.
  94      */
  95     void SetDataStyle(const OUString& style);
  96
  97     /**
  98      * @descr:  Set the padding of the paragraph.This is the distance
  99                 between the border and the top of the text.
 100      * @param:  indent value of the padding.
 101      */
 102     void SetPadding(double left, double right, double top, double bottom);
 103
 104     /**
 105      * @descr:  Set alignment property of the cell.
 106      * @param:  eAlign alignment type,left,right,center or justify.
 107      */
 108     void SetAlignType(enumXFAlignType hori, enumXFAlignType vert);
 109
 110     /**
 111      * @descr:  The borders are complex, so you have to create one before use.
 112                 Very few paragraphs will already have borders property, this way
 113                 we can save much memory.
 114      * @param:  pBorders borders of the paragraph, please reference the XFBorders.
 115      */
 116     void SetBorders(XFBorders* pBorders);
 117
 118     /**
 119      * @descr:  Set background color of the cell.
 120      * @param:  color value of the back color.
 121      */
 122     void SetBackColor(XFColor const& color);
 123
 124     /**
 125      * descr:   set cell background image.
 126      */
 127     void SetBackImage(std::unique_ptr<XFBGImage>& rImage);
 128
 129     virtual enumXFStyle GetStyleFamily() override;
 130
 131     virtual bool Equal(IXFStyle* pStyle) override;
 132
 133     virtual void ToXml(IXFStream* pStrm) override;
 134
 135 private:
 136     OUString m_strDataStyle;
 137     enumXFAlignType m_eHoriAlign;
 138     enumXFAlignType m_eVertAlign;
 139
 140     XFColor m_aBackColor;
 141     std::unique_ptr<XFBGImage> m_xBackImage;
 142     XFMargins m_aMargin;
 143     XFPadding m_aPadding;
 144     rtl::Reference<XFFont> m_pFont;
 145     XFShadow m_aShadow;
 146     std::unique_ptr<XFBorders> m_pBorders;
 147 };
 148
 149 inline void XFCellStyle::SetAlignType(enumXFAlignType hori, enumXFAlignType vert)
 150 {
 151     m_eHoriAlign = hori;
 152     m_eVertAlign = vert;
 153 }
 154
 155 inline void XFCellStyle::SetDataStyle(const OUString& style) { m_strDataStyle = style; }
 156
 157 #endif
 158
 159 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */