using System;

/*
 * $Id: IDocListener.cs 229 2011-02-18 22:05:59Z psoares33 $
 * 
 *
 * This file is part of the iText project.
 * Copyright (c) 1998-2012 1T3XT BVBA
 * Authors: Bruno Lowagie, Paulo Soares, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Affero General Public License for more details.
 * You should have received a copy of the GNU Affero General Public License
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * you must retain the producer line in every PDF that is created or manipulated
 * using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: sales@itextpdf.com
 */

namespace iTextSharp.text {
    /// <summary>
    /// A class that implements DocListener will perform some
    /// actions when some actions are performed on a Document.
    /// </summary>
    /// <seealso cref="T:iTextSharp.text.IElementListener"/>
    /// <seealso cref="T:iTextSharp.text.Document"/>
    /// <seealso cref="T:iTextSharp.text.DocWriter"/>
    public interface IDocListener : IElementListener, IDisposable {
    
        // methods
    
        /// <summary>
        /// Signals that the Document has been opened and that
        /// Elements can be added.
        /// </summary>
        void Open();
    
        /// <summary>
        /// Signals that the Document was closed and that no other
        /// Elements will be added.
        /// </summary>
        /// <remarks>
        /// The output stream of every writer implementing IDocListener will be closed.
        /// </remarks>
        void Close();

        /// <summary>
        /// Signals that an new page has to be started.
        /// </summary>
        /// <returns>true if the page was added, false if not.</returns>
        bool NewPage();
    
        /// <summary>
        /// Sets the pagesize.
        /// </summary>
        /// <param name="pageSize">the new pagesize</param>
        /// <returns>a boolean</returns>
        bool SetPageSize(Rectangle pageSize);
    
        /// <summary>
        /// Sets the margins.
        /// </summary>
        /// <param name="marginLeft">the margin on the left</param>
        /// <param name="marginRight">the margin on the right</param>
        /// <param name="marginTop">the margin on the top</param>
        /// <param name="marginBottom">the margin on the bottom</param>
        /// <returns></returns>
        bool SetMargins(float marginLeft, float marginRight, float marginTop, float marginBottom);
    
        /**
        * Parameter that allows you to do margin mirroring (odd/even pages)
        * @param marginMirroring
        * @return true if succesfull
        */
        bool SetMarginMirroring(bool marginMirroring);

        /**
        * Parameter that allows you to do top/bottom margin mirroring (odd/even pages)
        * @param marginMirroringTopBottom
        * @return true if successful
        * @since	2.1.6
        */
        bool SetMarginMirroringTopBottom(bool marginMirroringTopBottom); // [L6]

        /// <summary>
        /// Sets the page number.
        /// </summary>
        /// <value>the new page number</value>
        int PageCount {
            set;
        }
    
        /// <summary>
        /// Sets the page number to 0.
        /// </summary>
        void ResetPageCount();    
    }
}
