xmltooling/AbstractComplexElement.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/AbstractComplexElement.h
  23  *
  24  * AbstractXMLObject mixin that implements children
  25  */
  26
  27 #ifndef __xmltooling_abscomplexel_h__
  28 #define __xmltooling_abscomplexel_h__
  29
  30 #include <xmltooling/AbstractXMLObject.h>
  31
  32 #if defined (_MSC_VER)
  33     #pragma warning( push )
  34     #pragma warning( disable : 4250 4251 )
  35 #endif
  36
  37 namespace xmltooling {
  38
  39     /**
  40      * AbstractXMLObject mixin that implements children.
  41      * Inherit from this class to implement an element with child objects and mixed content.
  42      */
  43     class XMLTOOL_API AbstractComplexElement : public virtual AbstractXMLObject
  44     {
  45     public:
  46         virtual ~AbstractComplexElement();
  47
  48         // Virtual function overrides.
  49         bool hasChildren() const;
  50         const std::list<XMLObject*>& getOrderedChildren() const;
  51         void removeChild(XMLObject* child);
  52         const XMLCh* getTextContent(unsigned int position=0) const;
  53         void setTextContent(const XMLCh* value, unsigned int position=0);
  54
  55     protected:
  56         AbstractComplexElement();
  57
  58         /** Copy constructor. */
  59         AbstractComplexElement(const AbstractComplexElement& src);
  60
  61         /**
  62          * Underlying list of child objects.
  63          * Manages the lifetime of the children.
  64          */
  65         std::list<XMLObject*> m_children;
  66
  67         /**
  68          * Interstitial text nodes.
  69          * Needed to support mixed content, and preserve DOM whitespace across rebuilds.
  70          */
  71         std::vector<XMLCh*> m_text;
  72     };
  73
  74 };
  75
  76 #if defined (_MSC_VER)
  77     #pragma warning( pop )
  78 #endif
  79
  80 #endif /* __xmltooling_abscomplexel_h__ */