Show / Hide Table of Contents

Class ToolTip

Displays popup tooltip text when mouse hovers over component for an amount of time. Designed to be shared by any number of components inside the same canvas area. Use \r escape character to create multi-row tooltips.

Inheritance
Object
BaseScreenComponent
ToolTip
Inherited Members
BaseScreenComponent.rectRestrictedRenderArea
BaseScreenComponent.restrictedRenderAreaCustomParent
BaseScreenComponent.restrictedRenderAreaCoordinateType
BaseScreenComponent.backgroundTexture
BaseScreenComponent.animatedBackgroundTextures
BaseScreenComponent.backgroundTextureLayout
BaseScreenComponent.OnKeyboardEvent
BaseScreenComponent.OnMouseEnter
BaseScreenComponent.OnMouseLeave
BaseScreenComponent.OnMouseMove
BaseScreenComponent.OnMouseDown
BaseScreenComponent.OnMouseUp
BaseScreenComponent.OnMouseClick
BaseScreenComponent.OnMouseDoubleClick
BaseScreenComponent.OnRightMouseDown
BaseScreenComponent.OnRightMouseUp
BaseScreenComponent.OnRightMouseClick
BaseScreenComponent.OnRightMouseDoubleClick
BaseScreenComponent.OnMiddleMouseDown
BaseScreenComponent.OnMiddleMouseUp
BaseScreenComponent.OnMiddleMouseClick
BaseScreenComponent.OnMiddleMouseDoubleClick
BaseScreenComponent.OnMouseScrollUp
BaseScreenComponent.OnMouseScrollDown
BaseScreenComponent.Enabled
BaseScreenComponent.UseFocus
BaseScreenComponent.OverridesHotkeySequences
BaseScreenComponent.Name
BaseScreenComponent.Tag
BaseScreenComponent.Position
BaseScreenComponent.Size
BaseScreenComponent.RootSize
BaseScreenComponent.Parent
BaseScreenComponent.Rectangle
BaseScreenComponent.HorizontalAlignment
BaseScreenComponent.VerticalAlignment
BaseScreenComponent.RestrictedRenderAreaCoordinateType
BaseScreenComponent.RectRestrictedRenderArea
BaseScreenComponent.RestrictedRenderAreaCustomParent
BaseScreenComponent.UseRestrictedRenderArea
BaseScreenComponent.CustomMousePosition
BaseScreenComponent.MousePosition
BaseScreenComponent.LastMousePosition
BaseScreenComponent.ScaledMousePosition
BaseScreenComponent.BackgroundColor
BaseScreenComponent.MouseOverBackgroundColor
BaseScreenComponent.BackgroundColorTexture
BaseScreenComponent.BackgroundTexture
BaseScreenComponent.BackgroundCroppedRect
BaseScreenComponent.AnimatedBackgroundTextures
BaseScreenComponent.AnimationDelayInSeconds
BaseScreenComponent.BackgroundTextureLayout
BaseScreenComponent.InteriorWidth
BaseScreenComponent.InteriorHeight
BaseScreenComponent.Scale
BaseScreenComponent.AutoSize
BaseScreenComponent.LocalScale
BaseScreenComponent.ToolTip
BaseScreenComponent.ToolTipText
BaseScreenComponent.SuppressToolTip
BaseScreenComponent.MinAutoScale
BaseScreenComponent.MaxAutoScale
BaseScreenComponent.MouseOverComponent
BaseScreenComponent.TopMargin
BaseScreenComponent.BottomMargin
BaseScreenComponent.LeftMargin
BaseScreenComponent.RightMargin
BaseScreenComponent.ScreenToLocal(Vector2)
BaseScreenComponent.ScreenToLocal(Rect)
BaseScreenComponent.GotFocus()
BaseScreenComponent.LostFocus()
BaseScreenComponent.TriggerMouseClick()
BaseScreenComponent.KeyboardEvent(Event)
BaseScreenComponent.MouseClick(Vector2)
BaseScreenComponent.RightMouseClick(Vector2)
BaseScreenComponent.MiddleMouseClick(Vector2)
BaseScreenComponent.MouseDoubleClick(Vector2)
BaseScreenComponent.RightMouseDoubleClick(Vector2)
BaseScreenComponent.MiddleMouseDoubleClick(Vector2)
BaseScreenComponent.MouseEnter()
BaseScreenComponent.MouseLeave(BaseScreenComponent)
BaseScreenComponent.MouseMove(Int32, Int32)
BaseScreenComponent.MouseScrollUp()
BaseScreenComponent.MouseScrollDown()
BaseScreenComponent.Dispose()
BaseScreenComponent.SetMargins(Margins, Int32)
BaseScreenComponent.OffsetFrom(BaseScreenComponent, Sides, Int32)
BaseScreenComponent.SetFocus()
BaseScreenComponent.HasFocus()
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class ToolTip : BaseScreenComponent, IDisposable

Constructors

| Improve this Doc View Source

ToolTip()

Declaration
public ToolTip()

Properties

| Improve this Doc View Source

Font

Gets or sets font used inside tooltip.

Declaration
public DaggerfallFont Font { get; set; }
Property Value
Type Description
DaggerfallFont
| Improve this Doc View Source

MouseOffset

Gets or sets tooltip draw position relative to mouse.

Declaration
public Vector2 MouseOffset { get; set; }
Property Value
Type Description
Vector2
| Improve this Doc View Source

TextColor

Gets or sets tooltip text colour.

Declaration
public Color TextColor { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

ToolTipDelay

Sets delay time in seconds before tooltip is displayed.

Declaration
public float ToolTipDelay { get; set; }
Property Value
Type Description
Single

Methods

| Improve this Doc View Source

CloneSettings(ToolTip)

Copies key setting from another tooltip.

Declaration
public void CloneSettings(ToolTip from)
Parameters
Type Name Description
ToolTip from
| Improve this Doc View Source

Draw()

Declaration
public override void Draw()
Overrides
BaseScreenComponent.Draw()
| Improve this Doc View Source

Draw(String)

Flags tooltip to be drawn at end of UI update.

Declaration
public void Draw(string text)
Parameters
Type Name Description
String text

Text to render inside tooltip.

| Improve this Doc View Source

Update()

Declaration
public override void Update()
Overrides
BaseScreenComponent.Update()
  • Improve this Doc
  • View Source
In This Article
Back to top Generated by DocFX