///*************************************************************************/
///*
///* 文件名    ：IToolbarRegister.cs                                
///* 程序说明  : 主窗体工具条按钮注册接口
///* 原创作者  ：孙中吕 
///* 
///* Copyright 2006-2021 C/S框架网 www.csframework.com
///*
///**************************************************************************/

using System;
using System.Collections;
using System.Collections.Generic;
using System.Drawing;

namespace CSFrameworkV5.Core
{
    /// <summary>
    /// 动态生成的工具栏按钮分组
    /// </summary>
    public enum ToolBarGroup
    {
        帮助关于 = 0, //【关于程序】【系统帮助】
        窗体皮肤 = 1, //【窗体列表】【设置皮肤】
        语言常用 = 2, //【设为常用】【设置语言】
        关闭窗体 = 3, //【关闭按钮】
        导航功能 = 4, //【最前】【最后】
        导航功能1 = 5, //【上条】【下条】
        数据操作 = 6, //【增】【删】【改】【查】【保存】【取消】
        打印功能 = 7,
        审核功能 = 8, //【审核】【反审】
        扩展功能1 = 9,
        扩展功能2 = 10,
        扩展功能3 = 11,
        扩展功能4 = 12,
        扩展功能5 = 13,
        扩展功能6 = 14,
        扩展功能7 = 15,
        扩展功能8 = 16,
        扩展功能9 = 17
    }

    /// <summary>
    /// 主窗体工具条按钮注册接口
    /// </summary>
    public interface IToolbarRegister : IDisposable
    {
        /// <summary>
        /// 注册按钮
        /// </summary>
        /// <param name="buttons">按钮列表</param>
        void RegisteButton(IList buttons);

        /// <summary>
        /// 创建按钮分隔条
        /// </summary>
        /// <returns></returns>
        IButtonInfo CreateSeperator();

        /// <summary>
        /// 创建主窗体工具条的按钮.
        /// </summary>
        /// <param name="name">按钮名称:如btnSave,btnClose</param>
        /// <param name="caption">按钮名称</param>
        /// <param name="group">按钮分组</param>
        /// <param name="image">按钮图片</param>
        /// <param name="size">按钮大小</param>
        /// <param name="beginGroup">分组首个按钮</param>
        /// <param name="isLargeButton">True:大按钮, Flase:小按钮</param>
        /// <param name="clickEvent">按钮的Click事件</param>
        /// <returns></returns>
        IButtonInfo CreateButton(string name, string caption,
            ToolBarGroup group, Bitmap image, Size size,
            bool beginGroup, bool isLargeButton, OnButtonClick clickEvent);

        /// <summary>
        /// 创建主窗体工具条的按钮.
        /// </summary>
        /// <param name="name">按钮名称:如btnSave,btnClose</param>
        /// <param name="caption">按钮名称</param>
        /// <param name="group">按钮分组</param>
        /// <param name="image">按钮图片</param>
        /// <param name="size">按钮大小</param>
        /// <param name="beginGroup">分组首个按钮</param>
        /// <param name="isLargeButton">True:大按钮, Flase:小按钮</param>
        /// <param name="clickEvent">按钮的Click事件</param>
        /// <param name="subItems">按钮列表</param>
        /// <returns></returns>
        IButtonInfo CreateListButton(string name, string caption,
            ToolBarGroup group, Bitmap image, Size size,
            bool beginGroup, bool isLargeButton, OnButtonClick clickEvent,
            List<IButtonInfo> subItems);
    }
}