Linux SDK API Reference
Loading...
Searching...
No Matches
ICustomImmersiveTemplate Class Referenceabstract

Immersive template object interface. More...

#include <customized_immersive.h>

Public Member Functions

virtual const zchar_tgetTemplateName ()=0
 Get the name of this template.
 
virtual const void * getThumbnailBitmap ()=0
 Get the bitmap of the thumbnail.
 
virtual unsigned int getCapacity ()=0
 Get the capacity of this template.
 
virtual bool isTemplateReady ()=0
 Determine if this template is ready.
 
virtual bool isSupportFreeSeat ()=0
 Determine whether this template supports a free seat.
 
virtual SIZE getCanvasSize ()=0
 Get the size of this template.
 
virtual IList< SeatPlacementInfo > * getSeatList ()=0
 Get the list of template seats.
 
virtual CustomImmersiveTemplateType getType ()=0
 Get the type of this template.
 
virtual ~ICustomImmersiveTemplate ()
 

Detailed Description

Immersive template object interface.

Definition at line 46 of file customized_immersive.h.

Constructor & Destructor Documentation

◆ ~ICustomImmersiveTemplate()

virtual ICustomImmersiveTemplate::~ICustomImmersiveTemplate ( )
inlinevirtual

Definition at line 81 of file customized_immersive.h.

81{}

Member Function Documentation

◆ getCanvasSize()

virtual SIZE ICustomImmersiveTemplate::getCanvasSize ( )
pure virtual

Get the size of this template.

Returns
If the function succeeds, the return value is the size of this template.

◆ getCapacity()

virtual unsigned int ICustomImmersiveTemplate::getCapacity ( )
pure virtual

Get the capacity of this template.

Returns
If the function succeeds, the return value is the seat capacity of this template.

◆ getSeatList()

virtual IList< SeatPlacementInfo > * ICustomImmersiveTemplate::getSeatList ( )
pure virtual

Get the list of template seats.

Returns
The list of template seats. ZERO(0) indicates that there are no seats in the template.

◆ getTemplateName()

virtual const zchar_t * ICustomImmersiveTemplate::getTemplateName ( )
pure virtual

Get the name of this template.

Returns
If the function succeeds, the return value is the name of this template.

◆ getThumbnailBitmap()

virtual const void * ICustomImmersiveTemplate::getThumbnailBitmap ( )
pure virtual

Get the bitmap of the thumbnail.

Returns
If the function succeeds, the return value is the bitmap of this thumbnail.

◆ getType()

virtual CustomImmersiveTemplateType ICustomImmersiveTemplate::getType ( )
pure virtual

Get the type of this template.

Returns
If the function succeeds, the return value is the type of this template. For more details, see CustomImmersiveTemplateType enum.

◆ isSupportFreeSeat()

virtual bool ICustomImmersiveTemplate::isSupportFreeSeat ( )
pure virtual

Determine whether this template supports a free seat.

Returns
TRUE indicates that the user can be put to free seat in this template.

◆ isTemplateReady()

virtual bool ICustomImmersiveTemplate::isTemplateReady ( )
pure virtual

Determine if this template is ready.

Returns
TRUE indicates that this template is ready.