lotuswordpro/inc/xfilter/xfcontentcontainer.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  * Container for content.It will destroy all children when destroy.
  59  ************************************************************************/
  60 #ifndef INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCONTENTCONTAINER_HXX
  61 #define INCLUDED_LOTUSWORDPRO_INC_XFILTER_XFCONTENTCONTAINER_HXX
  62
  63 #include <sal/config.h>
  64
  65 #include <vector>
  66
  67 #include <rtl/ref.hxx>
  68
  69 #include <xfilter/xfcontent.hxx>
  70
  71 /**
  72  * @brief
  73  * A container for content.
  74  * The contents will be deleted when delete container.
  75  */
  76 class XFContentContainer : public XFContent
  77 {
  78 public:
  79     XFContentContainer();
  80
  81     /**
  82      * @descr   Destructure, all contents will be deleted too.
  83      */
  84     virtual ~XFContentContainer() override;
  85
  86 public:
  87     /**
  88      * @descr   Add content.
  89      */
  90     virtual void Add(XFContent* pContent);
  91
  92     rtl::Reference<XFContent> GetLastContent();
  93     void RemoveLastContent();
  94     /**
  95      * @descr   convenience function for add text content.
  96      */
  97     void Add(const OUString& text);
  98
  99     /**
 100      * @descr   return the number of contents in the container.
 101      */
 102     int GetCount() const;
 103
 104     /**
 105      * @descr   get content by index.
 106      */
 107     rtl::Reference<XFContent> GetContent(sal_uInt32 index) const;
 108
 109     /**
 110      * @descr   clear all contents in the container.
 111      */
 112     void Reset();
 113
 114     /**
 115      * @descr   helper function, find first content by type.
 116      */
 117     rtl::Reference<XFContent> FindFirstContent(enumXFContent type);
 118
 119     /**
 120      * @descr   return the content type.
 121      */
 122     virtual enumXFContent GetContentType() override;
 123     /**
 124      * @descr   Output to OOo model or local file.
 125      */
 126     virtual void ToXml(IXFStream* pStrm) override;
 127
 128     bool HierarchyContains(const XFContent* pContent) const;
 129
 130 private:
 131     std::vector<rtl::Reference<XFContent>> m_aContents;
 132 };
 133
 134 inline rtl::Reference<XFContent> XFContentContainer::GetContent(sal_uInt32 index) const
 135 {
 136     if (index > m_aContents.size() - 1)
 137         return nullptr;
 138     return m_aContents[index];
 139 }
 140 #endif
 141
 142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */