IContentContext.cs :  » PDF » PDF-Clown » it » stefanochizzolini » clown » documents » contents » C# / CSharp Open Source

/*
  Copyright 2006,2007 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.objects;

namespace it.stefanochizzolini.clown.documents.contents{
  /**
    <summary>Content stream context.</summary>
  */
  public interface IContentContext
    : IContentEntity
  {
    /**
      <summary>Gets the bounding box associated with the object, either explicitly
      (directly associated to the object) or (if not explicitly available) implicitly
      (inherited from a higher level object).</summary>
      <remarks>
        <para>The box represents the physical-coordinates frame expressed in default
        user-space units. This frame is crucial for the proper positioning of graphic
        elements on the canvas, as the spec [PDF:1.6:4.2] *sadly* states that the
        coordinate system is positively-oriented, although the typographic coordinates
        would be conveniently expressed as negatively-oriented.</para>
      </remarks>
    */
    PdfArray Box
    {get;}

    /**
      <summary>Gets the contents collection representing the content stream.</summary>
    */
    Contents Contents
    {get;}

    /**
      <summary>Gets the resources associated with the object, either explicitly
      (directly associated to the object) or (if not explicitly available) implicitly
      (inherited from a higher level object).</summary>
      <remarks>The implementing class MUST ensure that the returned object isn't null.</remarks>
    */
    Resources Resources
    {get;}
  }
}