SunnyUI/SunnyUI/Controls/UIImageListBox.cs

907 lines
29 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/******************************************************************************
* SunnyUI 开源控件库、工具类库、扩展类库、多页面开发框架。
* CopyRight (C) 2012-2023 ShenYongHua(沈永华).
* QQ群56829229 QQ17612584 EMailSunnyUI@QQ.Com
*
* Blog: https://www.cnblogs.com/yhuse
* Gitee: https://gitee.com/yhuse/SunnyUI
* GitHub: https://github.com/yhuse/SunnyUI
*
* SunnyUI.dll can be used for free under the GPL-3.0 license.
* If you use this code, please keep this note.
* 如果您使用此代码,请保留此说明。
******************************************************************************
* 文件名称: UIImageListBox.cs
* 文件说明: 图片列表框
* 当前版本: V3.1
* 创建日期: 2020-01-01
*
* 2020-01-01: V2.2.0 增加文件说明
* 2020-04-25: V2.2.4 更新主题配置类
* 2020-05-21: V2.2.5 增加鼠标滑过高亮
* 2021-08-07: V3.0.5 从文件载入图片,并且解除占用
* 2022-03-19: V3.1.1 重构主题配色
* 2022-08-30: V3.2.3 增加了一些事件
* 2022-09-05: V3.2.3 修复ClickDoubleClick事件
* 2022-11-03: V3.2.6 增加了可设置垂直滚动条宽度的属性
* 2023-05-13: V3.3.6 重构DrawString函数
******************************************************************************/
using System;
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Design;
using System.Drawing.Drawing2D;
using System.IO;
using System.Windows.Forms;
namespace Sunny.UI
{
[DefaultEvent("ItemClick")]
public sealed partial class UIImageListBox : UIPanel, IToolTip
{
private readonly ImageListBox listbox = new ImageListBox();
private readonly UIScrollBar bar = new UIScrollBar();
public UIImageListBox()
{
SetStyleFlags(true, false);
ShowText = false;
Padding = new Padding(2);
bar.ValueChanged += Bar_ValueChanged;
bar.Width = SystemInformation.VerticalScrollBarWidth + 2;
bar.Parent = this;
bar.Dock = DockStyle.None;
bar.Style = UIStyle.Custom;
bar.Visible = false;
listbox.Parent = this;
listbox.Dock = DockStyle.Fill;
listbox.Show();
listbox.Bar = bar;
listbox.SelectedIndexChanged += Listbox_SelectedIndexChanged;
listbox.SelectedValueChanged += Listbox_SelectedValueChanged;
listbox.Click += Listbox_Click;
listbox.DoubleClick += Listbox_DoubleClick;
listbox.BeforeDrawItem += Listbox_BeforeDrawItem;
listbox.MouseDown += Listbox_MouseDown;
listbox.MouseUp += Listbox_MouseUp;
listbox.MouseMove += Listbox_MouseMove;
listbox.MouseClick += Listbox_MouseClick;
listbox.MouseDoubleClick += Listbox_MouseDoubleClick;
listbox.KeyPress += Listbox_KeyPress;
listbox.KeyDown += Listbox_KeyDown;
listbox.KeyUp += Listbox_KeyUp;
listbox.MouseEnter += Listbox_MouseEnter;
listbox.MouseLeave += Listbox_MouseLeave;
listbox.DrawItem += Listbox_DrawItem;
}
protected override void Dispose(bool disposing)
{
base.Dispose(disposing);
bar?.Dispose();
listbox?.Dispose();
}
private int scrollBarWidth = 0;
[DefaultValue(0), Category("SunnyUI"), Description("垂直滚动条宽度,最小为原生滚动条宽度")]
public int ScrollBarWidth
{
get => scrollBarWidth;
set
{
scrollBarWidth = value;
SetScrollInfo();
}
}
private int scrollBarHandleWidth = 6;
[DefaultValue(6), Category("SunnyUI"), Description("垂直滚动条滑块宽度,最小为原生滚动条宽度")]
public int ScrollBarHandleWidth
{
get => scrollBarHandleWidth;
set
{
scrollBarHandleWidth = value;
if (bar != null) bar.FillWidth = value;
}
}
public event DrawItemEventHandler DrawItem;
public new event EventHandler MouseLeave;
public new event EventHandler MouseEnter;
public new event KeyPressEventHandler KeyPress;
public new event KeyEventHandler KeyDown;
public new event KeyEventHandler KeyUp;
public new event MouseEventHandler MouseClick;
public new event MouseEventHandler MouseDoubleClick;
protected override void OnContextMenuStripChanged(EventArgs e)
{
base.OnContextMenuStripChanged(e);
if (listbox != null) listbox.ContextMenuStrip = ContextMenuStrip;
}
private void Listbox_MouseDoubleClick(object sender, MouseEventArgs e)
{
MouseDoubleClick?.Invoke(this, e);
}
private void Listbox_DrawItem(object sender, DrawItemEventArgs e)
{
DrawItem?.Invoke(sender, e);
}
private void Listbox_MouseLeave(object sender, EventArgs e)
{
MouseLeave?.Invoke(this, e);
}
private void Listbox_MouseEnter(object sender, EventArgs e)
{
MouseEnter?.Invoke(this, e);
}
private void Listbox_MouseClick(object sender, MouseEventArgs e)
{
MouseClick?.Invoke(this, e);
}
private void Listbox_KeyUp(object sender, KeyEventArgs e)
{
KeyUp?.Invoke(this, e);
}
private void Listbox_KeyDown(object sender, KeyEventArgs e)
{
KeyDown?.Invoke(this, e);
}
private void Listbox_KeyPress(object sender, KeyPressEventArgs e)
{
KeyPress?.Invoke(this, e);
}
/// <summary>
/// 需要额外设置ToolTip的控件
/// </summary>
/// <returns>控件</returns>
public Control ExToolTipControl()
{
return listbox;
}
public int IndexFromPoint(Point p)
{
return listbox.IndexFromPoint(p);
}
public int IndexFromPoint(int x, int y)
{
return listbox.IndexFromPoint(x, y);
}
protected override void AfterSetFillColor(Color color)
{
base.AfterSetFillColor(color);
if (listbox != null)
{
listbox.BackColor = color;
}
}
private void Listbox_MouseMove(object sender, MouseEventArgs e)
{
MouseMove?.Invoke(this, e);
}
private void Listbox_MouseUp(object sender, MouseEventArgs e)
{
MouseUp?.Invoke(this, e);
}
private void Listbox_MouseDown(object sender, MouseEventArgs e)
{
MouseDown?.Invoke(this, e);
}
public new event MouseEventHandler MouseDown;
public new event MouseEventHandler MouseUp;
public new event MouseEventHandler MouseMove;
/// <summary>
/// 重载字体变更
/// </summary>
/// <param name="e">参数</param>
protected override void OnFontChanged(EventArgs e)
{
base.OnFontChanged(e);
if (DefaultFontSize < 0 && listbox != null) listbox.Font = this.Font;
}
/// <summary>
/// 重载控件尺寸变更
/// </summary>
/// <param name="e">参数</param>
protected override void OnSizeChanged(EventArgs e)
{
base.OnSizeChanged(e);
SetScrollInfo();
}
private void SetScrollInfo()
{
bar.Top = 2;
bar.Height = Height - 4;
int barWidth = Math.Max(ScrollBarInfo.VerticalScrollBarWidth(), ScrollBarWidth);
bar.Width = barWidth + 1;
bar.Left = Width - barWidth - 2;
}
private void Listbox_BeforeDrawItem(object sender, ListBox.ObjectCollection items, DrawItemEventArgs e)
{
if (Items.Count != LastCount)
{
listbox.SetScrollInfo();
LastCount = Items.Count;
ItemsCountChange?.Invoke(this, EventArgs.Empty);
}
}
private void Listbox_DoubleClick(object sender, EventArgs e)
{
DoubleClick?.Invoke(this, e);
}
private void Listbox_Click(object sender, EventArgs e)
{
Click?.Invoke(this, e);
}
[Browsable(false)]
public int Count => Items.Count;
public new event EventHandler Click;
public new event EventHandler DoubleClick;
public event EventHandler ItemsCountChange;
public event EventHandler SelectedIndexChanged;
public event EventHandler SelectedValueChanged;
private void Listbox_SelectedValueChanged(object sender, EventArgs e)
{
SelectedValueChanged?.Invoke(this, e);
Text = listbox.SelectedItem?.ToString();
}
private void Listbox_SelectedIndexChanged(object sender, EventArgs e)
{
SelectedIndexChanged?.Invoke(this, e);
}
[DefaultValue(100)]
[Description("列表项高度"), Category("SunnyUI")]
public int ItemHeight
{
get => listbox.ItemHeight;
set => listbox.ItemHeight = value;
}
[DefaultValue(4)]
[Description("图片文字间间隔"), Category("SunnyUI")]
public int ImageInterval
{
get => listbox.ImageInterval;
set => listbox.ImageInterval = value;
}
[DefaultValue(true)]
[Description("显示说明文字"), Category("SunnyUI")]
public bool ShowDescription
{
get => listbox.ShowDescription;
set => listbox.ShowDescription = value;
}
/// <summary>
/// 设置主题样式
/// </summary>
/// <param name="uiColor">主题样式</param>
public override void SetStyleColor(UIBaseStyle uiColor)
{
base.SetStyleColor(uiColor);
if (bar != null)
{
bar.ForeColor = uiColor.ListBarForeColor;
bar.HoverColor = uiColor.ButtonFillHoverColor;
bar.PressColor = uiColor.ButtonFillPressColor;
bar.FillColor = uiColor.ListBarFillColor;
}
hoverColor = uiColor.ListItemHoverColor;
if (listbox != null)
{
listbox.HoverColor = hoverColor;
listbox.SetStyleColor(uiColor);
listbox.BackColor = uiColor.ListBackColor;
listbox.ForeColor = uiColor.ListForeColor;
}
fillColor = uiColor.ListBackColor;
}
private int LastCount;
private int lastBarValue = -1;
private void Bar_ValueChanged(object sender, EventArgs e)
{
if (listbox != null)
{
if (bar.Value != lastBarValue)
{
ScrollBarInfo.SetScrollValue(listbox.Handle, bar.Value);
lastBarValue = bar.Value;
}
}
}
protected override void OnRadiusChanged(int value)
{
base.OnRadiusChanged(value);
Padding = new Padding(Math.Max(2, value / 2));
}
[DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
[Localizable(true)]
[Editor("System.Windows.Forms.Design.ListControlStringCollectionEditor, System.Design, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", typeof(UITypeEditor))]
[MergableProperty(false)]
[Browsable(false)]
[Description("列表项"), Category("SunnyUI")]
public ListBox.ObjectCollection Items => listbox.Items;
/// <summary>
/// 增加图片
/// </summary>
/// <param name="record">图片对象</param>
public void AddImage(ImageListItem record)
{
Items.Add(record);
}
/// <summary>
/// 增加图片
/// </summary>
/// <param name="imagePath">图片路径</param>
/// <param name="description">图片描述</param>
public void AddImage(string imagePath, string description = "")
{
AddImage(new ImageListItem(imagePath, description));
}
/// <summary>
/// 增加图片
/// </summary>
/// <param name="image">图片</param>
/// <param name="description">图片描述</param>
public void AddImage(Bitmap image, string description = "")
{
AddImage(new ImageListItem(image, description));
}
public void SelectedFirst()
{
listbox.SelectedFirst();
}
[DefaultValue(typeof(Color), "80, 160, 255")]
[Description("选中项背景颜色"), Category("SunnyUI")]
public Color ItemSelectBackColor
{
get => listbox.ItemSelectBackColor;
set => listbox.ItemSelectBackColor = value;
}
[DefaultValue(typeof(Color), "243, 249, 255")]
[Description("选中项字体颜色"), Category("SunnyUI")]
public Color ItemSelectForeColor
{
get => listbox.ItemSelectForeColor;
set => listbox.ItemSelectForeColor = value;
}
[Browsable(false)]
[DefaultValue(-1)]
public int SelectedIndex
{
get => listbox.SelectedIndex;
set => listbox.SelectedIndex = value;
}
[Browsable(false)]
[DefaultValue(null)]
public ImageListItem SelectedItem
{
get => listbox.SelectedItem as ImageListItem;
set => listbox.SelectedItem = value;
}
[Browsable(false)]
[DefaultValue(null)]
public object SelectedValue
{
get => listbox.SelectedValue;
set => listbox.SelectedValue = value;
}
private Color hoverColor = Color.FromArgb(155, 200, 255);
[DefaultValue(typeof(Color), "220, 236, 255")]
[Description("鼠标移上颜色"), Category("SunnyUI")]
public Color HoverColor
{
get => hoverColor;
set
{
hoverColor = value;
listbox.HoverColor = hoverColor;
_style = UIStyle.Custom;
}
}
[ToolboxItem(false)]
private sealed class ImageListBox : ListBox, IStyleInterface
{
private UIScrollBar bar;
/// <summary>
/// Tag字符串
/// </summary>
[DefaultValue(null)]
[Description("获取或设置包含有关控件的数据的对象字符串"), Category("SunnyUI")]
public string TagString { get; set; }
public UIScrollBar Bar
{
get => bar;
set
{
bar = value;
SetScrollInfo();
}
}
private float DefaultFontSize = -1;
public void SetDPIScale()
{
if (!UIDPIScale.NeedSetDPIFont()) return;
if (DefaultFontSize < 0) DefaultFontSize = this.Font.Size;
this.SetDPIScaleFont(DefaultFontSize);
}
//protected override void WndProc(ref Message m)
//{
// if (IsDisposed || Disposing) return;
// if (IsHandleCreated)
// {
// if (m.Msg == Win32.User.WM_ERASEBKGND)
// {
// m.Result = IntPtr.Zero;
// return;
// }
// }
//
// base.WndProc(ref m);
//}
public ImageListBox()
{
SetStyle(ControlStyles.AllPaintingInWmPaint, true);
SetStyle(ControlStyles.DoubleBuffer, true);
UpdateStyles();
BorderStyle = BorderStyle.None;
ForeColor = UIFontColor.Primary;
IntegralHeight = false;
ItemHeight = 100;
DrawMode = DrawMode.OwnerDrawFixed;
Version = UIGlobal.Version;
SetScrollInfo();
}
/// <summary>
/// 重载控件尺寸变更
/// </summary>
/// <param name="e">参数</param>
protected override void OnSizeChanged(EventArgs e)
{
if (Bar != null && Bar.Visible)
{
if (Bar.Value != 0)
{
ScrollBarInfo.SetScrollValue(Handle, Bar.Value);
}
}
//SetScrollInfo();
}
public void SetScrollInfo()
{
if (Bar == null)
{
return;
}
var si = ScrollBarInfo.GetInfo(Handle);
if (si.ScrollMax > 0)
{
Bar.Maximum = si.ScrollMax;
Bar.Visible = si.ScrollMax > 0 && si.nMax > 0 && si.nPage > 0;
Bar.Value = si.nPos;
}
else
{
Bar.Visible = false;
}
}
protected override void OnMeasureItem(MeasureItemEventArgs e)
{
e.ItemHeight += ItemHeight;
}
/// <summary>
/// 自定义主题风格
/// </summary>
[DefaultValue(false)]
[Description("获取或设置可以自定义主题风格"), Category("SunnyUI")]
public bool StyleCustomMode { get; set; }
public string Version { get; }
private UIStyle _style = UIStyle.Blue;
private Color _itemSelectBackColor = UIColor.Blue;
private Color _itemSelectForeColor = Color.White;
private int imageInterval = 4;
private bool showDescription = true;
[Browsable(false)]
public int Count => Items.Count;
public void SelectedFirst()
{
if (Count > 0 && SelectedIndex < 0)
{
SelectedIndex = 0;
}
}
protected override void OnMouseWheel(MouseEventArgs e)
{
base.OnMouseWheel(e);
if (Bar != null && Bar.Visible)
{
var si = ScrollBarInfo.GetInfo(Handle);
int temp = Math.Abs(e.Delta / 120);
if (e.Delta > 10)
{
int nposnum = si.nPos - temp * SystemInformation.MouseWheelScrollLines;
ScrollBarInfo.SetScrollValue(Handle, nposnum >= si.nMin ? nposnum : 0);
}
else if (e.Delta < -10)
{
int nposnum = si.nPos + temp * SystemInformation.MouseWheelScrollLines;
ScrollBarInfo.SetScrollValue(Handle, nposnum <= si.ScrollMax ? nposnum : si.ScrollMax);
}
}
SetScrollInfo();
}
[DefaultValue(4)]
public int ImageInterval
{
get => imageInterval;
set
{
if (imageInterval != value)
{
imageInterval = value;
Invalidate();
}
}
}
[DefaultValue(true)]
public bool ShowDescription
{
get => showDescription;
set
{
if (showDescription != value)
{
showDescription = value;
Invalidate();
}
}
}
/// <summary>
/// 主题样式
/// </summary>
[DefaultValue(UIStyle.Blue), Description("主题样式"), Category("SunnyUI")]
public UIStyle Style
{
get => _style;
set => SetStyle(value);
}
public void SetStyle(UIStyle style)
{
if (!style.IsCustom())
{
SetStyleColor(style.Colors());
Invalidate();
}
_style = style;
}
public void SetStyleColor(UIBaseStyle uiColor)
{
ItemSelectBackColor = uiColor.ListItemSelectBackColor;
ItemSelectForeColor = uiColor.ListItemSelectForeColor;
}
[Category("SunnyUI"), Description("The border color used to paint the control.")]
public Color ItemSelectBackColor
{
get => _itemSelectBackColor;
set
{
if (_itemSelectBackColor != value)
{
_itemSelectBackColor = value;
_style = UIStyle.Custom;
if (DesignMode)
Invalidate();
}
}
}
[Category("SunnyUI"), Description("The border color used to paint the control.")]
public Color ItemSelectForeColor
{
get => _itemSelectForeColor;
set
{
if (_itemSelectForeColor != value)
{
_itemSelectForeColor = value;
_style = UIStyle.Custom;
if (DesignMode)
Invalidate();
}
}
}
/// <summary>
/// 增加图片
/// </summary>
/// <param name="record">图片对象</param>
public void AddImage(ImageListItem record)
{
Items.Add(record);
}
/// <summary>
/// 增加图片
/// </summary>
/// <param name="imagePath">图片路径</param>
/// <param name="description">图片描述</param>
public void AddImage(string imagePath, string description = "")
{
AddImage(new ImageListItem(imagePath, description));
}
public void AddImage(Bitmap image, string description = "")
{
AddImage(new ImageListItem(image, description));
}
public delegate void OnBeforeDrawItem(object sender, ObjectCollection items, DrawItemEventArgs e);
public event OnBeforeDrawItem BeforeDrawItem;
protected override void OnDrawItem(DrawItemEventArgs e)
{
base.OnDrawItem(e);
BeforeDrawItem?.Invoke(this, Items, e);
if (Items.Count == 0)
{
return;
}
bool otherState = e.State == DrawItemState.Grayed || e.State == DrawItemState.HotLight;
if (!otherState)
{
e.DrawBackground();
}
if (e.Index < 0 || e.Index >= Items.Count)
{
return;
}
bool isSelected = (e.State & DrawItemState.Selected) == DrawItemState.Selected;
Color backColor = isSelected ? ItemSelectBackColor : BackColor;
Color foreColor = isSelected ? ItemSelectForeColor : ForeColor;
Rectangle rect = new Rectangle(e.Bounds.X, e.Bounds.Y, e.Bounds.Width - 1, e.Bounds.Height - 1);
if (!otherState)
{
e.Graphics.FillRectangle(BackColor, e.Bounds);
e.Graphics.FillRectangle(backColor, rect);
}
else
{
if (e.State == DrawItemState.Grayed)
{
backColor = BackColor;
foreColor = ForeColor;
}
if (e.State == DrawItemState.HotLight)
{
backColor = HoverColor;
foreColor = ForeColor;
}
e.Graphics.FillRectangle(BackColor, e.Bounds);
e.Graphics.FillRectangle(backColor, rect);
}
Graphics g = e.Graphics;
Matrix oldTransform = g.Transform;
Matrix newTransform = oldTransform.Clone();
newTransform.Translate(e.Bounds.X, e.Bounds.Y);
g.Transform = newTransform;
ImageListItem item = (ImageListItem)Items[e.Index];
Size sf = TextRenderer.MeasureText("ImageListBox", Font);
int thumbnailSize = ShowDescription ? ((int)(ItemHeight - ImageInterval - sf.Height)) : (ItemHeight - ImageInterval * 2);
if (item.Image != null)
{
if (item.Image.Width <= thumbnailSize && item.Image.Height <= thumbnailSize)
{
g.DrawImage(item.Image, new Rectangle(ImageInterval, ImageInterval, item.Image.Width, item.Image.Height));
}
else
{
float scale = thumbnailSize * 1.0f / item.Image.Height;
g.DrawImage(item.Image, new Rectangle(ImageInterval, ImageInterval, (int)(item.Image.Width * scale), (int)(item.Image.Height * scale)));
}
}
if (ShowDescription && !string.IsNullOrEmpty(item.Description))
{
g.DrawString(item.Description, e.Font, foreColor, new Rectangle(ImageInterval, e.Bounds.Y + thumbnailSize, e.Bounds.Width, e.Bounds.Height), ContentAlignment.TopLeft);
}
g.Transform = oldTransform;
}
private Color hoverColor = Color.FromArgb(155, 200, 255);
[DefaultValue(typeof(Color), "155, 200, 255")]
public Color HoverColor
{
get => hoverColor;
set
{
hoverColor = value;
_style = UIStyle.Custom;
}
}
private int lastIndex = -1;
private int mouseIndex = -1;
[Browsable(false)]
public int MouseIndex
{
get => mouseIndex;
set
{
if (mouseIndex != value)
{
if (lastIndex >= 0 && lastIndex != SelectedIndex)
{
OnDrawItem(new DrawItemEventArgs(this.CreateGraphics(), Font, GetItemRectangle(lastIndex), lastIndex, DrawItemState.Grayed));
}
mouseIndex = value;
if (mouseIndex >= 0 && mouseIndex != SelectedIndex)
{
OnDrawItem(new DrawItemEventArgs(this.CreateGraphics(), Font, GetItemRectangle(value), value, DrawItemState.HotLight));
}
lastIndex = mouseIndex;
}
}
}
/// <summary>
/// 重载鼠标移动事件
/// </summary>
/// <param name="e">鼠标参数</param>
protected override void OnMouseMove(MouseEventArgs e)
{
base.OnMouseMove(e);
MouseIndex = IndexFromPoint(e.Location);
}
/// <summary>
/// 重载鼠标离开事件
/// </summary>
/// <param name="e">鼠标参数</param>
protected override void OnMouseLeave(EventArgs e)
{
base.OnMouseLeave(e);
MouseIndex = -1;
}
}
public class ImageListItem : IDisposable
{
public string ImagePath { get; private set; }
public string Description { get; set; }
public Image Image { get; private set; }
public ImageListItem(string imagePath, string description = "")
{
if (File.Exists(imagePath))
{
ImagePath = imagePath;
Image = ImageEx.FromFile(imagePath);
}
Description = description;
}
public ImageListItem(Bitmap image, string description = "")
{
ImagePath = "";
Image = new Bitmap(image);
Description = description;
}
public override string ToString()
{
return Description + ", " + ImagePath;
}
/// <summary>
/// 析构函数
/// </summary>
public void Dispose()
{
Image?.Dispose();
}
}
}
}