Kodi Documentation 22.0
Kodi is an open source media player and entertainment hub.
Loading...
Searching...
No Matches
XBMCAddon::xbmcgui::InterceptorBase Class Referenceabstract

#include <WindowInterceptor.h>

Inheritance diagram for XBMCAddon::xbmcgui::InterceptorBase:
XBMCAddon::xbmcgui::Interceptor< CGUIMediaWindow > XBMCAddon::xbmcgui::Interceptor< P > XBMCAddon::xbmcgui::ProxyExistingWindowInterceptor XBMCAddon::xbmcgui::InterceptorDialog< CGUIMediaWindow > XBMCAddon::xbmcgui::InterceptorDialog< P > XBMCAddon::xbmcgui::WindowXMLInterceptor

Public Member Functions

virtual ~InterceptorBase ()
 
virtual CGUIWindowget ()=0
 
virtual void SetRenderOrder (int renderOrder)
 
virtual void setActive (bool active)
 
virtual bool isActive ()
 

Protected Member Functions

 InterceptorBase ()
 

Static Protected Member Functions

static bool up ()
 

Protected Attributes

AddonClass::Ref< Windowwindow
 

Static Protected Attributes

static thread_local refupcallTls
 

Friends

class ref
 

Detailed Description

These two classes are closely associated with the Interceptor template below. For more detailed explanation, see that class.

Constructor & Destructor Documentation

◆ InterceptorBase()

XBMCAddon::xbmcgui::InterceptorBase::InterceptorBase ( )
inlineprotected

◆ ~InterceptorBase()

virtual XBMCAddon::xbmcgui::InterceptorBase::~InterceptorBase ( )
inlinevirtual

Member Function Documentation

◆ get()

◆ isActive()

virtual bool XBMCAddon::xbmcgui::InterceptorBase::isActive ( )
inlinevirtual

◆ setActive()

virtual void XBMCAddon::xbmcgui::InterceptorBase::setActive ( bool active)
inlinevirtual

◆ SetRenderOrder()

virtual void XBMCAddon::xbmcgui::InterceptorBase::SetRenderOrder ( int renderOrder)
inlinevirtual

◆ up()

static bool XBMCAddon::xbmcgui::InterceptorBase::up ( )
inlinestaticprotected

Calling up ONCE resets the upcall to to false. The reason is that when a call is recursive we cannot assume the ref has cleared the flag. so ...

ref(window)->UpCall()

during the context of 'UpCall' it's possible that another call will be made back on the window from the xbmc core side (this happens in sometimes in OnMessage). In that case, if upcall is still 'true', than the call will wrongly proceed back to the xbmc core side rather than to the Addon API side.

Friends And Related Symbol Documentation

◆ ref

friend class ref
friend

Member Data Documentation

◆ upcallTls

thread_local ref * XBMCAddon::xbmcgui::InterceptorBase::upcallTls
staticprotected

◆ window

AddonClass::Ref<Window> XBMCAddon::xbmcgui::InterceptorBase::window
protected

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