Skip to content
Prysm Unreal documentation
SiteEmail
READ TIME: 10 MIN

SCohtmlWidget

Inherits from SLeafWidget

Protected Classes

Section titled “Protected Classes”
Name
structGesturePolicyDeleter

Public Functions

Section titled “Public Functions”
Name
SLATE_BEGIN_ARGS(SCohtmlWidget )
COHTMLPLUGIN_APISCohtmlWidget()
virtual COHTMLPLUGIN_API~SCohtmlWidget()
COHTMLPLUGIN_API voidConstruct(const FArguments & InArgs)
virtual COHTMLPLUGIN_API FVector2DComputeDesiredSize(float LayoutScaleMultiplier) const override
virtual COHTMLPLUGIN_API voidTick(const FGeometry & AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override
virtual COHTMLPLUGIN_API int32OnPaint(const FPaintArgs & Args, const FGeometry & AllottedGeometry, const FSlateRect & MyClippingRect, FSlateWindowElementList & OutDrawElements, int32 LayerId, const FWidgetStyle & InWidgetStyle, bool bParentEnabled) const override
virtual COHTMLPLUGIN_API FReplyOnMouseMove(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent) override
virtual COHTMLPLUGIN_API FReplyOnMouseButtonDown(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent) override
virtual COHTMLPLUGIN_API FReplyOnMouseButtonDoubleClick(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent) override
virtual COHTMLPLUGIN_API FReplyOnMouseButtonUp(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent) override
virtual COHTMLPLUGIN_API FReplyOnMouseWheel(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent) override
virtual COHTMLPLUGIN_API FReplyOnTouchStarted(const FGeometry & MyGeometry, const FPointerEvent & TouchEvent) override
virtual COHTMLPLUGIN_API FReplyOnTouchMoved(const FGeometry & MyGeometry, const FPointerEvent & TouchEvent) override
virtual COHTMLPLUGIN_API FReplyOnTouchEnded(const FGeometry & MyGeometry, const FPointerEvent & TouchEvent) override
COHTMLPLUGIN_API voidHandleCollectedTouchEvents()
virtual COHTMLPLUGIN_API FReplyOnDragDetected(const FGeometry & MyGeometry, const FPointerEvent & PointerEvent) override
virtual COHTMLPLUGIN_API FCursorReplyOnCursorQuery(const FGeometry & MyGeometry, const FPointerEvent & CursorEvent) const override
virtual COHTMLPLUGIN_API FReplyOnKeyDown(const FGeometry & MyGeometry, const FKeyEvent & KeyEvent) override
virtual COHTMLPLUGIN_API FReplyOnKeyUp(const FGeometry & MyGeometry, const FKeyEvent & KeyEvent) override
virtual COHTMLPLUGIN_API FReplyOnAnalogValueChanged(const FGeometry & MyGeometry, const FAnalogInputEvent & KeyEvent) override
virtual COHTMLPLUGIN_API FReplyOnKeyChar(const FGeometry & MyGeometry, const FCharacterEvent & InCharacterEvent) override
virtual COHTMLPLUGIN_API boolSupportsKeyboardFocus() const override
virtual COHTMLPLUGIN_API FReplyOnFocusReceived(const FGeometry & MyGeometry, const FFocusEvent & InKeyboardFocusEvent) override
virtual COHTMLPLUGIN_API voidOnFocusLost(const FFocusEvent & InKeyboardFocusEvent) override
COHTMLPLUGIN_API voidInitViewWrapper(TSharedPtr< cohtml::IViewListener > InViewListener, TSharedPtr< cohtml::ITextInputHandler > InTextInputHandler, TEnumAsByte< enum TextureFilter > & InFilter, UObject * InOwner)
COHTMLPLUGIN_API voidRecreateView(const cohtml::ViewSettings & Info, const FString & Url, TSharedPtr< cohtml::IViewListener > Listener, TSharedPtr< cohtml::ITextInputHandler > TextInputHandler, FCohtmlUEViewSettings & ViewSettingsUE)
COHTMLPLUGIN_API cohtml::View *GetView()
COHTMLPLUGIN_API cohtml::ViewRenderer *GetViewRenderer()
COHTMLPLUGIN_API UTextureRenderTarget2D *GetRenderTexture() const
COHTMLPLUGIN_API boolGetNeedToAdvanceView() const
COHTMLPLUGIN_API voidSetNeedToAdvanceView(bool InNeedToAdvanceView)
COHTMLPLUGIN_API voidSchedulePaintNextFrame()
FCohtmlViewWrapper *GetViewWrapper() const
TWeakObjectPtr< UObject >GetOwningWidget()
boolHasRequestedView() const
enum TextureFilterGetFilter() const
voidSetFilter(enum TextureFilter InFilter)
COHTMLPLUGIN_API voidSetReceiveInput(bool bInReceiveInput)
COHTMLPLUGIN_API voidSetInputPropagationBehaviour(ECohtmlInputPropagationBehaviour::Type Behaviour)
COHTMLPLUGIN_API voidSetMultiTouchEventsHandling(ECohtmlMultiTouchEventsHandling MultiTouchHandling)
FCohtmlGesturePolicy *GetGesturePolicy()
virtual voidPreCohtmlMouseEvent(SCohtmlWidget * , cohtml::View * , const cohtml::MouseEventData & )
cohtml::IInputProxy *GetFocusedInput()
voidSetFocusedInput(cohtml::IInputProxy * Proxy)

Protected Functions

Section titled “Protected Functions”
Name
voidCreateView(const cohtml::ViewSettings & RequestedViewSettings, const FString & Url)
FORCEINLINE FReplyHandleEventIfNeeded(const FKeyEvent & KeyEvent)
FORCEINLINE FReplyHandleEventIfNeeded(const FCharacterEvent & KeyEvent)
FORCEINLINE boolIsOwnerValid()
voidProcessKeyEvent(const FInputEvent & Event, cohtml::KeyEventData::EventType Type)
FReplyOnMouseEvent(const FGeometry & MyGeometry, const FPointerEvent & MouseEvent, cohtml::MouseEventData::EventType EventType)
FReplyOnTouchEvent(const FGeometry & MyGeometry, const FPointerEvent & TouchEvent, cohtml::TouchEventData::EventType EventType)
voidOnViewportResized(FViewport * ResizedViewport, uint32 )
voidCacheDPIScales()
voidCacheViewportDPIScale()
voidCacheWidgetWindowDPIScale()
voidForcePaintView(float InDeltaTime)

Public Attributes

Section titled “Public Attributes”
Name
FCohtmlGamepadBehaviourOnFocusLostDelegateGamepadBehaviourOnFocusLostDelegate
FCohtmlCaretRectCaretRect
EMouseCursor::TypeCurrentMouseCursor

Protected Attributes

Section titled “Protected Attributes”
Name
TSharedPtr< class FCoherentSlateElement, ESPMode::ThreadSafe >SlateElement
TUniquePtr< FCohtmlViewWrapper >ViewWrapper
TUniquePtr< FCohtmlGesturePolicy, GesturePolicyDeleter >GesturePolicy
TUniquePtr< class FCohtmlWidgetIME >IMEManager
TWeakObjectPtr< UObject >Owner
FIntPointViewportDPIScaledSize
FIntPointWidgetWindowDPIScaledSize
TEnumAsByte< enum TextureFilter >Filter
floatViewportDPIScale
floatWidgetWindowDPIScale
ECohtmlGamepadBehaviourOnFocusLostGamepadBehaviourOnFocusLost
boolbReceiveInput
boolbNeedsTextureUpdate
boolbViewCreationInProgress
boolbNeedToAdvanceViewNextFrame
cohtml::MouseEventDataLastMouseDownData
cohtml::TouchEventDataLastTouchDownData
boolbUnpairedMouseDown
boolbUnpairedTouchDown
boolbUseSurfacePartitioning
FDelegateHandleViewportResizedHandle
TEnumAsByte< ECohtmlInputPropagationBehaviour::Type >InputPropagationBehaviour
ECohtmlMultiTouchEventsHandlingMultiTouchEventsHandling
TArray< cohtml::TouchEventData >TouchEvents
FDelegateHandleOnSlateAppPostTickHandle

Friends

Section titled “Friends”
Name
classUCohtmlWidget
classFCohtmlWidgetIME

Public Functions Documentation

Section titled “Public Functions Documentation”

function SLATE_BEGIN_ARGS

Section titled “function SLATE_BEGIN_ARGS”
inline SLATE_BEGIN_ARGS(
    SCohtmlWidget
)

function SCohtmlWidget

Section titled “function SCohtmlWidget”
COHTMLPLUGIN_API SCohtmlWidget()

function ~SCohtmlWidget

Section titled “function ~SCohtmlWidget”
virtual COHTMLPLUGIN_API ~SCohtmlWidget()

function Construct

Section titled “function Construct”
COHTMLPLUGIN_API void Construct(
    const FArguments & InArgs
)

function ComputeDesiredSize

Section titled “function ComputeDesiredSize”
virtual COHTMLPLUGIN_API FVector2D ComputeDesiredSize(
    float LayoutScaleMultiplier
) const override

function Tick

Section titled “function Tick”
virtual COHTMLPLUGIN_API void Tick(
    const FGeometry & AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
) override

function OnPaint

Section titled “function OnPaint”
virtual COHTMLPLUGIN_API int32 OnPaint(
    const FPaintArgs & Args,
    const FGeometry & AllottedGeometry,
    const FSlateRect & MyClippingRect,
    FSlateWindowElementList & OutDrawElements,
    int32 LayerId,
    const FWidgetStyle & InWidgetStyle,
    bool bParentEnabled
) const override

function OnMouseMove

Section titled “function OnMouseMove”
virtual COHTMLPLUGIN_API FReply OnMouseMove(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
) override

function OnMouseButtonDown

Section titled “function OnMouseButtonDown”
virtual COHTMLPLUGIN_API FReply OnMouseButtonDown(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
) override

function OnMouseButtonDoubleClick

Section titled “function OnMouseButtonDoubleClick”
virtual COHTMLPLUGIN_API FReply OnMouseButtonDoubleClick(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
) override

function OnMouseButtonUp

Section titled “function OnMouseButtonUp”
virtual COHTMLPLUGIN_API FReply OnMouseButtonUp(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
) override

function OnMouseWheel

Section titled “function OnMouseWheel”
virtual COHTMLPLUGIN_API FReply OnMouseWheel(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent
) override

function OnTouchStarted

Section titled “function OnTouchStarted”
virtual COHTMLPLUGIN_API FReply OnTouchStarted(
    const FGeometry & MyGeometry,
    const FPointerEvent & TouchEvent
) override

function OnTouchMoved

Section titled “function OnTouchMoved”
virtual COHTMLPLUGIN_API FReply OnTouchMoved(
    const FGeometry & MyGeometry,
    const FPointerEvent & TouchEvent
) override

function OnTouchEnded

Section titled “function OnTouchEnded”
virtual COHTMLPLUGIN_API FReply OnTouchEnded(
    const FGeometry & MyGeometry,
    const FPointerEvent & TouchEvent
) override

function HandleCollectedTouchEvents

Section titled “function HandleCollectedTouchEvents”
COHTMLPLUGIN_API void HandleCollectedTouchEvents()

function OnDragDetected

Section titled “function OnDragDetected”
virtual COHTMLPLUGIN_API FReply OnDragDetected(
    const FGeometry & MyGeometry,
    const FPointerEvent & PointerEvent
) override

function OnCursorQuery

Section titled “function OnCursorQuery”
virtual COHTMLPLUGIN_API FCursorReply OnCursorQuery(
    const FGeometry & MyGeometry,
    const FPointerEvent & CursorEvent
) const override

function OnKeyDown

Section titled “function OnKeyDown”
virtual COHTMLPLUGIN_API FReply OnKeyDown(
    const FGeometry & MyGeometry,
    const FKeyEvent & KeyEvent
) override

function OnKeyUp

Section titled “function OnKeyUp”
virtual COHTMLPLUGIN_API FReply OnKeyUp(
    const FGeometry & MyGeometry,
    const FKeyEvent & KeyEvent
) override

function OnAnalogValueChanged

Section titled “function OnAnalogValueChanged”
virtual COHTMLPLUGIN_API FReply OnAnalogValueChanged(
    const FGeometry & MyGeometry,
    const FAnalogInputEvent & KeyEvent
) override

function OnKeyChar

Section titled “function OnKeyChar”
virtual COHTMLPLUGIN_API FReply OnKeyChar(
    const FGeometry & MyGeometry,
    const FCharacterEvent & InCharacterEvent
) override

function SupportsKeyboardFocus

Section titled “function SupportsKeyboardFocus”
virtual COHTMLPLUGIN_API bool SupportsKeyboardFocus() const override

function OnFocusReceived

Section titled “function OnFocusReceived”
virtual COHTMLPLUGIN_API FReply OnFocusReceived(
    const FGeometry & MyGeometry,
    const FFocusEvent & InKeyboardFocusEvent
) override

function OnFocusLost

Section titled “function OnFocusLost”
virtual COHTMLPLUGIN_API void OnFocusLost(
    const FFocusEvent & InKeyboardFocusEvent
) override

function InitViewWrapper

Section titled “function InitViewWrapper”
COHTMLPLUGIN_API void InitViewWrapper(
    TSharedPtr< cohtml::IViewListener > InViewListener,
    TSharedPtr< cohtml::ITextInputHandler > InTextInputHandler,
    TEnumAsByte< enum TextureFilter > & InFilter,
    UObject * InOwner
)

function RecreateView

Section titled “function RecreateView”
COHTMLPLUGIN_API void RecreateView(
    const cohtml::ViewSettings & Info,
    const FString & Url,
    TSharedPtr< cohtml::IViewListener > Listener,
    TSharedPtr< cohtml::ITextInputHandler > TextInputHandler,
    FCohtmlUEViewSettings & ViewSettingsUE
)

function GetView

Section titled “function GetView”
COHTMLPLUGIN_API cohtml::View * GetView()

function GetViewRenderer

Section titled “function GetViewRenderer”
COHTMLPLUGIN_API cohtml::ViewRenderer * GetViewRenderer()

function GetRenderTexture

Section titled “function GetRenderTexture”
COHTMLPLUGIN_API UTextureRenderTarget2D * GetRenderTexture() const

function GetNeedToAdvanceView

Section titled “function GetNeedToAdvanceView”
inline COHTMLPLUGIN_API bool GetNeedToAdvanceView() const

function SetNeedToAdvanceView

Section titled “function SetNeedToAdvanceView”
inline COHTMLPLUGIN_API void SetNeedToAdvanceView(
    bool InNeedToAdvanceView
)

function SchedulePaintNextFrame

Section titled “function SchedulePaintNextFrame”
COHTMLPLUGIN_API void SchedulePaintNextFrame()

function GetViewWrapper

Section titled “function GetViewWrapper”
inline FCohtmlViewWrapper * GetViewWrapper() const

function GetOwningWidget

Section titled “function GetOwningWidget”
inline TWeakObjectPtr< UObject > GetOwningWidget()

function HasRequestedView

Section titled “function HasRequestedView”
bool HasRequestedView() const

function GetFilter

Section titled “function GetFilter”
enum TextureFilter GetFilter() const

function SetFilter

Section titled “function SetFilter”
void SetFilter(
    enum TextureFilter InFilter
)

function SetReceiveInput

Section titled “function SetReceiveInput”
COHTMLPLUGIN_API void SetReceiveInput(
    bool bInReceiveInput
)

function SetInputPropagationBehaviour

Section titled “function SetInputPropagationBehaviour”
COHTMLPLUGIN_API void SetInputPropagationBehaviour(
    ECohtmlInputPropagationBehaviour::Type Behaviour
)

function SetMultiTouchEventsHandling

Section titled “function SetMultiTouchEventsHandling”
COHTMLPLUGIN_API void SetMultiTouchEventsHandling(
    ECohtmlMultiTouchEventsHandling MultiTouchHandling
)

function GetGesturePolicy

Section titled “function GetGesturePolicy”
FCohtmlGesturePolicy * GetGesturePolicy()

function PreCohtmlMouseEvent

Section titled “function PreCohtmlMouseEvent”
inline virtual void PreCohtmlMouseEvent(
    SCohtmlWidget * ,
    cohtml::View * ,
    const cohtml::MouseEventData &
)

function GetFocusedInput

Section titled “function GetFocusedInput”
cohtml::IInputProxy * GetFocusedInput()

function SetFocusedInput

Section titled “function SetFocusedInput”
void SetFocusedInput(
    cohtml::IInputProxy * Proxy
)

Protected Functions Documentation

Section titled “Protected Functions Documentation”

function CreateView

Section titled “function CreateView”
void CreateView(
    const cohtml::ViewSettings & RequestedViewSettings,
    const FString & Url
)

function HandleEventIfNeeded

Section titled “function HandleEventIfNeeded”
FORCEINLINE FReply HandleEventIfNeeded(
    const FKeyEvent & KeyEvent
)

function HandleEventIfNeeded

Section titled “function HandleEventIfNeeded”
FORCEINLINE FReply HandleEventIfNeeded(
    const FCharacterEvent & KeyEvent
)

function IsOwnerValid

Section titled “function IsOwnerValid”
inline FORCEINLINE bool IsOwnerValid()

function ProcessKeyEvent

Section titled “function ProcessKeyEvent”
void ProcessKeyEvent(
    const FInputEvent & Event,
    cohtml::KeyEventData::EventType Type
)

function OnMouseEvent

Section titled “function OnMouseEvent”
FReply OnMouseEvent(
    const FGeometry & MyGeometry,
    const FPointerEvent & MouseEvent,
    cohtml::MouseEventData::EventType EventType
)

function OnTouchEvent

Section titled “function OnTouchEvent”
FReply OnTouchEvent(
    const FGeometry & MyGeometry,
    const FPointerEvent & TouchEvent,
    cohtml::TouchEventData::EventType EventType
)

function OnViewportResized

Section titled “function OnViewportResized”
void OnViewportResized(
    FViewport * ResizedViewport,
    uint32
)

function CacheDPIScales

Section titled “function CacheDPIScales”
void CacheDPIScales()

function CacheViewportDPIScale

Section titled “function CacheViewportDPIScale”
void CacheViewportDPIScale()

function CacheWidgetWindowDPIScale

Section titled “function CacheWidgetWindowDPIScale”
void CacheWidgetWindowDPIScale()

function ForcePaintView

Section titled “function ForcePaintView”
void ForcePaintView(
    float InDeltaTime
)

Public Attributes Documentation

Section titled “Public Attributes Documentation”

variable GamepadBehaviourOnFocusLostDelegate

Section titled “variable GamepadBehaviourOnFocusLostDelegate”
FCohtmlGamepadBehaviourOnFocusLostDelegate GamepadBehaviourOnFocusLostDelegate;

variable CaretRect

Section titled “variable CaretRect”
FCohtmlCaretRect CaretRect;

variable CurrentMouseCursor

Section titled “variable CurrentMouseCursor”
EMouseCursor::Type CurrentMouseCursor;

Protected Attributes Documentation

Section titled “Protected Attributes Documentation”

variable SlateElement

Section titled “variable SlateElement”
TSharedPtr< class FCoherentSlateElement, ESPMode::ThreadSafe > SlateElement;

variable ViewWrapper

Section titled “variable ViewWrapper”
TUniquePtr< FCohtmlViewWrapper > ViewWrapper;

variable GesturePolicy

Section titled “variable GesturePolicy”
TUniquePtr< FCohtmlGesturePolicy, GesturePolicyDeleter > GesturePolicy;

variable IMEManager

Section titled “variable IMEManager”
TUniquePtr< class FCohtmlWidgetIME > IMEManager;

variable Owner

Section titled “variable Owner”
TWeakObjectPtr< UObject > Owner;

variable ViewportDPIScaledSize

Section titled “variable ViewportDPIScaledSize”
FIntPoint ViewportDPIScaledSize;

variable WidgetWindowDPIScaledSize

Section titled “variable WidgetWindowDPIScaledSize”
FIntPoint WidgetWindowDPIScaledSize;

variable Filter

Section titled “variable Filter”
TEnumAsByte< enum TextureFilter > Filter;

variable ViewportDPIScale

Section titled “variable ViewportDPIScale”
float ViewportDPIScale;

variable WidgetWindowDPIScale

Section titled “variable WidgetWindowDPIScale”
float WidgetWindowDPIScale;

variable GamepadBehaviourOnFocusLost

Section titled “variable GamepadBehaviourOnFocusLost”
ECohtmlGamepadBehaviourOnFocusLost GamepadBehaviourOnFocusLost;

variable bReceiveInput

Section titled “variable bReceiveInput”
bool bReceiveInput;

variable bNeedsTextureUpdate

Section titled “variable bNeedsTextureUpdate”
bool bNeedsTextureUpdate;

variable bViewCreationInProgress

Section titled “variable bViewCreationInProgress”
bool bViewCreationInProgress;

variable bNeedToAdvanceViewNextFrame

Section titled “variable bNeedToAdvanceViewNextFrame”
bool bNeedToAdvanceViewNextFrame;

variable LastMouseDownData

Section titled “variable LastMouseDownData”
cohtml::MouseEventData LastMouseDownData;

variable LastTouchDownData

Section titled “variable LastTouchDownData”
cohtml::TouchEventData LastTouchDownData;

variable bUnpairedMouseDown

Section titled “variable bUnpairedMouseDown”
bool bUnpairedMouseDown;

variable bUnpairedTouchDown

Section titled “variable bUnpairedTouchDown”
bool bUnpairedTouchDown;

variable bUseSurfacePartitioning

Section titled “variable bUseSurfacePartitioning”
bool bUseSurfacePartitioning;

variable ViewportResizedHandle

Section titled “variable ViewportResizedHandle”
FDelegateHandle ViewportResizedHandle;

variable InputPropagationBehaviour

Section titled “variable InputPropagationBehaviour”
TEnumAsByte< ECohtmlInputPropagationBehaviour::Type > InputPropagationBehaviour;

variable MultiTouchEventsHandling

Section titled “variable MultiTouchEventsHandling”
ECohtmlMultiTouchEventsHandling MultiTouchEventsHandling;

variable TouchEvents

Section titled “variable TouchEvents”
TArray< cohtml::TouchEventData > TouchEvents;

variable OnSlateAppPostTickHandle

Section titled “variable OnSlateAppPostTickHandle”
FDelegateHandle OnSlateAppPostTickHandle;

Friends

Section titled “Friends”

friend UCohtmlWidget

Section titled “friend UCohtmlWidget”
friend class UCohtmlWidget;

friend FCohtmlWidgetIME

Section titled “friend FCohtmlWidgetIME”
friend class FCohtmlWidgetIME;

© 2026 Coherent Labs. All rights reserved.

Privacy Policy