Winforms SkinFramework

// This file is part of CoderLine SkinFramework.
//
// CoderLine SkinFramework is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// CoderLine SkinFramework 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 General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with CoderLine SkinFramework.  If not, see <http://www.gnu.org/licenses/>.
//
// (C) 2010 Daniel Kuschny, (http://www.coderline.net)


/*
 * The usage of wrappers which contain all needed painting information,
 * prevents the access to internal used classes and properties.
 */
using System.Drawing;
using SkinFramework.Win32;

namespace SkinFramework.Painting
{
    /// <summary>
    /// The base class for painting definitions.
    /// </summary>
    public class PaintDataBase
    {
        /// <summary>
        /// Gets or sets the bounds to draw into.
        /// </summary>
        /// <value>The bounds to draw into.</value>
        public Rectangle Bounds { get; private set; }

        /// <summary>
        /// Gets or sets the graphics to draw into.
        /// </summary>
        /// <value>The graphics to draw into.</value>
        public Graphics Graphics { get; private set; }

        /// <summary>
        /// Initializes a new instance of the <see cref="PaintDataBase"/> class.
        /// </summary>
        /// <param name="g">The graphics.</param>
        /// <param name="bounds">The bounds.</param>
        public PaintDataBase(Graphics g, Rectangle bounds)
        {
            Graphics = g;
            Bounds = bounds;
        }
    }

    /// <summary>
    /// Contains the paint data for caption buttons
    /// </summary>
    public class CaptionButtonPaintData : PaintDataBase
    {
        /// <summary>
        /// Gets or sets a value indicating whether the button is pressed.
        /// </summary>
        /// <value><c>true</c> if pressed; otherwise, <c>false</c>.</value>
        public bool Pressed { get; set; }
        
        /// <summary>
        /// Gets or sets a value indicating whether the button is hovered.
        /// </summary>
        /// <value><c>true</c> if hovered; otherwise, <c>false</c>.</value>
        public bool Hovered { get; set; }
        
        /// <summary>
        /// Gets or sets a value indicating whether the button is enabled.
        /// </summary>
        /// <value><c>true</c> if enabled; otherwise, <c>false</c>.</value>
        public bool Enabled { get; set; }

        /// <summary>
        /// Gets or sets the hit test result of the button to determine the button icon.
        /// </summary>
        /// <value>The hit test result.</value>
        public HitTest HitTest { get; set; }


        /// <summary>
        /// Initializes a new instance of the <see cref="CaptionButtonPaintData"/> class.
        /// </summary>
        /// <param name="g">The graphics.</param>
        /// <param name="bounds">The bounds.</param>
        public CaptionButtonPaintData(Graphics g, Rectangle bounds)
            : base(g, bounds)
        {
        }
    }

    /// <summary>
    /// Contains the paint data for the non client area of the skinned form. 
    /// </summary>
    public class SkinningFormPaintData : PaintDataBase
    {
        /// <summary>
        /// Gets or sets the list of painting definitions for caption buttons.
        /// </summary>
        /// <value>The caption button paint definitions.</value>
        public CaptionButtonPaintData[] CaptionButtons { get; set; }

        /// <summary>
        /// Gets or sets the form border size.
        /// </summary>
        /// <value>The form border size.</value>
        public Size Borders { get; set; }

        /// <summary>
        /// Gets or sets the size of the icon.
        /// </summary>
        /// <value>The size of the icon.</value>
        public Size IconSize { get; set; }

        /// <summary>
        /// Gets or sets the height of the caption.
        /// </summary>
        /// <value>The height of the caption.</value>
        public int CaptionHeight { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the form is active.
        /// </summary>
        /// <value><c>true</c> if active; otherwise, <c>false</c>.</value>
        public bool Active { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the form has a system menu.
        /// </summary>
        /// <value><c>true</c> if this instance has menu; otherwise, <c>false</c>.</value>
        public bool HasMenu { get; set; }

        /// <summary>
        /// Gets or sets a value indicating whether the form as a small caption. (ToolWindows)
        /// </summary>
        /// <value>
        /// 	<c>true</c> if this instance is small caption; otherwise, <c>false</c>.
        /// </value>
        public bool IsSmallCaption { get; set; }

        /// <summary>
        /// Gets or sets the caption text.
        /// </summary>
        /// <value>The caption text.</value>
        public string Text { get; set; }


        /// <summary>
        /// Initializes a new instance of the <see cref="SkinningFormPaintData"/> class.
        /// </summary>
        /// <param name="g">The graphics.</param>
        /// <param name="bounds">The bounds.</param>
        public SkinningFormPaintData(Graphics g, Rectangle bounds)
            : base(g, bounds)
        {
        }
    }
}