tooltip.go

// Copyright ©2021-2022 by Richard A. Wilkes. All rights reserved.
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, version 2.0. If a copy of the MPL was not distributed with
// this file, You can obtain one at http://mozilla.org/MPL/2.0/.
//
// This Source Code Form is "Incompatible With Secondary Licenses", as
// defined by the Mozilla Public License, version 2.0.

package unison

import (
	"strings"
	"time"

	"github.com/richardwilkes/unison/enums/paintstyle"
)

// DefaultTooltipTheme holds the default TooltipTheme values for Tooltips. Modifying this data will not alter existing
// Tooltips, but will alter any Tooltips created in the future.
var DefaultTooltipTheme = TooltipTheme{
	BackgroundInk: TooltipColor,
	BaseBorder: NewCompoundBorder(NewLineBorder(ControlEdgeColor, 0, NewUniformInsets(1), false),
		NewEmptyBorder(StdInsets())),
	Label:     defaultToolTipLabelTheme(),
	Delay:     1500 * time.Millisecond,
	Dismissal: 5 * time.Second,
}

func defaultToolTipLabelTheme() LabelTheme {
	theme := DefaultLabelTheme
	theme.Font = FieldFont
	theme.OnBackgroundInk = OnTooltipColor
	return theme
}

// TooltipTheme holds theming data for a Tooltip.
type TooltipTheme struct {
	SecondaryTextFont Font
	BackgroundInk     Ink
	BaseBorder        Border
	Label             LabelTheme
	Delay             time.Duration
	Dismissal         time.Duration
}

type tooltipSequencer struct {
	window   *Window
	avoid    Rect
	sequence int
}

// NewTooltipBase returns the base for a tooltip.
func NewTooltipBase() *Panel {
	tip := NewPanel()
	tip.SetBorder(DefaultTooltipTheme.BaseBorder)
	tip.DrawCallback = func(canvas *Canvas, _ Rect) {
		r := tip.ContentRect(true)
		canvas.DrawRect(r, DefaultTooltipTheme.BackgroundInk.Paint(canvas, r, paintstyle.Fill))
	}
	return tip
}

// NewTooltipWithText creates a standard text tooltip panel.
func NewTooltipWithText(text string) *Panel {
	tip := NewTooltipBase()
	tip.SetLayout(&FlexLayout{
		Columns:  1,
		HSpacing: StdHSpacing,
		VSpacing: StdVSpacing,
	})
	for _, str := range strings.Split(text, "\n") {
		l := NewLabel()
		l.LabelTheme = DefaultTooltipTheme.Label
		l.Text = str
		tip.AddChild(l)
	}
	return tip
}

// NewTooltipWithSecondaryText creates a text tooltip panel containing a primary piece of text along with a secondary
// piece of text in a slightly smaller font.
func NewTooltipWithSecondaryText(primary, secondary string) *Panel {
	tip := NewTooltipWithText(primary)
	if secondary != "" {
		for _, str := range strings.Split(secondary, "\n") {
			l := NewLabel()
			l.LabelTheme = DefaultTooltipTheme.Label
			desc := DefaultTooltipTheme.Label.Font.Descriptor()
			desc.Size--
			l.LabelTheme.Font = desc.Font()
			l.Text = str
			tip.AddChild(l)
		}
	}
	return tip
}

func (ts *tooltipSequencer) show() {
	if ts.window.tooltipSequence == ts.sequence && ts.window.Focused() {
		tip := ts.window.lastTooltip
		_, pref, _ := tip.Sizes(Size{})
		rect := Rect{Point: Point{X: ts.avoid.X, Y: ts.avoid.Bottom() + 1}, Size: pref}
		if rect.X < 0 {
			rect.X = 0
		}
		if rect.Y < 0 {
			rect.Y = 0
		}
		viewSize := ts.window.root.ContentRect(true).Size
		if viewSize.Width < rect.Width {
			_, pref, _ = tip.Sizes(Size{Width: viewSize.Width})
			if viewSize.Width < pref.Width {
				rect.X = 0
				rect.Width = viewSize.Width
			} else {
				rect.Width = pref.Width
			}
			rect.Height = pref.Height
		}
		if viewSize.Width < rect.X+rect.Width {
			rect.X = viewSize.Width - rect.Width
		}
		if viewSize.Height < rect.Y+rect.Height {
			rect.Y = ts.avoid.Y - (rect.Height + 1)
			if rect.Y < 0 {
				rect.Y = 0
			}
		}
		tip.SetFrameRect(rect)
		ts.window.root.setTooltip(tip)
		ts.window.lastTooltipShownAt = time.Now()
		if !tip.TooltipImmediate {
			InvokeTaskAfter(ts.close, DefaultTooltipTheme.Dismissal)
		}
	}
}

func (ts *tooltipSequencer) close() {
	if ts.window.tooltipSequence == ts.sequence {
		ts.window.root.setTooltip(nil)
	}
}