Code Quality: Migrate to InputNonClientPointerSource

[Poker-sang]

What feature or improvement do you think would benefit Files?

InputNonClientPointerSource is now available in WASDK1.4. We can use it to replace DragZoneHelper for better Maintainability. We can customize title bar more efficiently.

see also

Requirements

move to InputNonClientPointerSource

Files Version

any

Windows Version

any

Comments

No response

[yaira2]

👍

[Poker-sang]

This is the tool class I use. It can clear the old regions and apply the title bar. I'm writing this code because the non-client region refreshes every time you move, resize, etc(AppWindow.Changed).

/// <summary>
/// Informs the bearer to refresh the drag region.
/// </summary>
/// <param name="sender"></param>
/// <param name="windowSize"></param>
/// <param name="scaleFactor"></param>
/// <param name="titleBarHeight">will not set<see cref="NonClientRegionKind.LeftBorder"/>, <see cref="NonClientRegionKind.RightBorder"/>, <see cref="NonClientRegionKind.Caption"/>when less than 0</param>
protected virtual void SetTitleBarDragRegion(InputNonClientPointerSource sender, SizeInt32 windowSize, double scaleFactor, out int titleBarHeight)
{
    titleBarHeight = -1;
}

public void RaiseSetTitleBarDragRegion()
{
    // UIElement.RasterizationScale is always 1
    var source = InputNonClientPointerSource.GetForWindowId(Window.AppWindow.Id);
    var scaleFactor = XamlRoot.RasterizationScale;
    var size = Window.AppWindow.Size;
    // If the number of regions is 0 or 1, AppWindow will automatically reset to the default region next time, but if it is >=2, it will not and need to be manually cleared
    source.ClearRegionRects(NonClientRegionKind.Passthrough);
    SetTitleBarDragRegion(source, size, scaleFactor, out var titleBarHeight);
    if (titleBarHeight >= 0)
    {
        // region under the buttons
        const int borderThickness = 5;
        source.SetRegionRects(NonClientRegionKind.LeftBorder, [GetScaledRect(new RectInt32(0, 0, borderThickness, titleBarHeight))]);
        source.SetRegionRects(NonClientRegionKind.RightBorder, [GetScaledRect(new RectInt32(size.Width, 0, borderThickness, titleBarHeight))]);
        source.SetRegionRects(NonClientRegionKind.Caption, [GetScaledRect(new RectInt32(0, 0, size.Width, titleBarHeight))]);
    }
}

protected RectInt32 GetScaledRect(RectInt32 rect)
{
    var scaleFactor = XamlRoot.RasterizationScale;
    return new RectInt32((int)(rect.X * scaleFactor), (int)(rect.Y * scaleFactor), (int)(rect.Width * scaleFactor), (int)(rect.Height * scaleFactor));
}

protected RectInt32 FromControl(UIElement uiElement)
{
    var pos = uiElement.TransformToVisual(null).TransformPoint(new Point(0, 0));
    var rect = new RectInt32((int)pos.X, (int)pos.Y, (int)uiElement.ActualSize.X, (int)uiElement.ActualSize.Y);
    return GetScaledRect(rect);
}

Usage:

protected override void SetTitleBarDragRegion(InputNonClientPointerSource sender, SizeInt32 windowSize, double scaleFactor, out int titleBarHeight)
{
    titleBarHeight = 48;
    var leftIndent = new RectInt32(0, 0, titleBarHeight, titleBarHeight);
    sender.SetRegionRects(NonClientRegionKind.Icon, [FromControl(IconControl)]);
    sender.SetRegionRects(NonClientRegionKind.Passthrough, [FromControl(TitleBarControl), GetScaledRect(leftIndent)]);
}

private void Loaded(object sender, RoutedEventArgs e)
{
    RaiseSetTitleBarDragRegion();
    Window.AppWindow.Changed += (_, _) => page.RaiseSetTitleBarDragRegion();
}

[yaira2]

This looks a lot cleaner

[0x5bfa]

Cool!

[Poker-sang]

With InputNonClientPointerSource we can not only customize the caption region, but other regions like icon, border, close button... as well. So, it is a new feature I thought.