FNullCursor Class Reference

#include <NullCursor.h>

Inheritance diagram for FNullCursor:

Public Member Functions
	FNullCursor ()
virtual	~FNullCursor ()
virtual FVector2D	GetPosition () const override
virtual void	SetPosition (const int32 X, const int32 Y) override
virtual void	SetType (const EMouseCursor::Type InNewCursor) override
virtual EMouseCursor::Type	GetType () const override
virtual void	GetSize (int32 &Width, int32 &Height) const override
virtual void	Show (bool bShow) override
virtual void	Lock (const RECT *const Bounds) override
virtual void	SetTypeShape (EMouseCursor::Type InCursorType, void *CursorHandle) override
Public Member Functions inherited from ICursor
virtual	~ICursor ()=default
virtual void *	CreateCursorFromFile (const FString &InPathToCursorWithoutExtension, FVector2D HotSpot)
virtual bool	IsCreateCursorFromRGBABufferSupported () const
virtual void *	CreateCursorFromRGBABuffer (const FColor *Pixels, int32 Width, int32 Height, FVector2D InHotSpot)

Detailed Description

An implementation of an ICursor specifically for use when rendering off screen. This cursor has no platform backing so instead keeps track of its position and other properties itself.

Constructor & Destructor Documentation

FNullCursor()

FNullCursor::FNullCursor

(

)

~FNullCursor()

FNullCursor::~FNullCursor ( )

virtual

Member Function Documentation

GetPosition()

FVector2D FNullCursor::GetPosition ( ) const

overridevirtual

The position of the cursor

Implements ICursor.

GetSize()

void FNullCursor::GetSize ( int32 &  Width, int32 &  Height  ) const

overridevirtual

Gets the size of the cursor

Implements ICursor.

GetType()

EMouseCursor::Type FNullCursor::GetType ( ) const

overridevirtual

Gets the current type of the cursor

Implements ICursor.

Lock()

void FNullCursor::Lock ( const RECT *const  Bounds )

overridevirtual

Locks the cursor to the passed in bounds

Parameters

Bounds

The bounds to lock the cursor to. Pass NULL to unlock.

Implements ICursor.

SetPosition()

void FNullCursor::SetPosition ( const int32  X, const int32  Y  )

overridevirtual

Sets the position of the cursor

Implements ICursor.

SetType()

void FNullCursor::SetType ( const EMouseCursor::Type  InNewCursor )

overridevirtual

Sets the cursor

Implements ICursor.

SetTypeShape()

void FNullCursor::SetTypeShape ( EMouseCursor::Type  InCursorType, void *  CursorHandle  )

overridevirtual

Allows overriding the shape of a particular cursor.

Implements ICursor.

Show()

void FNullCursor::Show ( bool  bShow )

overridevirtual

Shows or hides the cursor

Parameters

bShow

true to show the mouse cursor, false to hide it

Implements ICursor.

---

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

• Engine/Source/Runtime/ApplicationCore/Public/Null/NullCursor.h
• Engine/Source/Runtime/ApplicationCore/Private/Null/NullCursor.cpp