/*******************************************************************************
 * Copyright (c) 2006, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/
module dwtx.jface.text.revisions.IRevisionRulerColumnExtension;

import dwtx.jface.text.revisions.IRevisionListener; // packageimport
import dwtx.jface.text.revisions.RevisionRange; // packageimport
import dwtx.jface.text.revisions.IRevisionRulerColumn; // packageimport
import dwtx.jface.text.revisions.RevisionEvent; // packageimport
import dwtx.jface.text.revisions.RevisionInformation; // packageimport
import dwtx.jface.text.revisions.Revision; // packageimport


import dwt.dwthelper.utils;


import dwtx.core.runtime.Assert;
import dwtx.jface.viewers.ISelectionProvider;

    static this(){
        IRevisionRulerColumnExtension.AUTHOR= new IRevisionRulerColumnExtension.RenderingMode("Author"); //$NON-NLS-1$
        IRevisionRulerColumnExtension.AGE= new IRevisionRulerColumnExtension.RenderingMode("Age"); //$NON-NLS-1$
        IRevisionRulerColumnExtension.AUTHOR_SHADED_BY_AGE= new IRevisionRulerColumnExtension.RenderingMode("Both"); //$NON-NLS-1$
    }

/**
 * Extension interface for {@link IRevisionRulerColumn}.
 * <p>
 * Introduces the ability to register a selection listener on revisions and configurable rendering
 * modes.
 * </p>
 *
 * @see IRevisionRulerColumn
 * @since 3.3
 */
public interface IRevisionRulerColumnExtension {

    /**
     * Rendering mode type-safe enum.
     */
    final class RenderingMode {
        private const String fName;
        private this(String name) {
            Assert.isLegal(name !is null);
            fName= name;
        }
        /**
         * Returns the name of the rendering mode.
         * @return the name of the rendering mode
         */
        public String name() {
            return fName;
        }
    }

    /**
     * Rendering mode that assigns a unique color to each revision author.
     */
    static const RenderingMode AUTHOR;
    /**
     * Rendering mode that assigns colors to revisions by their age.
     * <p>
     * Currently the most recent revision is red, the oldest is a faint yellow.
     * The coloring scheme can change in future releases.
     * </p>
     */
    static const RenderingMode AGE;
    /**
     * Rendering mode that assigns unique colors per revision author and
     * uses different color intensity depending on the age.
     * <p>
     * Currently it selects lighter colors for older revisions and more intense
     * colors for more recent revisions.
     * The coloring scheme can change in future releases.
     * </p>
     */
    static const RenderingMode AUTHOR_SHADED_BY_AGE;

    /**
     * Changes the rendering mode and triggers redrawing if needed.
     *
     * @param mode the rendering mode
     */
    void setRevisionRenderingMode(RenderingMode mode);

    /**
     * Enables showing the revision id.
     *
     * @param show <code>true</code> to show the revision, <code>false</code> to hide it
     */
    void showRevisionId(bool show);

    /**
     * Enables showing the revision author.
     *
     * @param show <code>true</code> to show the author, <code>false</code> to hide it
     */
    void showRevisionAuthor(bool show);

    /**
     * Returns the revision selection provider.
     *
     * @return the revision selection provider
     */
    ISelectionProvider getRevisionSelectionProvider();

    /**
     * Adds a revision listener that will be notified when the displayed revision information
     * changes.
     *
     * @param listener the listener to add
     */
    void addRevisionListener(IRevisionListener listener);

    /**
     * Removes a previously registered revision listener; nothing happens if <code>listener</code>
     * was not registered with the receiver.
     *
     * @param listener the listener to remove
     */
    void removeRevisionListener(IRevisionListener listener);
}