IToolTip Class Reference

#include <IToolTip.h>

Inheritance diagram for IToolTip:

Public Member Functions
virtual TSharedRef< class SWidget >	AsWidget ()=0
virtual TSharedRef< SWidget >	GetContentWidget ()=0
virtual void	SetContentWidget (const TSharedRef< SWidget > &InContentWidget)=0
virtual void	ResetContentWidget ()
virtual bool	IsEmpty () const =0
virtual bool	IsInteractive () const =0
virtual void	OnOpening ()=0
virtual void	OnClosed ()=0
virtual void	OnSetInteractiveWindowLocation (FVector2D &InOutDesiredLocation) const
virtual	~IToolTip ()

Detailed Description

Interface for tool tips.

Constructor & Destructor Documentation

~IToolTip()

virtual IToolTip::~IToolTip ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

AsWidget()

virtual TSharedRef< class SWidget > IToolTip::AsWidget ( )

pure virtual

Gets the widget that this tool tip represents.

Returns

The tool tip widget.

Implemented in SToolTip, and FDelegateToolTip.

GetContentWidget()

virtual TSharedRef< SWidget > IToolTip::GetContentWidget ( )

pure virtual

Gets the tool tip's content widget.

Returns

The content widget.

Implemented in SToolTip, and FDelegateToolTip.

IsEmpty()

virtual bool IToolTip::IsEmpty ( ) const

pure virtual

Checks whether this tool tip has no content to display right now.

Returns

true if the tool tip has no content to display, false otherwise.

Implemented in SToolTip, and FDelegateToolTip.

IsInteractive()

virtual bool IToolTip::IsInteractive ( ) const

pure virtual

Checks whether this tool tip can be made interactive by the user (by holding Ctrl).

Returns

true if it is an interactive tool tip, false otherwise.

Implemented in SToolTip, and FDelegateToolTip.

OnClosed()

virtual void IToolTip::OnClosed ( )

pure virtual

Called when the tooltip widget is closed and the tooltip is no longer needed.

Implemented in SToolTip, and FDelegateToolTip.

OnOpening()

virtual void IToolTip::OnOpening ( )

pure virtual

Called when the tooltip widget is about to be requested for opening.

Implemented in SToolTip, and FDelegateToolTip.

OnSetInteractiveWindowLocation()

virtual void IToolTip::OnSetInteractiveWindowLocation ( FVector2D &  InOutDesiredLocation ) const

inlinevirtual

Allows an interactive tooltip to adjust and/or change its window location on open, as interactive tooltips don't update the tooltip window to follow the cursor position.

Parameters

InOutDesiredLocation

On input, contains the previous cursor position (in screen coordinates) plus the standard tooltip offset (SlateDefs::TooltipOffsetFromMouse). This position can be modified and/or reset to either adjust the offset or otherwise set to a new position as the output value.

Reimplemented in SToolTip.

ResetContentWidget()

virtual void IToolTip::ResetContentWidget ( )

inlinevirtual

Resets the tooltip to its default without a content widget.

Reimplemented in SToolTip.

SetContentWidget()

virtual void IToolTip::SetContentWidget ( const TSharedRef< SWidget > &  InContentWidget )

pure virtual

Sets the tool tip's content widget.

Parameters

InContentWidget

The new content widget to set.

Implemented in SToolTip, and FDelegateToolTip.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/SlateCore/Public/Widgets/IToolTip.h