CGUIGeneralResourceInterpreter Class Reference

Interpreter for general resources. More...

#include <GUIGeneralResourceManager.h>

Inheritance diagram for CGUIGeneralResourceInterpreter:

Public Member Functions
virtual void	Interpret (eC_File *pkFile)=0

Detailed Description

Interpreter for general resources.

The CGUIGeneralResourceInterpreter interface should be implemented by an application developer. It is used to apply a file content interpreter to an abstract resource managed by CGUIGeneralResourceManager.

As an example we assume that we have an abstract resource file containing PDF data. Then one can create a PDF content interpreter in an application and implement this interface.

Then the resource needs to be requested via CGUIResourceManager and afterwards the interpreter can be applied. At last the resource should be released using Free operation:

GETRESMANAGER.RequestGeneralResource(ID_OF_TEST_PDF_FILE);
GETGENERALRESMANAGER.ApplyInterpreter(ID_OF_TEST_PDF_FILE, myInterpreter);
GETRESMANAGER.FreeGeneralResource(ID_OF_TEST_PDF_FILE);

Member Function Documentation

Interpret()

virtual void CGUIGeneralResourceInterpreter::Interpret ( eC_File *  pkFile )

pure virtual

Start the interpreter to parse given file pointer. The file pointer is provided just in Read-only mode!

After Interpret() has finished, pkFile pointer will be destroyed automatically.

Take care of not to destroy pkFile.

Parameters

pkFile

Valid pointer to file containing data to be parsed.

Exceptions

CGUIException

In case of an error parsing the data file.

Implemented in KeyboardLayoutInterpreter, and OnScreenKeyboardLayoutInterpreter.

---

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

• GUIGeneralResourceManager.h