source: trunk/sources/HeuristicLab.ExtLibs/HeuristicLab.Netron/3.0.2672.12446/Netron.Diagramming.Core-3.0.2672.12446/Core/Interfaces/IView.cs @ 2768

using System;
using System.Drawing;
using System.Drawing.Drawing2D;
using System.Windows.Forms;
using System.Drawing.Printing;
namespace Netron.Diagramming.Core
{
    // ----------------------------------------------------------------------
    /// <summary>
    /// The interface of the "View" in the Model - View - Controller 
    /// framework.  The drawing of the diagram is handled by the View.
    /// </summary>
    // ----------------------------------------------------------------------
    public interface IView
    {
        #region Events
        /// <summary>
        /// Occurs when the cursor is changed and the surface is supposed to set the cursor accordingly.
        /// </summary>
        event EventHandler<CursorEventArgs> OnCursorChange;

        event EventHandler<ColorEventArgs> OnBackColorChange;
        #endregion

        #region Properties

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets if the grid is to be drawn.
        /// </summary>
        // ------------------------------------------------------------------
        bool ShowGrid
        {
            get;
            set;
        }

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets if all shape's connectors should be shown.
        /// </summary>
        // ------------------------------------------------------------------
        bool ShowConnectors
        {
            get;
            set;
        }

        Rectangle HorizontalRulerBounds { get;}
        Rectangle VerticalRulerBounds { get;}
        MeasurementsUnit RulerUnits { get;}
        /// <summary>
        /// Get the transformation matrix of the view
        /// </summary>
        Matrix ViewMatrix { get;}

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets the current cursor.
        /// </summary>
        /// <value>The current cursor.</value>
        // ------------------------------------------------------------------
        Cursor CurrentCursor { get; set;}

        /// <summary>
        /// Gets the ghost.
        /// </summary>
        /// <value>The ghost.</value>
        IGhost Ghost { get;}

        /// <summary>
        /// Gets the ants.
        /// </summary>
        /// <value>The ants.</value>
        IAnts Ants
        {
            get;
        }

        /// <summary>
        /// Gets or sets the model.
        /// </summary>
        /// <value>The model.</value>
        IModel Model { get; set; }

        /// <summary>
        /// Gets or sets the tracker.
        /// </summary>
        /// <value>The tracker.</value>
        ITracker Tracker { get; set;}

        /// <summary>
        /// Scales the diagram.
        /// </summary>
        /// <value>The scale.</value>
        SizeF Magnification { get; set;}

        /// <summary>
        /// Pans the view with the given shift.
        /// </summary>
        /// <value>The pan.</value>
        Point Origin {get;set;}

        /// <summary>
        /// Gets or sets whether the rulers are visible.
        /// </summary>
        bool ShowRulers { get;set;}

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets if the page's title is drawn when 'ShowPage' is set
        /// to true.
        /// </summary>
        // ------------------------------------------------------------------
        bool ShowPageTitle
        {
            get;
            set;
        }

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets the size of the page in thousandths of an inch.
        /// </summary>
        // ------------------------------------------------------------------
        Size PageSize
        {
            get;
            set;
        }

        // ------------------------------------------------------------------
        /// <summary>
        /// Gets or sets if each page is rendered and printed in landscape
        /// orientation.
        /// </summary>
        // ------------------------------------------------------------------
        bool Landscape
        {
            get;
            set;
        }

        /// <summary>
        /// Gets the graphics object of the surface.
        /// </summary>
        /// <value>The graphics.</value>
        Graphics Graphics
        {
            get;
        }

        #endregion

        #region Methods

        #region View to device
        Point ViewToDevice(PointF point);
        Size ViewToDevice(SizeF szView);
        PointF ViewToDeviceF(PointF ptView);
        Rectangle ViewToDevice(RectangleF rcView);
        void ViewToDevice(PointF[] viewPts, out Point[] devicePts);
        SizeF ViewToDeviceF(SizeF szView);
        RectangleF ViewToDeviceF(RectangleF rcView);
        #endregion

        #region World to view
        PointF WorldToView(PointF ptWorld);
        RectangleF WorldToView(RectangleF rectangle);
        void WorldToView(PointF[] worldPts, out PointF[] viewPts);
        SizeF WorldToView(SizeF szWorld);
        #endregion

        #region Device to view
        PointF DeviceToView(Point ptDevice);
        void DeviceToView(Point[] devicePts, out PointF[] viewPts);
        RectangleF DeviceToView(Rectangle rcDevice);
        SizeF DeviceToView(Size szDevice);
        #endregion

        #region View to world
        PointF ViewToWorld(PointF ptView);
        RectangleF ViewToWorld(RectangleF rcView);
        Rectangle ViewToWorld(Rectangle rcView);
        SizeF ViewToWorld(SizeF szView);
        void ViewToWorld(PointF[] viewPts, out PointF[] worldPts);
        #endregion

        // ------------------------------------------------------------------
        /// <summary>
        /// Sets the magnification and origin of the diagram such that
        /// all entities in the current page are in view.
        /// </summary>
        // ------------------------------------------------------------------
        void ZoomFit();

        // ------------------------------------------------------------------
        /// <summary>
        /// Zooms the diagram control to the area specified.
        /// </summary>
        /// <param name="area">Rectangle: The area to zoom.</param>
        // ------------------------------------------------------------------
        void ZoomArea(Rectangle area);

        // ------------------------------------------------------------------
        /// <summary>
        /// Invalidates this instance.
        /// </summary>
        // ------------------------------------------------------------------
        void Invalidate();

        // ------------------------------------------------------------------
        /// <summary>
        /// Invalidates the specified rectangle.
        /// </summary>
        /// <param name="rectangle">The rectangle.</param>
        // ------------------------------------------------------------------
        void Invalidate(System.Drawing.Rectangle rectangle);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the specified g.
        /// </summary>
        /// <param name="g">The g.</param>
        // ------------------------------------------------------------------
        void Paint(System.Drawing.Graphics g);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the background.
        /// </summary>
        /// <param name="g">The g.</param>
        // ------------------------------------------------------------------
        void PaintBackground(System.Drawing.Graphics g);

        // ------------------------------------------------------------------
        /// <summary>
        /// Sets the type of the background.
        /// </summary>
        /// <param name="type">The type.</param>
        // ------------------------------------------------------------------
        void SetBackgroundType(CanvasBackgroundTypes type);

        // ------------------------------------------------------------------
        /// <summary>
        /// Resets the ghost.
        /// </summary>
        // ------------------------------------------------------------------
        void ResetGhost();

        // ------------------------------------------------------------------
        /// <summary>
        /// Resets the ants.
        /// </summary>
        // ------------------------------------------------------------------
        void ResetAnts();

        // ------------------------------------------------------------------
        /// <summary>
        /// Resets the tracker.  The tracker is the selection frame drawn
        /// around selected entities and allows then to be moved and/or
        /// resized.
        /// </summary>
        // ------------------------------------------------------------------
        void ResetTracker();

        // ------------------------------------------------------------------
        /// <summary>
        /// Hides the tracker.  The tracker is the selection frame drawn
        /// around selected entities and allows then to be moved and/or
        /// resized.
        /// </summary>
        // ------------------------------------------------------------------
        void HideTracker();

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the ghost rectangle.
        /// </summary>
        /// <param name="start">The start.</param>
        /// <param name="end">The end.</param>
        // ------------------------------------------------------------------
        void PaintGhostRectangle(Point start, Point end);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints a ghost line.
        /// </summary>
        /// <param name="start">The start.</param>
        /// <param name="end">The end.</param>
        // ------------------------------------------------------------------
        void PaintGhostLine(Point start, Point end);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints a ghost multi-line
        /// </summary>
        /// <param name="cureveType">Type of the cureve.</param>
        /// <param name="points">The points.</param>
        // ------------------------------------------------------------------
        void PaintGhostLine(MultiPointType cureveType, Point[] points);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the ghost ellipse.
        /// </summary>
        /// <param name="start">The start.</param>
        /// <param name="end">The end.</param>
        // ------------------------------------------------------------------
        void PaintGhostEllipse(Point start, Point end);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the ants rectangle.
        /// </summary>
        /// <param name="ltPoint">The lt point.</param>
        /// <param name="rbPoint">The rb point.</param>
        // ------------------------------------------------------------------
        void PaintAntsRectangle(Point ltPoint, Point rbPoint);

        // ------------------------------------------------------------------
        /// <summary>
        /// Paints the tracker.
        /// </summary>
        /// <param name="rectangle">The rectangle.</param>
        /// <param name="showHandles">if set to <c>true</c> shows the 
        /// handles.</param>
        // ------------------------------------------------------------------
        void PaintTracker(Rectangle rectangle, bool showHandles);

        // ------------------------------------------------------------------
        /// <summary>
        /// Attaches to model.
        /// </summary>
        /// <param name="model">The model.</param>
        // ------------------------------------------------------------------
        void AttachToModel(IModel model);

        // ------------------------------------------------------------------
        /// <summary>
        /// Shows the tracker.
        /// </summary>
        // ------------------------------------------------------------------
        void ShowTracker();

        // ------------------------------------------------------------------
        /// <summary>
        /// Suspends the invalidation of the view, which means that the 
        /// Invalidate() method calls from any entity will be discarded until 
        /// Resume() has been called.
        /// </summary>
        // ------------------------------------------------------------------
        void Suspend();

        // ------------------------------------------------------------------
        /// <summary>
        /// Resumes the invalidation of the view.
        /// </summary>
        // ------------------------------------------------------------------
        void Resume();

        #endregion

    }
}