///////////////////////////////////////////////////////////////////////////////
// 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.
///////////////////////////////////////////////////////////////////////////////

#ifndef _PRCMARKUPSERIALIZATIONHELPER_INCLUDED_
#define _PRCMARKUPSERIALIZATIONHELPER_INCLUDED_ 
 

#include "PrcFontKeysSameFont.h"

/** \details
The class stores and operates the serialization data for markup font information.

<group PRC_Markup_Classes>    
*/
class PRC_TOOLKIT OdPrcMarkupSerializationHelper
{
private:
  OdPrcFontKeysSameFontArray m_FontKeysSameFont;
  OdString                   m_default_font_family_name;

public:
  //DOM-IGNORE-BEGIN
  PRC_DECLARE_CIO(OdPrcMarkupSerializationHelper)
  //DOM-IGNORE-END

  /** \details
  Requests the current <link OdPrcFontKeysSameFontArray, array> of font keys that share the same font.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA.html">array</exref> of <link OdPrcFontKeysSameFont, OdPrcFontKeysSameFont> objects.
  \remarks 
  The <link OdPrcFontKeysSameFontArray, array> is returned via a reference, and therefore it can be used to set a new <link OdPrcFontKeysSameFontArray, array> of font keys that share the same font.
  To restrict modifications of the <link OdPrcFontKeysSameFontArray, array> outside the <link OdPrcMarkupSerializationHelper, OdPrcMarkupSerializationHelper> object, 
  call another <link OdPrcMarkupSerializationHelper::fontKeysSameFont@const, fontKeysSameFont()> method that returns a constant reference.
  */
  OdPrcFontKeysSameFontArray &fontKeysSameFont();
  
  /** \details
  Requests the current <link OdPrcFontKeysSameFontArray, array> of font keys that share the same font.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA.html">array</exref> of <link OdPrcFontKeysSameFont, OdPrcFontKeysSameFont> objects.
  */
  const OdPrcFontKeysSameFontArray &fontKeysSameFont() const;
  
  /** \details
  Sets a new default font family name for the text.

  \param default_font_family_name [in] A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the new default font family name.
  */
  void setDefaultFontFamilyName(OdString default_font_family_name);
  
  /** \details
  Requests the current default font family name for text.
  \returns A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the default font family name.
  */
  OdString defaultFontFamilyName() const;
};

#endif // _PRCMARKUPSERIALIZATIONHELPER_INCLUDED_