/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2025, Open Design Alliance (the "Alliance").
// All rights reserved.
//
// This software and its documentation and related materials are owned by
// the Alliance. The software may only be incorporated into application
// programs owned by members of the Alliance, subject to a signed
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable
// trade secrets of the Alliance and its suppliers. The software is also
// protected by copyright law and international treaty provisions. Application
// programs incorporating this software must include the following statement
// with their copyright notices:
//
//   This application incorporates Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 by Open Design Alliance.
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#if !defined(ODA_ODMVDXMLBODY_H_INCLUDED_)
#define ODA_ODMVDXMLBODY_H_INCLUDED_

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#include "MvdXmlElement.h"

/** \details 
Contains declarations related to Model View Definition (MVD) functionality.
*/
namespace OdMvdXml
{
  SMARTPTR(OdMvdXmlBody);

  /** \details 
    A class that stores and handles data of an MVDXML Body element. 
    A body element usually contains definition text and remarks that explain details. 
    It also contains language tag and a set of tags, which represent data about the classification of a definition or a remark.
  */
  class MVDXML_EXPORT OdMvdXmlBody : public OdMvdXmlElement
  {
    ODRX_DECLARE_MEMBERS(OdMvdXmlBody);

  public:
    /** \details
      Retrieves the language tag value.
      \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the language tag text.
      \remarks 
      Language tag value is represented with a locale identifier based on the language codes defined within the RFC 1766.
      For example: ‘en’, ‘de’, ‘en - GB’, ’de - CH’.
    */
    OdAnsiString& getLang() { return m_lang; };
    
    /** \details 
      Sets the new value of the language tag for the Body element.
      \param value [in] An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the new value of the language tag.
      \remarks 
      Language tag value is represented with a locale identifier based on the language codes defined within the RFC 1766.
      For example: ‘en’, ‘de’, ‘en - GB’, ’de - CH’.
    */
    void setLang(OdAnsiString&value) { m_lang = value; };
    
    /** \details
      Retrieves the tags associated with the Body element (excluding language tag).
      \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the tags.
      \remarks 
      All tags are separated with a whitespace per default. If any tag consists of several words, the semicolon must be used as a separator.
    */
    OdAnsiString& getTags() { return m_tags; };
    
    /** \details 
      Sets a new array of tags associated with the Body element (excluding language tag).
      \param value [in] An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the new tags.
      \remarks 
      All tags are separated with a whitespace per default. If any tag consists of several words, the semicolon must be used as a separator.
    */
    void setTags(OdAnsiString&value) { m_tags = value; };
    
    /** \details
      Retrieves the current value of the Body element.
      \returns An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the Body element value.
      \remarks 
      The Body element value is an HTML-formatted text.
    */
    OdAnsiString& getValue() { return m_value; };
    
    /** \details 
      Sets a new value of the Body element. 
      \param value [in] An <exref target="../tkernel_api_cpp/OdAnsiString.html">ANSI string</exref> that contains the new value to set.
      \remarks 
      The Body element value is an HTML-formatted text.      
    */
    void SetValue(OdAnsiString&value) { m_value = value; };

    /** \details
      The assignment operator for MVDXML Body elements.
      \param other [in] Another <exref target="../tifc_api_cpp/OdMvdXml__OdMvdXmlBody.html">OdMvdXmlBody</exref> object to be assigned (right-hand operand of the assignment operation).
      \returns A reference to the Body element object modified by the assignment operation.
    */
    OdMvdXmlBody& operator=(const OdMvdXmlBody& other);

  protected:
    /** \details
      Copy data from the other object.

      \param other [in] Object to copy from.
    */
    void assign(const OdMvdXmlBody* other);

    /** \details
      Retrieves the name of the element. This name is used to write the element to a file.

      \returns The name of the element.
    */
    virtual OdAnsiString getElementName();

    /** \details
      Reads attributes from a xml element.

      \param pItem [in] Pointer to a xml element containing attributes.

      \returns eOk if the data was successfully read; otherwise, the method returns an appropriate error code.
    */
    virtual OdResult inAttributes(TiXmlElement* pItem) override;

    virtual OdResult outAttributes(TiXmlElement* pItem) override;

  private:
    
    /** \details
      Locale identifier based on RFC 1766 language codes to indicate the default locale.
      Examples are ‘en’, ‘de’, ‘en - GB’, ’de - CH’.
    */
    OdAnsiString m_lang;

    /** \details
      List of tags that classify the element. All tags are separated through whitespaces
      per default. A semicolon must be used if given tags consists of multiple words.
    */
    OdAnsiString m_tags;
    /** \details
      HTML-formatted content for generating documentation.
    */
    OdAnsiString m_value;
  };
}

#endif // !defined(ODA_ODMVDXMLBODY_H_INCLUDED_)