lotuswordpro/inc/xfilter/xfcell.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.
  59  ************************************************************************/
  60
  61 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCELL_HXX
  62 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCELL_HXX
  63
  64 #include <xfilter/xfcontent.hxx>
  65 #include <xfilter/xfcontentcontainer.hxx>
  66 #include <svl/SfxBroadcaster.hxx>
  67
  68 class XFTable;
  69 class XFRow;
  70
  71 /**
  72  * @descr   Table cell object.
  73  */
  74 class XFCell : public XFContentContainer
  75              , public SfxBroadcaster
  76 {
  77 public:
  78     XFCell();
  79
  80     virtual ~XFCell() override;
  81
  82 public:
  83     using XFContentContainer::Add;
  84
  85     /**
  86      * @descr   Add content for table cell.
  87      */
  88     void    Add(XFContent *pContent) override;
  89
  90     /**
  91      * @descr   If cell spans more the one column, then set column span.
  92      */
  93     void    SetColumnSpaned(sal_Int32 num);
  94
  95     /**
  96      * @descr   Set whether the following cells use the same style and content.
  97      */
  98     void    SetRepeated(sal_Int32 num);
  99
 100     /**
 101      * @descr   Set cell number value.
 102      */
 103     void    SetValue(double value);
 104
 105     /**
 106      * @descr   Set cell number value.
 107      */
 108     void    SetValue(const OUString& value);
 109
 110     /**
 111      * @descr   Set cell formula.
 112      */
 113     void    SetFormula(const OUString& formula);
 114
 115     /**
 116      * @descr   Set cell protected.
 117      */
 118     void    SetProtect(bool protect);
 119
 120     /**
 121      * @descr   Set cell column id.
 122      */
 123     void    SetCol(sal_Int32 col);
 124
 125     /**
 126      * @descr   Set cell owner row.
 127      */
 128     void    SetOwnerRow(XFRow *pRow);
 129
 130     /**
 131      * @descr   Return cell name. It's a tool function for formula.
 132      */
 133     OUString   GetCellName();
 134
 135     /**
 136      * @descr   return cell column span property.
 137      */
 138     sal_Int32   GetColSpaned() const;
 139
 140     /**
 141      * @descr   Output cell as xml element.
 142      */
 143     virtual void    ToXml(IXFStream *pStrm) override;
 144
 145     const XFTable*  GetSubTable() const { return m_pSubTable.get(); }
 146
 147 private:
 148     XFRow          *m_pOwnerRow;
 149     rtl::Reference<XFTable>
 150                     m_pSubTable;
 151     sal_Int32       m_nCol;
 152     sal_Int32       m_nColSpaned;
 153     sal_Int32       m_nRepeated;
 154     enumXFValueType m_eValueType;
 155     OUString        m_strValue;
 156     OUString        m_strFormula;
 157     bool            m_bProtect;
 158 };
 159
 160 inline void XFCell::SetColumnSpaned(sal_Int32 num)
 161 {
 162     m_nColSpaned = num;
 163 }
 164
 165 inline void XFCell::SetRepeated(sal_Int32 repeated)
 166 {
 167     m_nRepeated = repeated;
 168 }
 169
 170 inline void XFCell::SetFormula(const OUString& formula)
 171 {
 172     m_strFormula = formula;
 173 }
 174
 175 inline void XFCell::SetProtect(bool protect/* =sal_True */)
 176 {
 177     m_bProtect = protect;
 178 }
 179
 180 inline void XFCell::SetCol(sal_Int32 col)
 181 {
 182     m_nCol = col;
 183 }
 184
 185 inline void XFCell::SetOwnerRow(XFRow *pRow)
 186 {
 187     m_pOwnerRow = pRow;
 188 }
 189
 190 inline sal_Int32 XFCell::GetColSpaned() const
 191 {
 192     return m_nColSpaned;
 193 }
 194
 195 #endif
 196 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */