///////////////////////////////////////////////////////////////////////////////
// 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 _PRCFONTKEYSSAMEFONT_INCLUDED_
#define _PRCFONTKEYSSAMEFONT_INCLUDED_ 
 

/** \details
Class stores and operates information about a list of usages for the same font and character set with various attributes.

<group PRC_Miscellaneous_Classes>
*/
class PRC_TOOLKIT OdPrcFontKeysSameFont
{
public:
  /** \details
  A structure that stores information about font attributes. 
  */
  struct FontKey
  {
    /** \details
    Creates a new instance of the font attributes structure with default parameters.
    */
    FontKey()
    {
      font_size = attributes = 0;
    }

    /** Font size.*/
    OdInt32 font_size; 

    /** \details 
    Font attribute flags. 
    Flags are stored in the appropriate bits of an 8-bit unsigned integer, according to the table below.  
    <table>
    <tr><th>Bit Position</th><th>Value (when Only This flag is ON)</th><th>Description</th></tr>
    <tr><td>0</td><td>1</td><td>Bold flag.</td></tr>
    <tr><td>1</td><td>2</td><td>Italic flag.</td></tr>
    <tr><td>2</td><td>4</td><td>Underlined flag.</td></tr>
    <tr><td>3</td><td>8</td><td>Strike-Out flag.</td></tr>
    <tr><td>4</td><td>16</td><td>Overlined flag.</td></tr>
    <tr><td>5</td><td>32</td><td>Stretch flag. If switched on, it indicates that the text must be stretched to fit within its bounding box. It used only if the original font is not used.</td></tr>
    <tr><td>6</td><td>64</td><td>Wire flag. If switched on, the original font is a wireframe font.</td></tr>
    <tr><td>7</td><td>128</td><td>Fixed width flag. If switched on, the original font is not proportional (each glyph has the same width).</td></tr>
  </table>
    */
    OdUInt8 attributes;
  };

private:
  OdArray<FontKey>  m_font_keys;
  OdUInt32          m_char_set;
  OdString          m_font_name;

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

  /** \details
  Requests the current list of font keys.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA__OdArray@OdArray__.html">array</exref> of <link OdPrcFontKeysSameFont::FontKey, FontKey> items.
  \remarks 
  The <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA__OdArray@OdArray__.html">array</exref> is returned via a reference, and therefore it can be used to set a new array.
  To restrict modifications of the font key array outside the <link OdPrcFontKeysSameFont, OdPrcFontKeysSameFont> object, 
  call another <link OdPrcFontKeysSameFont::fontKeys@const, fontKeys()> method that returns a constant reference.
  */
  OdArray<FontKey> &fontKeys();
  
  /** \details
  Requests the current list of font keys.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA__OdArray@OdArray__.html">array</exref> of <link OdPrcFontKeysSameFont::FontKey, FontKey> items.
  */
  const OdArray<FontKey> &fontKeys() const;
  
  /** \details
  Sets a new font name.
  
  \param font_name [in] A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the new font name.
  */
  void setFontName(OdString font_name);
  
  /** \details
  Requests the current font name.
  \returns A <exref target="https://docs.opendesign.com/tkernel/OdString.html">string</exref> that contains the current font name.
  */
  OdString fontName() const;
  
  /** \details
  Sets a new character set code for the font.
  
  \param char_set [in] An unsigned 32-bit integer that contains the code of the new character set.
  
  \remarks 
  Applicable codes for character sets are represented in the table below:
  <table>
    Value   Description
    0       Roman 
    1       Japanese 
    2       Traditional Chinese 
    3       Korean 
    4       Arabic 
    5       Hebrew 
    6       Greek 
    7       Cyrillic 
    8       RightLeft 
    9       Devanagari 
    10      Gurmukhi 
    11      Gujarati 
    12      Oriya 
    13      Bengali 
    14      Tamil 
    15      Telugu 
    16      Kannada 
    17      Malayalam 
    18      Sinhalese 
    19      Burmese 
    20      Khmer 
    21      Thai 
    22      Laotian 
    23      Georgian 
    24      Armenian 
    25      Simplified Chinese 
    26      Tibetan 
    27      Mongolian 
    28      Geez 
    29      EastEuropeanRoman 
    30      Vietnamese 
    31      ExtendedArabic
  </table>
  */
  void setCharSet(OdUInt32 char_set);
  
  /** \details
  Requests the current character set.
  \returns An unsigned 32-bit integer that contains the code of the current character set.
  \remarks 
  Applicable codes for character sets are represented in the table below:
  <table>
    Value   Description
    0       Roman 
    1       Japanese 
    2       Traditional Chinese 
    3       Korean 
    4       Arabic 
    5       Hebrew 
    6       Greek 
    7       Cyrillic 
    8       RightLeft 
    9       Devanagari 
    10      Gurmukhi 
    11      Gujarati 
    12      Oriya 
    13      Bengali 
    14      Tamil 
    15      Telugu 
    16      Kannada 
    17      Malayalam 
    18      Sinhalese 
    19      Burmese 
    20      Khmer 
    21      Thai 
    22      Laotian 
    23      Georgian 
    24      Armenian 
    25      Simplified Chinese 
    26      Tibetan 
    27      Mongolian 
    28      Geez 
    29      EastEuropeanRoman 
    30      Vietnamese 
    31      ExtendedArabic
  </table>
  */
  OdUInt32 charSet() const;
};

/** \details 
A data type that represents an <exref target="https://docs.opendesign.com/tkernel/OdArray@classT@classA.html">array</exref> of <link OdPrcFontKeysSameFont, OdPrcFontKeysSameFont> objects.
*/
typedef OdArray<OdPrcFontKeysSameFont> OdPrcFontKeysSameFontArray;

#endif // _PRCFONTKEYSSAMEFONT_INCLUDED_