ICursor Class Reference

#include <ICursor.h>

Inheritance diagram for ICursor:

Public Member Functions
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)
virtual FVector2D	GetPosition () const =0
virtual void	SetPosition (const int32 X, const int32 Y)=0
virtual void	SetType (const EMouseCursor::Type InNewCursor)=0
virtual EMouseCursor::Type	GetType () const =0
virtual void	GetSize (int32 &Width, int32 &Height) const =0
virtual void	Show (bool bShow)=0
virtual void	Lock (const RECT *const Bounds)=0
virtual void	SetTypeShape (EMouseCursor::Type InCursorType, void *CursorHandle)=0

Constructor & Destructor Documentation

~ICursor()

virtual ICursor::~ICursor ( )

virtualdefault

Member Function Documentation

CreateCursorFromFile()

virtual void * ICursor::CreateCursorFromFile ( const FString &  InPathToCursorWithoutExtension, FVector2D  HotSpot  )

inlinevirtual

Creates a hardware cursor from file. Can return nullptr when not available.

Reimplemented in FMacCursor, and FWindowsCursor.

CreateCursorFromRGBABuffer()

virtual void * ICursor::CreateCursorFromRGBABuffer ( const FColor *  Pixels, int32  Width, int32  Height, FVector2D  InHotSpot  )

inlinevirtual

Creates a hardware cursor from bitmap data. Can return nullptr when not available.

Reimplemented in FLinuxCursor, FMacCursor, and FWindowsCursor.

GetPosition()

virtual FVector2D ICursor::GetPosition ( ) const

pure virtual

The position of the cursor

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

GetSize()

virtual void ICursor::GetSize ( int32 &  Width, int32 &  Height  ) const

pure virtual

Gets the size of the cursor

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

GetType()

virtual EMouseCursor::Type ICursor::GetType ( ) const

pure virtual

Gets the current type of the cursor

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

IsCreateCursorFromRGBABufferSupported()

virtual bool ICursor::IsCreateCursorFromRGBABufferSupported ( ) const

inlinevirtual

Is CreateCursorFromRGBABuffer() supported by this cursor?

Reimplemented in FLinuxCursor, FMacCursor, and FWindowsCursor.

Lock()

virtual void ICursor::Lock ( const RECT *const  Bounds )

pure virtual

Locks the cursor to the passed in bounds

Parameters

Bounds

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

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

SetPosition()

virtual void ICursor::SetPosition ( const int32  X, const int32  Y  )

pure virtual

Sets the position of the cursor

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

SetType()

virtual void ICursor::SetType ( const EMouseCursor::Type  InNewCursor )

pure virtual

Sets the cursor

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

SetTypeShape()

virtual void ICursor::SetTypeShape ( EMouseCursor::Type  InCursorType, void *  CursorHandle  )

pure virtual

Allows overriding the shape of a particular cursor.

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

Show()

virtual void ICursor::Show ( bool  bShow )

pure virtual

Shows or hides the cursor

Parameters

bShow

true to show the mouse cursor, false to hide it

Implemented in FAndroidCursor, FGenericPlatformSoftwareCursor, FIOSCursor, FLinuxCursor, FMacCursor, FNullCursor, FWindowsCursor, and FFauxSlateCursor.

---

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

• Engine/Source/Runtime/ApplicationCore/Public/GenericPlatform/ICursor.h