SoundAnnotation.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » interaction » annotations » C# / CSharp Open Source

/*
  Copyright 2008 Stefano Chizzolini. http://clown.stefanochizzolini.it

  Contributors:
    * Stefano Chizzolini (original code developer, http://www.stefanochizzolini.it)

  This file should be part of the source code distribution of "PDF Clown library"
  (the Program): see the accompanying README files for more info.

  This Program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later version.

  This Program is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY, either expressed or implied; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the License for more details.

  You should have received a copy of the GNU General Public License along with this
  Program (see README files); if not, go to the GNU website (http://www.gnu.org/).

  Redistribution and use, with or without modification, are permitted provided that such
  redistributions retain the above copyright notice, license and disclaimer, along with
  this list of conditions.
*/

using it.stefanochizzolini.clown.bytes;
using it.stefanochizzolini.clown.documents;
using it.stefanochizzolini.clown.documents.multimedia;
using it.stefanochizzolini.clown.objects;

using System;
using System.Collections.Generic;
using System.Drawing;

namespace it.stefanochizzolini.clown.documents.interaction.annotations{
  /**
    <summary>Sound annotation [PDF:1.6:8.4.5].</summary>
    <remarks>When the annotation is activated, the sound is played.</remarks>
  */
  public class SoundAnnotation
    : Annotation
  {
    #region types
    /**
      <summary>Icon to be used in displaying the annotation [PDF:1.6:8.4.5].</summary>
    */
    public enum IconTypeEnum
    {
      /**
        <summary>Speaker.</summary>
      */
      Speaker,
      /**
        <summary>Microphone.</summary>
      */
      Microphone
    };
    #endregion

    #region static
    #region fields
    private static readonly Dictionary<IconTypeEnum,PdfName> IconTypeEnumCodes;
    #endregion

    #region constructors
    static SoundAnnotation()
    {
      IconTypeEnumCodes = new Dictionary<IconTypeEnum,PdfName>();
      IconTypeEnumCodes[IconTypeEnum.Speaker] = PdfName.Speaker;
      IconTypeEnumCodes[IconTypeEnum.Microphone] = PdfName.Mic;
    }
    #endregion

    #region interface
    #region private
    /**
      <summary>Gets the code corresponding to the given value.</summary>
    */
    private static PdfName ToCode(
      IconTypeEnum value
      )
    {return IconTypeEnumCodes[value];}

    /**
      <summary>Gets the icon type corresponding to the given value.</summary>
    */
    private static IconTypeEnum ToIconTypeEnum(
      PdfName value
      )
    {
      foreach(KeyValuePair<IconTypeEnum,PdfName> iconType in IconTypeEnumCodes)
      {
        if(iconType.Value.Equals(value))
          return iconType.Key;
      }
      return IconTypeEnum.Speaker;
    }
    #endregion
    #endregion
    #endregion

    #region dynamic
    #region constructors
    public SoundAnnotation(
      Page page,
      RectangleF box,
      Sound sound
      ) : base(
        page.Document,
        PdfName.Sound,
        box,
        page
        )
    {Sound = sound;}

    public SoundAnnotation(
      PdfDirectObject baseObject,
      PdfIndirectObject container
      ) : base(baseObject,container)
    {}
    #endregion

    #region interface
    #region public
    public override object Clone(
      Document context
      )
    {throw new NotImplementedException();}

    /**
      <summary>Gets/Sets the icon to be used in displaying the annotation.</summary>
    */
    public IconTypeEnum IconType
    {
      get
      {return ToIconTypeEnum((PdfName)BaseDataObject[PdfName.Name]);}
      set
      {BaseDataObject[PdfName.Name] = ToCode(value);}
    }

    /**
      <summary>Gets/Sets the sound to be played.</summary>
    */
    public Sound Sound
    {
      get
      {
        /*
          NOTE: 'Sound' entry MUST exist.
        */
        return new Sound(
          BaseDataObject[PdfName.Sound]
          );
      }
      set
      {
        if(value == null)
          throw new ArgumentException("Sound MUST be defined.");

        BaseDataObject[PdfName.Sound] = value.BaseObject;
      }
    }
    #endregion
    #endregion
    #endregion
  }
}