lotuswordpro/inc/xfilter/xfnumfmt.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  * Number format. a),A),i),1),(1)
  59  ************************************************************************/
  60 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFNUMFMT_HXX
  61 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFNUMFMT_HXX
  62
  63 #include <xfilter/ixfstream.hxx>
  64 #include <xfilter/ixfattrlist.hxx>
  65
  66 /**
  67  * @brief
  68  * Bullet number format.
  69  */
  70 class XFNumFmt
  71 {
  72 public:
  73     XFNumFmt()
  74     {
  75         m_nStartValue = 0;
  76     }
  77
  78 public:
  79     /**********************************************************************
  80      * @descr:      set the prefix of the number format,that the '(' of output
  81                     (1 item1
  82                     (2 item2
  83      * @param:      prefix
  84      *********************************************************************/
  85     void    SetPrefix(const OUString& prefix)
  86     {
  87         m_strPrefix = prefix;
  88     }
  89
  90     /**********************************************************************
  91      * @descr:      set the suffix of the number format,that the ')' of output
  92                     1) item1
  93                     2) item2
  94      * @param:      prefix
  95      *********************************************************************/
  96     void    SetSuffix(const OUString& suffix)
  97     {
  98         m_strSuffix = suffix;
  99     }
 100
 101     /**********************************************************************
 102      * @descr:      set the display value. ie. if you set format to '1',then
 103                     the output would be:
 104                         1 item1
 105                         2 item2
 106                     or if you set the format to 'a', then the output would be:
 107                         a item1
 108                         b item2
 109                     some special, if you set the format to a sequence,ie. "一,二,三,..."
 110                     the output would be:
 111                         一 item1
 112                         二 item2
 113                         三 item3
 114
 115                     Of course, for unordered-list, you can also set the format to
 116                     be a bullet char,ie:
 117                         '','','','','',
 118      * @param:      prefix
 119      *********************************************************************/
 120     void    SetFormat(const OUString& format)
 121     {
 122         m_strFormat = format;
 123     }
 124
 125     void    SetStartValue(sal_Int16 start)
 126     {
 127         m_nStartValue = start;
 128     }
 129
 130     void ToXml(IXFStream *pStrm)
 131     {
 132         IXFAttrList *pAttrList = pStrm->GetAttrList();
 133
 134         if( !m_strPrefix.isEmpty() )
 135             pAttrList->AddAttribute( "style:num-prefix", m_strPrefix );
 136         if( !m_strSuffix.isEmpty() )
 137             pAttrList->AddAttribute( "style:num-suffix", m_strSuffix );
 138         pAttrList->AddAttribute( "style:num-format", m_strFormat );
 139         if( m_nStartValue != 0 )
 140             pAttrList->AddAttribute( "text:start-value", OUString::number(static_cast<sal_Int32>(m_nStartValue)) );
 141     }
 142 private:
 143     OUString   m_strPrefix;
 144     OUString   m_strSuffix;
 145     OUString   m_strFormat;
 146     sal_Int16   m_nStartValue;
 147 };
 148
 149 #endif
 150 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */