2.8.6
Coherent GT
A modern user interface library for games
Coherent::UIGT::ResourceHandler Class Referenceabstract

Provides a way for the client application to read the resources required by the UI system. More...

#include <Coherent/Coherent/UIGT/ResourceHandler.h>

Public Member Functions

virtual void OnResourceRead (const ResourceRequestUIGT *request, Coherent::UIGT::ResourceResponseUIGT *response)=0
 Called when the UI system needs to read a resource. More...
 
virtual void OnShouldLoadResourceRequest (const Coherent::UIGT::ResourceRequestUIGT *request, Coherent::UIGT::LoadResourceResponseUIGT *response)
 Allows you to intercept specific resources If the client doesn't override this method, the default response will be to load every request. LoadResourceResponseUIGT::SignalContinueLoadResourceResponse will pass the resource LoadResourceResponseUIGT::SignalCancelLoadResourceResponse will stop loading the resource. More...
 
virtual void OnModifyHeaders (Coherent::UIGT::ResourceRequestUIGT *request)
 Allows you to modify a specific header You can set or add a header using ResourceRequestUIGT::SetHeader You can remove a header using ResourceRequestUIGT::RemoveHeader. More...
 

Detailed Description

Provides a way for the client application to read the resources required by the UI system.

Member Function Documentation

◆ OnModifyHeaders()

virtual void Coherent::UIGT::ResourceHandler::OnModifyHeaders ( Coherent::UIGT::ResourceRequestUIGT request)
inlinevirtual

Allows you to modify a specific header You can set or add a header using ResourceRequestUIGT::SetHeader You can remove a header using ResourceRequestUIGT::RemoveHeader.

Parameters
requestThe request object providing the URL and header data

◆ OnResourceRead()

virtual void Coherent::UIGT::ResourceHandler::OnResourceRead ( const ResourceRequestUIGT request,
Coherent::UIGT::ResourceResponseUIGT response 
)
pure virtual

Called when the UI system needs to read a resource.

Parameters
requestThe request object providing the URL and header data
responsea special response object used to fill the data and signal completion or error for the load

◆ OnShouldLoadResourceRequest()

virtual void Coherent::UIGT::ResourceHandler::OnShouldLoadResourceRequest ( const Coherent::UIGT::ResourceRequestUIGT request,
Coherent::UIGT::LoadResourceResponseUIGT response 
)
inlinevirtual

Allows you to intercept specific resources If the client doesn't override this method, the default response will be to load every request. LoadResourceResponseUIGT::SignalContinueLoadResourceResponse will pass the resource LoadResourceResponseUIGT::SignalCancelLoadResourceResponse will stop loading the resource.

Parameters
requestThe request object providing the URL and header data
responsea special response object used to determine how to handle the result