ScummVM API documentation
Common::WinResources Class Referenceabstract

#include <winexe.h>

Inheritance diagram for Common::WinResources:
Common::NEResources Common::PEResources

Classes

struct  VersionInfo
 

Public Types

typedef Common::HashMap< Common::String, Common::U32String, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualToVersionHash
 

Public Member Functions

virtual void clear ()=0
 
virtual bool loadFromEXE (const Path &fileName)
 
virtual bool loadFromCompressedEXE (const Path &fileName)
 
virtual bool loadFromEXE (SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle=DisposeAfterUse::YES)=0
 
virtual const Array< WinResourceIDgetIDList (const WinResourceID &type) const =0
 
virtual const Array< WinResourceIDgetLangList (const WinResourceID &type, const WinResourceID &id) const
 
virtual SeekableReadStreamgetResource (const WinResourceID &type, const WinResourceID &id)=0
 
virtual SeekableReadStreamgetResource (const WinResourceID &type, const WinResourceID &id, const WinResourceID &lang)
 
VersionInfogetVersionResource (const WinResourceID &id)
 
virtual String loadString (uint32 stringID)=0
 

Static Public Member Functions

static WinResourcescreateFromEXE (const Path &fileName)
 
static WinResourcescreateFromEXE (SeekableReadStream *stream)
 

Protected Member Functions

virtual VersionInfoparseVersionInfo (SeekableReadStream *stream)=0
 

Detailed Description

A class able to load resources from a Windows Executable, such as cursors, bitmaps, and sounds.

Member Function Documentation

◆ clear()

virtual void Common::WinResources::clear ( )
pure virtual

Clear all information.

Implemented in Common::NEResources, and Common::PEResources.

◆ loadFromEXE() [1/2]

virtual bool Common::WinResources::loadFromEXE ( const Path fileName)
virtual

Load from an EXE file.

◆ loadFromCompressedEXE()

virtual bool Common::WinResources::loadFromCompressedEXE ( const Path fileName)
virtual

Load from a Windows compressed EXE file.

◆ loadFromEXE() [2/2]

virtual bool Common::WinResources::loadFromEXE ( SeekableReadStream stream,
DisposeAfterUse::Flag  disposeFileHandle = DisposeAfterUse::YES 
)
pure virtual

Load from a stream.

Implemented in Common::NEResources, and Common::PEResources.

◆ getIDList()

virtual const Array<WinResourceID> Common::WinResources::getIDList ( const WinResourceID type) const
pure virtual

Return a list of IDs for a given type.

Implemented in Common::PEResources, and Common::NEResources.

◆ getLangList()

virtual const Array<WinResourceID> Common::WinResources::getLangList ( const WinResourceID type,
const WinResourceID id 
) const
inlinevirtual

Return a list of languages for a given type and ID.

Reimplemented in Common::PEResources.

◆ getResource() [1/2]

virtual SeekableReadStream* Common::WinResources::getResource ( const WinResourceID type,
const WinResourceID id 
)
pure virtual

Return a stream to the specified resource, taking the first language found (or 0 if non-existent).

Implemented in Common::PEResources, and Common::NEResources.

◆ getResource() [2/2]

virtual SeekableReadStream* Common::WinResources::getResource ( const WinResourceID type,
const WinResourceID id,
const WinResourceID lang 
)
inlinevirtual

Return a stream to the specified resource (or 0 if non-existent).

Reimplemented in Common::PEResources.

◆ loadString()

virtual String Common::WinResources::loadString ( uint32  stringID)
pure virtual

Get a string from a string resource.

Implemented in Common::PEResources, and Common::NEResources.


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