FCursorReply Class Reference

#include <CursorReply.h>

Inheritance diagram for FCursorReply:

Public Member Functions
TSharedPtr< SWindow >	GetCursorWindow () const
TSharedPtr< SWidget >	GetCursorWidget () const
EMouseCursor::Type	GetCursorType () const
void	SetCursorWidget (TSharedPtr< SWindow > InCursorWindow, TSharedPtr< SWidget > InCursorWidget)
Public Member Functions inherited from TReplyBase< FCursorReply >
	TReplyBase (bool bIsHandled)
Public Member Functions inherited from FReplyBase
bool	IsEventHandled () const
const TSharedPtr< SWidget >	GetHandler () const

Static Public Member Functions
static FCursorReply	Unhandled ()
static FCursorReply	Cursor (EMouseCursor::Type InCursor)

Additional Inherited Members
Protected Member Functions inherited from TReplyBase< FCursorReply >
FCursorReply &	SetHandler (const TSharedRef< SWidget > &InHandler)
FCursorReply &	Me ()
Protected Member Functions inherited from FReplyBase
	FReplyBase (bool InIsHandled)
Protected Attributes inherited from FReplyBase
bool	bIsHandled
TSharedPtr< SWidget >	EventHandler

Detailed Description

A reply to the OnQueryCursor event.

Member Function Documentation

Cursor()

static FCursorReply FCursorReply::Cursor ( EMouseCursor::Type  InCursor )

inlinestatic

Respond with a specific cursor. This cursor will be used and no other widgets will be asked.

GetCursorType()

EMouseCursor::Type FCursorReply::GetCursorType ( ) const

inline

Returns

The requested MouseCursor if no custom widget is set and the event was handled.

GetCursorWidget()

TSharedPtr< SWidget > FCursorReply::GetCursorWidget ( ) const

inline

Returns

The custom Cursor Widget to render if set and the event was handled.

GetCursorWindow()

TSharedPtr< SWindow > FCursorReply::GetCursorWindow ( ) const

inline

Returns

The window to render the Cursor Widget in.

SetCursorWidget()

void FCursorReply::SetCursorWidget ( TSharedPtr< SWindow >  InCursorWindow, TSharedPtr< SWidget >  InCursorWidget  )

inline

Set the Cursor Widget, used by slate application to set the cursor widget if the MapCursor returns a widget.

Unhandled()

static FCursorReply FCursorReply::Unhandled ( )

inlinestatic

Makes a NULL response meaning no prefersce. i.e. If your widget returns this, its parent will get to decide what the cursor shoudl be. This is the default behavior for a widget.

---

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

• Engine/Source/Runtime/SlateCore/Public/Input/CursorReply.h