feedc0de/ObjectListView
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
ObjectListView/SubControls/HeaderControl.cs

1219 lines
49 KiB
C#
Raw Permalink Normal View History

Imported existing sources
2017-02-04 13:47:58 +01:00
/*
* HeaderControl - A limited implementation of HeaderControl
*
* Author: Phillip Piper
* Date: 25/11/2008 17:15
*
* Change log:
* 2014-09-07 JPP - Added ability to have checkboxes in headers
*
* 2011-05-11 JPP - Fixed bug that prevented columns from being resized in IDE Designer
* by dragging the column divider
* 2011-04-12 JPP - Added ability to draw filter indicator in a column's header
* v2.4.1
* 2010-08-23 JPP - Added ability to draw header vertically (thanks to Mark Fenwick)
* - Uses OLVColumn.HeaderTextAlign to decide how to align the column's header
* 2010-08-08 JPP - Added ability to have image in header
* v2.4
* 2010-03-22 JPP - Draw header using header styles
* 2009-10-30 JPP - Plugged GDI resource leak, where font handles were created during custom
* drawing, but never destroyed
* v2.3
* 2009-10-03 JPP - Handle when ListView.HeaderFormatStyle is None
* 2009-08-24 JPP - Handle the header being destroyed
* v2.2.1
* 2009-08-16 JPP - Correctly handle header themes
* 2009-08-15 JPP - Added formatting capabilities: font, color, word wrap
* v2.2
* 2009-06-01 JPP - Use ToolTipControl
* 2009-05-10 JPP - Removed all unsafe code
* 2008-11-25 JPP - Initial version
*
* TO DO:
* - Put drawing code into header style object, so that it can be easily customized.
*
* Copyright (C) 2006-2014 Phillip Piper
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* If you wish to use this code in a closed source application, please contact phillip_piper@bigfoot.com.
*/
using System;
using System.Drawing;
using System.Runtime.Remoting.Messaging;
using System.Windows.Forms;
using System.Runtime.InteropServices;
using System.Windows.Forms.VisualStyles;
using System.Drawing.Drawing2D;
using BrightIdeasSoftware.Properties;
using System.Security.Permissions;
namespace BrightIdeasSoftware {
/// <summary>
/// Class used to capture window messages for the header of the list view
/// control.
/// </summary>
public class HeaderControl : NativeWindow {
/// <summary>
/// Create a header control for the given ObjectListView.
/// </summary>
/// <param name="olv"></param>
public HeaderControl(ObjectListView olv) {
this.ListView = olv;
this.AssignHandle(NativeMethods.GetHeaderControl(olv));
}
#region Properties
/// <summary>
/// Return the index of the column under the current cursor position,
/// or -1 if the cursor is not over a column
/// </summary>
/// <returns>Index of the column under the cursor, or -1</returns>
public int ColumnIndexUnderCursor {
get {
Point pt = this.ScrolledCursorPosition;
return NativeMethods.GetColumnUnderPoint(this.Handle, pt);
}
}
/// <summary>
/// Return the Windows handle behind this control
/// </summary>
/// <remarks>
/// When an ObjectListView is initialized as part of a UserControl, the
/// GetHeaderControl() method returns 0 until the UserControl is
/// completely initialized. So the AssignHandle() call in the constructor
/// doesn't work. So we override the Handle property so value is always
/// current.
/// </remarks>
public new IntPtr Handle {
get { return NativeMethods.GetHeaderControl(this.ListView); }
}
//TODO: The Handle property may no longer be necessary. CHECK! 2008/11/28
/// <summary>
/// Gets or sets a style that should be applied to the font of the
/// column's header text when the mouse is over that column
/// </summary>
/// <remarks>THIS IS EXPERIMENTAL. USE AT OWN RISK. August 2009</remarks>
[Obsolete("Use HeaderStyle.Hot.FontStyle instead")]
public FontStyle HotFontStyle {
get { return FontStyle.Regular; }
set { }
}
/// <summary>
/// Gets the index of the column under the cursor if the cursor is over it's checkbox
/// </summary>
protected int GetColumnCheckBoxUnderCursor() {
Point pt = this.ScrolledCursorPosition;
int columnIndex = NativeMethods.GetColumnUnderPoint(this.Handle, pt);
return this.IsPointOverHeaderCheckBox(columnIndex, pt) ? columnIndex : -1;
}
/// <summary>
/// Gets the client rectangle for the header
/// </summary>
public Rectangle ClientRectangle {
get {
Rectangle r = new Rectangle();
NativeMethods.GetClientRect(this.Handle, ref r);
return r;
}
}
/// <summary>
/// Return true if the given point is over the checkbox for the given column.
/// </summary>
/// <param name="columnIndex"></param>
/// <param name="pt"></param>
/// <returns></returns>
protected bool IsPointOverHeaderCheckBox(int columnIndex, Point pt) {
if (columnIndex < 0 || columnIndex >= this.ListView.Columns.Count)
return false;
OLVColumn column = this.ListView.GetColumn(columnIndex);
if (!this.HasCheckBox(column))
return false;
Rectangle r = this.GetCheckBoxBounds(column);
r.Inflate(1, 1); // make the target slightly bigger
return r.Contains(pt);
}
/// <summary>
/// Gets whether the cursor is over a "locked" divider, i.e.
/// one that cannot be dragged by the user.
/// </summary>
protected bool IsCursorOverLockedDivider {
get {
Point pt = this.ScrolledCursorPosition;
int dividerIndex = NativeMethods.GetDividerUnderPoint(this.Handle, pt);
if (dividerIndex >= 0 && dividerIndex < this.ListView.Columns.Count) {
OLVColumn column = this.ListView.GetColumn(dividerIndex);
return column.IsFixedWidth || column.FillsFreeSpace;
} else
return false;
}
}
private Point ScrolledCursorPosition {
get {
Point pt = this.ListView.PointToClient(Cursor.Position);
pt.X += this.ListView.LowLevelScrollPosition.X;
return pt;
}
}
/// <summary>
/// Gets or sets the listview that this header belongs to
/// </summary>
protected ObjectListView ListView {
get { return this.listView; }
set { this.listView = value; }
}
private ObjectListView listView;
/// <summary>
/// Gets the maximum height of the header. -1 means no maximum.
/// </summary>
public int MaximumHeight {
get { return this.ListView.HeaderMaximumHeight; }
}
/// <summary>
/// Get or set the ToolTip that shows tips for the header
/// </summary>
public ToolTipControl ToolTip {
get {
if (this.toolTip == null) {
this.CreateToolTip();
}
return this.toolTip;
}
protected set { this.toolTip = value; }
}
private ToolTipControl toolTip;
/// <summary>
/// Gets or sets whether the text in column headers should be word
/// wrapped when it is too long to fit within the column
/// </summary>
public bool WordWrap {
get { return this.wordWrap; }
set { this.wordWrap = value; }
}
private bool wordWrap;
#endregion
#region Commands
/// <summary>
/// Calculate how height the header needs to be
/// </summary>
/// <returns>Height in pixels</returns>
protected int CalculateHeight(Graphics g) {
TextFormatFlags flags = this.TextFormatFlags;
int columnUnderCursor = this.ColumnIndexUnderCursor;
float height = 0.0f;
for (int i = 0; i < this.ListView.Columns.Count; i++) {
OLVColumn column = this.ListView.GetColumn(i);
height = Math.Max(height, CalculateColumnHeight(g, column, flags, columnUnderCursor == i, i));
}
return this.MaximumHeight == -1 ? (int) height : Math.Min(this.MaximumHeight, (int) height);
}
private float CalculateColumnHeight(Graphics g, OLVColumn column, TextFormatFlags flags, bool isHot, int i) {
Font f = this.CalculateFont(column, isHot, false);
if (column.IsHeaderVertical)
return TextRenderer.MeasureText(g, column.Text, f, new Size(10000, 10000), flags).Width;
const int fudge = 9; // 9 is a magic constant that makes it perfectly match XP behavior
if (!this.WordWrap)
return f.Height + fudge;
Rectangle r = this.GetHeaderDrawRect(i);
if (this.HasNonThemedSortIndicator(column))
r.Width -= 16;
if (column.HasHeaderImage)
r.Width -= column.ImageList.ImageSize.Width + 3;
if (this.HasFilterIndicator(column))
r.Width -= this.CalculateFilterIndicatorWidth(r);
if (this.HasCheckBox(column))
r.Width -= this.CalculateCheckBoxBounds(g, r).Width;
SizeF size = TextRenderer.MeasureText(g, column.Text, f, new Size(r.Width, 100), flags);
return size.Height + fudge;
}
/// <summary>
/// Get the bounds of the checkbox against the given column
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
public Rectangle GetCheckBoxBounds(OLVColumn column) {
Rectangle r = this.GetHeaderDrawRect(column.Index);
using (Graphics g = this.ListView.CreateGraphics())
return this.CalculateCheckBoxBounds(g, r);
}
/// <summary>
/// Should the given column be drawn with a checkbox against it?
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
public bool HasCheckBox(OLVColumn column) {
return column.HeaderCheckBox || column.HeaderTriStateCheckBox;
}
/// <summary>
/// Should the given column show a sort indicator?
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
protected bool HasSortIndicator(OLVColumn column) {
if (!this.ListView.ShowSortIndicators)
return false;
return column == this.ListView.LastSortColumn && this.ListView.LastSortOrder != SortOrder.None;
}
/// <summary>
/// Should the given column be drawn with a filter indicator against it?
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
protected bool HasFilterIndicator(OLVColumn column) {
return (this.ListView.UseFiltering && this.ListView.UseFilterIndicator && column.HasFilterIndicator);
}
/// <summary>
/// Should the given column show a non-themed sort indicator?
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
protected bool HasNonThemedSortIndicator(OLVColumn column) {
if (!this.ListView.ShowSortIndicators)
return false;
if (VisualStyleRenderer.IsSupported)
return !VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.SortArrow.SortedUp) &&
this.HasSortIndicator(column);
else
return this.HasSortIndicator(column);
}
/// <summary>
/// Return the bounds of the item with the given index
/// </summary>
/// <param name="itemIndex"></param>
/// <returns></returns>
public Rectangle GetItemRect(int itemIndex) {
const int HDM_FIRST = 0x1200;
const int HDM_GETITEMRECT = HDM_FIRST + 7;
NativeMethods.RECT r = new NativeMethods.RECT();
NativeMethods.SendMessageRECT(this.Handle, HDM_GETITEMRECT, itemIndex, ref r);
return Rectangle.FromLTRB(r.left, r.top, r.right, r.bottom);
}
/// <summary>
/// Return the bounds within which the given column will be drawn
/// </summary>
/// <param name="itemIndex"></param>
/// <returns></returns>
public Rectangle GetHeaderDrawRect(int itemIndex) {
Rectangle r = this.GetItemRect(itemIndex);
// Tweak the text rectangle a little to improve aethestics
r.Inflate(-3, 0);
r.Y -= 2;
return r;
}
/// <summary>
/// Force the header to redraw by invalidating it
/// </summary>
public void Invalidate() {
NativeMethods.InvalidateRect(this.Handle, 0, true);
}
/// <summary>
/// Force the header to redraw a single column by invalidating it
/// </summary>
public void Invalidate(OLVColumn column) {
NativeMethods.InvalidateRect(this.Handle, 0, true); // todo
}
#endregion
#region Tooltip
/// <summary>
/// Create a native tool tip control for this listview
/// </summary>
protected virtual void CreateToolTip() {
this.ToolTip = new ToolTipControl();
this.ToolTip.Create(this.Handle);
this.ToolTip.AddTool(this);
this.ToolTip.Showing += new EventHandler<ToolTipShowingEventArgs>(this.ListView.HeaderToolTipShowingCallback);
}
#endregion
#region Windows messaging
/// <summary>
/// Override the basic message pump
/// </summary>
/// <param name="m"></param>
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.UnmanagedCode)]
protected override void WndProc(ref Message m) {
const int WM_DESTROY = 2;
const int WM_SETCURSOR = 0x20;
const int WM_NOTIFY = 0x4E;
const int WM_MOUSEMOVE = 0x200;
const int WM_LBUTTONDOWN = 0x201;
const int WM_LBUTTONUP = 0x202;
const int WM_MOUSELEAVE = 675;
const int HDM_FIRST = 0x1200;
const int HDM_LAYOUT = (HDM_FIRST + 5);
// System.Diagnostics.Debug.WriteLine(String.Format("WndProc: {0}", m.Msg));
switch (m.Msg) {
case WM_SETCURSOR:
if (!this.HandleSetCursor(ref m))
return;
break;
case WM_NOTIFY:
if (!this.HandleNotify(ref m))
return;
break;
case WM_MOUSEMOVE:
if (!this.HandleMouseMove(ref m))
return;
break;
case WM_MOUSELEAVE:
if (!this.HandleMouseLeave(ref m))
return;
break;
case HDM_LAYOUT:
if (!this.HandleLayout(ref m))
return;
break;
case WM_DESTROY:
if (!this.HandleDestroy(ref m))
return;
break;
case WM_LBUTTONDOWN:
if (!this.HandleLButtonDown(ref m))
return;
break;
case WM_LBUTTONUP:
if (!this.HandleLButtonUp(ref m))
return;
break;
}
base.WndProc(ref m);
}
private bool HandleReflectNotify(ref Message m)
{
NativeMethods.NMHDR nmhdr = (NativeMethods.NMHDR)m.GetLParam(typeof(NativeMethods.NMHDR));
System.Diagnostics.Debug.WriteLine(String.Format("rn: {0}", nmhdr.code));
return true;
}
/// <summary>
/// Handle the LButtonDown windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleLButtonDown(ref Message m)
{
// Was there a header checkbox under the cursor?
this.columnIndexCheckBoxMouseDown = this.GetColumnCheckBoxUnderCursor();
if (this.columnIndexCheckBoxMouseDown < 0)
return true;
// Redraw the header so the checkbox redraws
this.Invalidate();
// Force the owning control to ignore this mouse click
// We don't want to sort the listview when they click the checkbox
m.Result = (IntPtr)1;
return false;
}
private int columnIndexCheckBoxMouseDown = -1;
/// <summary>
/// Handle the LButtonUp windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleLButtonUp(ref Message m) {
//System.Diagnostics.Debug.WriteLine("WM_LBUTTONUP");
// Was the mouse released over a header checkbox?
if (this.columnIndexCheckBoxMouseDown < 0)
return true;
// Was the mouse released over the same checkbox on which it was pressed?
if (this.columnIndexCheckBoxMouseDown != this.GetColumnCheckBoxUnderCursor())
return true;
// Toggle the header's checkbox
OLVColumn column = this.ListView.GetColumn(this.columnIndexCheckBoxMouseDown);
this.ListView.ToggleHeaderCheckBox(column);
return true;
}
/// <summary>
/// Handle the SetCursor windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleSetCursor(ref Message m) {
if (this.IsCursorOverLockedDivider) {
m.Result = (IntPtr) 1; // Don't change the cursor
return false;
}
return true;
}
/// <summary>
/// Handle the MouseMove windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleMouseMove(ref Message m) {
// Forward the mouse move event to the ListView itself
if (this.ListView.TriggerCellOverEventsWhenOverHeader) {
int x = m.LParam.ToInt32() & 0xFFFF;
int y = (m.LParam.ToInt32() >> 16) & 0xFFFF;
this.ListView.HandleMouseMove(new Point(x, y));
}
int columnIndex = this.ColumnIndexUnderCursor;
// If the mouse has moved to a different header, pop the current tip (if any)
// For some reason, references this.ToolTip when in design mode, causes the
// columns to not be resizable by dragging the divider in the Designer. No idea why.
if (columnIndex != this.columnShowingTip && !this.ListView.IsDesignMode) {
this.ToolTip.PopToolTip(this);
this.columnShowingTip = columnIndex;
}
// If the mouse has moved onto or away from a checkbox, we need to draw
int checkBoxUnderCursor = this.GetColumnCheckBoxUnderCursor();
if (checkBoxUnderCursor != this.lastCheckBoxUnderCursor) {
this.Invalidate();
this.lastCheckBoxUnderCursor = checkBoxUnderCursor;
}
return true;
}
private int columnShowingTip = -1;
private int lastCheckBoxUnderCursor = -1;
/// <summary>
/// Handle the MouseLeave windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleMouseLeave(ref Message m) {
// Forward the mouse leave event to the ListView itself
if (this.ListView.TriggerCellOverEventsWhenOverHeader)
this.ListView.HandleMouseMove(new Point(-1, -1));
return true;
}
/// <summary>
/// Handle the Notify windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleNotify(ref Message m) {
// Can this ever happen? JPP 2009-05-22
if (m.LParam == IntPtr.Zero)
return false;
NativeMethods.NMHDR nmhdr = (NativeMethods.NMHDR)m.GetLParam(typeof(NativeMethods.NMHDR));
switch (nmhdr.code)
{
case ToolTipControl.TTN_SHOW:
//System.Diagnostics.Debug.WriteLine("hdr TTN_SHOW");
//System.Diagnostics.Trace.Assert(this.ToolTip.Handle == nmhdr.hwndFrom);
return this.ToolTip.HandleShow(ref m);
case ToolTipControl.TTN_POP:
//System.Diagnostics.Debug.WriteLine("hdr TTN_POP");
//System.Diagnostics.Trace.Assert(this.ToolTip.Handle == nmhdr.hwndFrom);
return this.ToolTip.HandlePop(ref m);
case ToolTipControl.TTN_GETDISPINFO:
//System.Diagnostics.Debug.WriteLine("hdr TTN_GETDISPINFO");
//System.Diagnostics.Trace.Assert(this.ToolTip.Handle == nmhdr.hwndFrom);
return this.ToolTip.HandleGetDispInfo(ref m);
}
return false;
}
/// <summary>
/// Handle the CustomDraw windows message
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
internal virtual bool HandleHeaderCustomDraw(ref Message m) {
const int CDRF_NEWFONT = 2;
const int CDRF_SKIPDEFAULT = 4;
const int CDRF_NOTIFYPOSTPAINT = 0x10;
const int CDRF_NOTIFYITEMDRAW = 0x20;
const int CDDS_PREPAINT = 1;
const int CDDS_POSTPAINT = 2;
const int CDDS_ITEM = 0x00010000;
const int CDDS_ITEMPREPAINT = (CDDS_ITEM | CDDS_PREPAINT);
const int CDDS_ITEMPOSTPAINT = (CDDS_ITEM | CDDS_POSTPAINT);
NativeMethods.NMCUSTOMDRAW nmcustomdraw = (NativeMethods.NMCUSTOMDRAW) m.GetLParam(typeof (NativeMethods.NMCUSTOMDRAW));
//System.Diagnostics.Debug.WriteLine(String.Format("header cd: {0:x}, {1}, {2:x}", nmcustomdraw.dwDrawStage, nmcustomdraw.dwItemSpec, nmcustomdraw.uItemState));
switch (nmcustomdraw.dwDrawStage) {
case CDDS_PREPAINT:
this.cachedNeedsCustomDraw = this.NeedsCustomDraw();
m.Result = (IntPtr) CDRF_NOTIFYITEMDRAW;
return true;
case CDDS_ITEMPREPAINT:
int columnIndex = nmcustomdraw.dwItemSpec.ToInt32();
OLVColumn column = this.ListView.GetColumn(columnIndex);
// These don't work when visual styles are enabled
//NativeMethods.SetBkColor(nmcustomdraw.hdc, ColorTranslator.ToWin32(Color.Red));
//NativeMethods.SetTextColor(nmcustomdraw.hdc, ColorTranslator.ToWin32(Color.Blue));
//m.Result = IntPtr.Zero;
if (this.cachedNeedsCustomDraw) {
using (Graphics g = Graphics.FromHdc(nmcustomdraw.hdc)) {
g.TextRenderingHint = ObjectListView.TextRenderingHint;
this.CustomDrawHeaderCell(g, columnIndex, nmcustomdraw.uItemState);
}
m.Result = (IntPtr) CDRF_SKIPDEFAULT;
} else {
const int CDIS_SELECTED = 1;
bool isPressed = ((nmcustomdraw.uItemState & CDIS_SELECTED) == CDIS_SELECTED);
// We don't need to modify this based on checkboxes, since there can't be checkboxes if we are here
bool isHot = columnIndex == this.ColumnIndexUnderCursor;
Font f = this.CalculateFont(column, isHot, isPressed);
this.fontHandle = f.ToHfont();
NativeMethods.SelectObject(nmcustomdraw.hdc, this.fontHandle);
m.Result = (IntPtr) (CDRF_NEWFONT | CDRF_NOTIFYPOSTPAINT);
}
return true;
case CDDS_ITEMPOSTPAINT:
if (this.fontHandle != IntPtr.Zero) {
NativeMethods.DeleteObject(this.fontHandle);
this.fontHandle = IntPtr.Zero;
}
break;
}
return false;
}
private bool cachedNeedsCustomDraw;
private IntPtr fontHandle;
/// <summary>
/// The message divides a ListView's space between the header and the rows of the listview.
/// The WINDOWPOS structure controls the headers bounds, the RECT controls the listview bounds.
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleLayout(ref Message m) {
if (this.ListView.HeaderStyle == ColumnHeaderStyle.None)
return true;
NativeMethods.HDLAYOUT hdlayout = (NativeMethods.HDLAYOUT) m.GetLParam(typeof (NativeMethods.HDLAYOUT));
NativeMethods.RECT rect = (NativeMethods.RECT) Marshal.PtrToStructure(hdlayout.prc, typeof (NativeMethods.RECT));
NativeMethods.WINDOWPOS wpos = (NativeMethods.WINDOWPOS) Marshal.PtrToStructure(hdlayout.pwpos, typeof (NativeMethods.WINDOWPOS));
using (Graphics g = this.ListView.CreateGraphics()) {
g.TextRenderingHint = ObjectListView.TextRenderingHint;
int height = this.CalculateHeight(g);
wpos.hwnd = this.Handle;
wpos.hwndInsertAfter = IntPtr.Zero;
wpos.flags = NativeMethods.SWP_FRAMECHANGED;
wpos.x = rect.left;
wpos.y = rect.top;
wpos.cx = rect.right - rect.left;
wpos.cy = height;
rect.top = height;
Marshal.StructureToPtr(rect, hdlayout.prc, false);
Marshal.StructureToPtr(wpos, hdlayout.pwpos, false);
}
this.ListView.BeginInvoke((MethodInvoker) delegate {
this.Invalidate();
this.ListView.Invalidate();
});
return false;
}
/// <summary>
/// Handle when the underlying header control is destroyed
/// </summary>
/// <param name="m"></param>
/// <returns></returns>
protected bool HandleDestroy(ref Message m) {
if (this.toolTip != null) {
this.toolTip.Showing -= new EventHandler<ToolTipShowingEventArgs>(this.ListView.HeaderToolTipShowingCallback);
}
return false;
}
#endregion
#region Rendering
/// <summary>
/// Does this header need to be custom drawn?
/// </summary>
/// <remarks>Word wrapping and colored text require custom drawning. Funnily enough, we
/// can change the font natively.</remarks>
protected bool NeedsCustomDraw() {
if (this.WordWrap)
return true;
if (this.ListView.HeaderUsesThemes)
return false;
if (this.NeedsCustomDraw(this.ListView.HeaderFormatStyle))
return true;
foreach (OLVColumn column in this.ListView.Columns) {
if (column.HasHeaderImage ||
!column.ShowTextInHeader ||
column.IsHeaderVertical ||
this.HasFilterIndicator(column) ||
this.HasCheckBox(column) ||
column.TextAlign != column.HeaderTextAlign ||
this.NeedsCustomDraw(column.HeaderFormatStyle))
return true;
}
return false;
}
private bool NeedsCustomDraw(HeaderFormatStyle style) {
if (style == null)
return false;
return (this.NeedsCustomDraw(style.Normal) ||
this.NeedsCustomDraw(style.Hot) ||
this.NeedsCustomDraw(style.Pressed));
}
private bool NeedsCustomDraw(HeaderStateStyle style) {
if (style == null)
return false;
// If we want fancy colors or frames, we have to custom draw. Oddly enough, we
// can handle font changes without custom drawing.
if (!style.BackColor.IsEmpty)
return true;
if (style.FrameWidth > 0f && !style.FrameColor.IsEmpty)
return true;
return (!style.ForeColor.IsEmpty && style.ForeColor != Color.Black);
}
/// <summary>
/// Draw one cell of the header
/// </summary>
/// <param name="g"></param>
/// <param name="columnIndex"></param>
/// <param name="itemState"></param>
protected void CustomDrawHeaderCell(Graphics g, int columnIndex, int itemState) {
OLVColumn column = this.ListView.GetColumn(columnIndex);
bool hasCheckBox = this.HasCheckBox(column);
bool isMouseOverCheckBox = columnIndex == this.lastCheckBoxUnderCursor;
bool isMouseDownOnCheckBox = isMouseOverCheckBox && Control.MouseButtons == MouseButtons.Left;
bool isHot = (columnIndex == this.ColumnIndexUnderCursor) && (!(hasCheckBox && isMouseOverCheckBox));
const int CDIS_SELECTED = 1;
bool isPressed = ((itemState & CDIS_SELECTED) == CDIS_SELECTED);
// System.Diagnostics.Debug.WriteLine(String.Format("{2:hh:mm:ss.ff} - HeaderCustomDraw: {0}, {1}", columnIndex, itemState, DateTime.Now));
// Calculate which style should be used for the header
HeaderStateStyle stateStyle = this.CalculateStateStyle(column, isHot, isPressed);
// If there is an owner drawn delegate installed, give it a chance to draw the header
Rectangle fullCellBounds = this.GetItemRect(columnIndex);
if (column.HeaderDrawing != null)
{
if (!column.HeaderDrawing(g, fullCellBounds, columnIndex, column, isPressed, stateStyle))
return;
}
// Draw the background
if (this.ListView.HeaderUsesThemes &&
VisualStyleRenderer.IsSupported &&
VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.Item.Normal))
this.DrawThemedBackground(g, fullCellBounds, columnIndex, isPressed, isHot);
else
this.DrawUnthemedBackground(g, fullCellBounds, columnIndex, isPressed, isHot, stateStyle);
Rectangle r = this.GetHeaderDrawRect(columnIndex);
// Draw the sort indicator if this column has one
if (this.HasSortIndicator(column)) {
if (this.ListView.HeaderUsesThemes &&
VisualStyleRenderer.IsSupported &&
VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.SortArrow.SortedUp))
this.DrawThemedSortIndicator(g, r);
else
r = this.DrawUnthemedSortIndicator(g, r);
}
if (this.HasFilterIndicator(column))
r = this.DrawFilterIndicator(g, r);
if (hasCheckBox)
r = this.DrawCheckBox(g, r, column.HeaderCheckState, column.HeaderCheckBoxDisabled, isMouseOverCheckBox, isMouseDownOnCheckBox);
// Debugging - Where is the text going to be drawn
// g.DrawRectangle(Pens.Blue, r);
// Finally draw the text
this.DrawHeaderImageAndText(g, r, column, stateStyle);
}
private Rectangle DrawCheckBox(Graphics g, Rectangle r, CheckState checkState, bool isDisabled, bool isHot,
bool isPressed) {
CheckBoxState checkBoxState = this.GetCheckBoxState(checkState, isDisabled, isHot, isPressed);
Rectangle checkBoxBounds = this.CalculateCheckBoxBounds(g, r);
CheckBoxRenderer.DrawCheckBox(g, checkBoxBounds.Location, checkBoxState);
// Move the left edge without changing the right edge
int newX = checkBoxBounds.Right + 3;
r.Width -= (newX - r.X);
r.X = newX;
return r;
}
private Rectangle CalculateCheckBoxBounds(Graphics g, Rectangle cellBounds) {
Size checkBoxSize = CheckBoxRenderer.GetGlyphSize(g, CheckBoxState.CheckedNormal);
// Vertically center the checkbox
int topOffset = (cellBounds.Height - checkBoxSize.Height)/2;
return new Rectangle(cellBounds.X + 3, cellBounds.Y + topOffset, checkBoxSize.Width, checkBoxSize.Height);
}
private CheckBoxState GetCheckBoxState(CheckState checkState, bool isDisabled, bool isHot, bool isPressed) {
// Should the checkbox be drawn as disabled?
if (isDisabled) {
switch (checkState) {
case CheckState.Checked:
return CheckBoxState.CheckedDisabled;
case CheckState.Unchecked:
return CheckBoxState.UncheckedDisabled;
default:
return CheckBoxState.MixedDisabled;
}
}
// Is the mouse button currently down?
if (isPressed) {
switch (checkState) {
case CheckState.Checked:
return CheckBoxState.CheckedPressed;
case CheckState.Unchecked:
return CheckBoxState.UncheckedPressed;
default:
return CheckBoxState.MixedPressed;
}
}
// Is the cursor currently over this checkbox?
if (isHot) {
switch (checkState) {
case CheckState.Checked:
return CheckBoxState.CheckedHot;
case CheckState.Unchecked:
return CheckBoxState.UncheckedHot;
default:
return CheckBoxState.MixedHot;
}
}
// Not hot and not disabled -- just draw it normally
switch (checkState) {
case CheckState.Checked:
return CheckBoxState.CheckedNormal;
case CheckState.Unchecked:
return CheckBoxState.UncheckedNormal;
default:
return CheckBoxState.MixedNormal;
}
}
/// <summary>
/// Draw a background for the header, without using Themes.
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
/// <param name="columnIndex"></param>
/// <param name="isPressed"></param>
/// <param name="isHot"></param>
/// <param name="stateStyle"></param>
protected void DrawUnthemedBackground(Graphics g, Rectangle r, int columnIndex, bool isPressed, bool isHot, HeaderStateStyle stateStyle) {
if (stateStyle.BackColor.IsEmpty)
// I know we're supposed to be drawing the unthemed background, but let's just see if we
// can draw something more interesting than the dull raised block
if (VisualStyleRenderer.IsSupported &&
VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.Item.Normal))
this.DrawThemedBackground(g, r, columnIndex, isPressed, isHot);
else
ControlPaint.DrawBorder3D(g, r, Border3DStyle.RaisedInner);
else {
using (Brush b = new SolidBrush(stateStyle.BackColor))
g.FillRectangle(b, r);
}
// Draw the frame if the style asks for one
if (!stateStyle.FrameColor.IsEmpty && stateStyle.FrameWidth > 0f) {
RectangleF r2 = r;
r2.Inflate(-stateStyle.FrameWidth, -stateStyle.FrameWidth);
using (Pen pen = new Pen(stateStyle.FrameColor, stateStyle.FrameWidth))
g.DrawRectangle(pen, r2.X, r2.Y, r2.Width, r2.Height);
}
}
/// <summary>
/// Draw a more-or-less pure themed header background.
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
/// <param name="columnIndex"></param>
/// <param name="isPressed"></param>
/// <param name="isHot"></param>
protected void DrawThemedBackground(Graphics g, Rectangle r, int columnIndex, bool isPressed, bool isHot) {
int part = 1; // normal item
if (columnIndex == 0 &&
VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.ItemLeft.Normal))
part = 2; // left item
if (columnIndex == this.ListView.Columns.Count - 1 &&
VisualStyleRenderer.IsElementDefined(VisualStyleElement.Header.ItemRight.Normal))
part = 3; // right item
int state = 1; // normal state
if (isPressed)
state = 3; // pressed
else if (isHot)
state = 2; // hot
VisualStyleRenderer renderer = new VisualStyleRenderer("HEADER", part, state);
renderer.DrawBackground(g, r);
}
/// <summary>
/// Draw a sort indicator using themes
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
protected void DrawThemedSortIndicator(Graphics g, Rectangle r) {
VisualStyleRenderer renderer2 = null;
if (this.ListView.LastSortOrder == SortOrder.Ascending)
renderer2 = new VisualStyleRenderer(VisualStyleElement.Header.SortArrow.SortedUp);
if (this.ListView.LastSortOrder == SortOrder.Descending)
renderer2 = new VisualStyleRenderer(VisualStyleElement.Header.SortArrow.SortedDown);
if (renderer2 != null) {
Size sz = renderer2.GetPartSize(g, ThemeSizeType.True);
Point pt = renderer2.GetPoint(PointProperty.Offset);
// GetPoint() should work, but if it doesn't, put the arrow in the top middle
if (pt.X == 0 && pt.Y == 0)
pt = new Point(r.X + (r.Width/2) - (sz.Width/2), r.Y);
renderer2.DrawBackground(g, new Rectangle(pt, sz));
}
}
/// <summary>
/// Draw a sort indicator without using themes
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
/// <returns></returns>
protected Rectangle DrawUnthemedSortIndicator(Graphics g, Rectangle r) {
// No theme support for sort indicators. So, we draw a triangle at the right edge
// of the column header.
const int triangleHeight = 16;
const int triangleWidth = 16;
const int midX = triangleWidth/2;
const int midY = (triangleHeight/2) - 1;
const int deltaX = midX - 2;
const int deltaY = deltaX/2;
Point triangleLocation = new Point(r.Right - triangleWidth - 2, r.Top + (r.Height - triangleHeight)/2);
Point[] pts = new Point[] {triangleLocation, triangleLocation, triangleLocation};
if (this.ListView.LastSortOrder == SortOrder.Ascending) {
pts[0].Offset(midX - deltaX, midY + deltaY);
pts[1].Offset(midX, midY - deltaY - 1);
pts[2].Offset(midX + deltaX, midY + deltaY);
} else {
pts[0].Offset(midX - deltaX, midY - deltaY);
pts[1].Offset(midX, midY + deltaY);
pts[2].Offset(midX + deltaX, midY - deltaY);
}
g.FillPolygon(Brushes.SlateGray, pts);
r.Width = r.Width - triangleWidth;
return r;
}
/// <summary>
/// Draw an indication that this column has a filter applied to it
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
/// <returns></returns>
protected Rectangle DrawFilterIndicator(Graphics g, Rectangle r) {
int width = this.CalculateFilterIndicatorWidth(r);
if (width <= 0)
return r;
Image indicator = Resources.ColumnFilterIndicator;
int x = r.Right - width;
int y = r.Top + (r.Height - indicator.Height)/2;
g.DrawImageUnscaled(indicator, x, y);
r.Width -= width;
return r;
}
private int CalculateFilterIndicatorWidth(Rectangle r) {
if (Resources.ColumnFilterIndicator == null || r.Width < 48)
return 0;
return Resources.ColumnFilterIndicator.Width + 1;
}
/// <summary>
/// Draw the header's image and text
/// </summary>
/// <param name="g"></param>
/// <param name="r"></param>
/// <param name="column"></param>
/// <param name="stateStyle"></param>
protected void DrawHeaderImageAndText(Graphics g, Rectangle r, OLVColumn column, HeaderStateStyle stateStyle) {
TextFormatFlags flags = this.TextFormatFlags;
flags |= TextFormatFlags.VerticalCenter;
if (column.HeaderTextAlign == HorizontalAlignment.Center)
flags |= TextFormatFlags.HorizontalCenter;
if (column.HeaderTextAlign == HorizontalAlignment.Right)
flags |= TextFormatFlags.Right;
Font f = this.ListView.HeaderUsesThemes ? this.ListView.Font : stateStyle.Font ?? this.ListView.Font;
Color color = this.ListView.HeaderUsesThemes ? Color.Black : stateStyle.ForeColor;
if (color.IsEmpty)
color = Color.Black;
const int imageTextGap = 3;
if (column.IsHeaderVertical) {
DrawVerticalText(g, r, column, f, color);
} else {
// Does the column have a header image and is there space for it?
if (column.HasHeaderImage && r.Width > column.ImageList.ImageSize.Width*2)
DrawImageAndText(g, r, column, flags, f, color, imageTextGap);
else
DrawText(g, r, column, flags, f, color);
}
}
private void DrawText(Graphics g, Rectangle r, OLVColumn column, TextFormatFlags flags, Font f, Color color) {
if (column.ShowTextInHeader)
TextRenderer.DrawText(g, column.Text, f, r, color, Color.Transparent, flags);
}
private void DrawImageAndText(Graphics g, Rectangle r, OLVColumn column, TextFormatFlags flags, Font f,
Color color, int imageTextGap) {
Rectangle textRect = r;
textRect.X += (column.ImageList.ImageSize.Width + imageTextGap);
textRect.Width -= (column.ImageList.ImageSize.Width + imageTextGap);
Size textSize = Size.Empty;
if (column.ShowTextInHeader)
textSize = TextRenderer.MeasureText(g, column.Text, f, textRect.Size, flags);
int imageY = r.Top + ((r.Height - column.ImageList.ImageSize.Height)/2);
int imageX = textRect.Left;
if (column.HeaderTextAlign == HorizontalAlignment.Center)
imageX = textRect.Left + ((textRect.Width - textSize.Width)/2);
if (column.HeaderTextAlign == HorizontalAlignment.Right)
imageX = textRect.Right - textSize.Width;
imageX -= (column.ImageList.ImageSize.Width + imageTextGap);
column.ImageList.Draw(g, imageX, imageY, column.ImageList.Images.IndexOfKey(column.HeaderImageKey));
this.DrawText(g, textRect, column, flags, f, color);
}
private static void DrawVerticalText(Graphics g, Rectangle r, OLVColumn column, Font f, Color color) {
try {
// Create a matrix transformation that will rotate the text 90 degrees vertically
// AND place the text in the middle of where it was previously. [Think of tipping
// a box over by its bottom left edge -- you have to move it back a bit so it's
// in the same place as it started]
Matrix m = new Matrix();
m.RotateAt(-90, new Point(r.X, r.Bottom));
m.Translate(0, r.Height);
g.Transform = m;
StringFormat fmt = new StringFormat(StringFormatFlags.NoWrap);
fmt.Alignment = StringAlignment.Near;
fmt.LineAlignment = column.HeaderTextAlignAsStringAlignment;
//fmt.Trimming = StringTrimming.EllipsisCharacter;
// The drawing is rotated 90 degrees, so switch our text boundaries
Rectangle textRect = r;
textRect.Width = r.Height;
textRect.Height = r.Width;
using (Brush b = new SolidBrush(color))
g.DrawString(column.Text, f, b, textRect, fmt);
}
finally {
g.ResetTransform();
}
}
/// <summary>
/// Return the header format that should be used for the given column
/// </summary>
/// <param name="column"></param>
/// <returns></returns>
protected HeaderFormatStyle CalculateHeaderStyle(OLVColumn column) {
return column.HeaderFormatStyle ?? this.ListView.HeaderFormatStyle ?? new HeaderFormatStyle();
}
/// <summary>
/// What style should be applied to the header?
/// </summary>
/// <param name="column"></param>
/// <param name="isHot"></param>
/// <param name="isPressed"></param>
/// <returns></returns>
protected HeaderStateStyle CalculateStateStyle(OLVColumn column, bool isHot, bool isPressed) {
HeaderFormatStyle headerStyle = this.CalculateHeaderStyle(column);
if (this.ListView.IsDesignMode)
return headerStyle.Normal;
if (isPressed)
return headerStyle.Pressed;
if (isHot)
return headerStyle.Hot;
return headerStyle.Normal;
}
/// <summary>
/// What font should be used to draw the header text?
/// </summary>
/// <param name="column"></param>
/// <param name="isHot"></param>
/// <param name="isPressed"></param>
/// <returns></returns>
protected Font CalculateFont(OLVColumn column, bool isHot, bool isPressed) {
HeaderStateStyle stateStyle = this.CalculateStateStyle(column, isHot, isPressed);
return stateStyle.Font ?? this.ListView.Font;
}
/// <summary>
/// What flags will be used when drawing text
/// </summary>
protected TextFormatFlags TextFormatFlags {
get {
TextFormatFlags flags = TextFormatFlags.EndEllipsis |
TextFormatFlags.NoPrefix |
TextFormatFlags.WordEllipsis |
TextFormatFlags.PreserveGraphicsTranslateTransform;
if (this.WordWrap)
flags |= TextFormatFlags.WordBreak;
else
flags |= TextFormatFlags.SingleLine;
if (this.ListView.RightToLeft == RightToLeft.Yes)
flags |= TextFormatFlags.RightToLeft;
return flags;
}
}
/// <summary>
/// Perform a HitTest for the header control
/// </summary>
/// <param name="x"></param>
/// <param name="y"></param>
/// <returns>Null if the given point isn't over the header</returns>
internal OlvListViewHitTestInfo.HeaderHitTestInfo HitTest(int x, int y)
{
Rectangle r = this.ClientRectangle;
if (!r.Contains(x, y))
return null;
Point pt = new Point(x + this.ListView.LowLevelScrollPosition.X, y);
OlvListViewHitTestInfo.HeaderHitTestInfo hti = new OlvListViewHitTestInfo.HeaderHitTestInfo();
hti.ColumnIndex = NativeMethods.GetColumnUnderPoint(this.Handle, pt);
hti.IsOverCheckBox = this.IsPointOverHeaderCheckBox(hti.ColumnIndex, pt);
hti.OverDividerIndex = NativeMethods.GetDividerUnderPoint(this.Handle, pt);
return hti;
}
#endregion
}
}
Reference in New Issue Copy Permalink