ScummVM API documentation
Classes | Public Member Functions | Protected Member Functions | List of all members
Common::PEResources Class Reference
Common API » Windows resources » Windows New Executable resources

#include <winexe_pe.h>

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

Public Member Functions

void clear () override
 
bool loadFromEXE (SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle=DisposeAfterUse::YES) override
 
const Array< WinResourceID > getIDList (const WinResourceID &type) const override
 
const Array< WinResourceID > getLangList (const WinResourceID &type, const WinResourceID &id) const override
 
SeekableReadStream * getResource (const WinResourceID &type, const WinResourceID &id) override
 
SeekableReadStream * getResource (const WinResourceID &type, const WinResourceID &id, const WinResourceID &lang) override
 
String loadString (uint32 stringID) override
 
const Array< WinResourceID > getTypeList () const
 
virtual bool loadFromEXE (const Path &fileName)
 
virtual bool loadFromEXE (SeekableReadStream *stream, DisposeAfterUse::Flag disposeFileHandle=DisposeAfterUse::YES)=0
 
- Public Member Functions inherited from Common::WinResources
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< WinResourceID > getIDList (const WinResourceID &type) const =0
 
virtual const Array< WinResourceID > getLangList (const WinResourceID &type, const WinResourceID &id) const
 
virtual SeekableReadStream * getResource (const WinResourceID &type, const WinResourceID &id)=0
 
virtual SeekableReadStream * getResource (const WinResourceID &type, const WinResourceID &id, const WinResourceID &lang)
 
VersionInfo * getVersionResource (const WinResourceID &id)
 
virtual String loadString (uint32 stringID)=0
 

Protected Member Functions

VersionInfo * parseVersionInfo (SeekableReadStream *stream) override
 
virtual VersionInfo * parseVersionInfo (SeekableReadStream *stream)=0
 

Additional Inherited Members

- Public Types inherited from Common::WinResources
typedef Common::HashMap< Common::String, Common::U32String, Common::IgnoreCase_Hash, Common::IgnoreCase_EqualTo > VersionHash
 
- Static Public Member Functions inherited from Common::WinResources
static WinResources * createFromEXE (const Path &fileName)
 
static WinResources * createFromEXE (SeekableReadStream *stream)
 

Detailed Description

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

Member Function Documentation

◆ clear()

void Common::PEResources::clear ( )
overridevirtual

Clear all information.

Implements Common::WinResources.

◆ loadFromEXE() [1/3]

bool Common::PEResources::loadFromEXE ( SeekableReadStream *  stream,
DisposeAfterUse::Flag  disposeFileHandle = DisposeAfterUse::YES 
)
overridevirtual

Load from a stream.

Implements Common::WinResources.

◆ getIDList()

const Array< WinResourceID > Common::PEResources::getIDList ( const WinResourceID &  type) const
overridevirtual

Return a list of IDs for a given type.

Implements Common::WinResources.

◆ getLangList()

const Array< WinResourceID > Common::PEResources::getLangList ( const WinResourceID &  type,
const WinResourceID &  id 
) const
overridevirtual

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

Reimplemented from Common::WinResources.

◆ getResource() [1/2]

SeekableReadStream * Common::PEResources::getResource ( const WinResourceID &  type,
const WinResourceID &  id 
)
overridevirtual

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

Implements Common::WinResources.

◆ getResource() [2/2]

SeekableReadStream * Common::PEResources::getResource ( const WinResourceID &  type,
const WinResourceID &  id,
const WinResourceID &  lang 
)
overridevirtual

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

Reimplemented from Common::WinResources.

◆ loadString()

String Common::PEResources::loadString ( uint32  stringID)
overridevirtual

Get a string from a string resource.

Implements Common::WinResources.

◆ getTypeList()

const Array< WinResourceID > Common::PEResources::getTypeList ( ) const

Return a list of resource types.

◆ parseVersionInfo()

VersionInfo * Common::PEResources::parseVersionInfo ( SeekableReadStream *  stream)
overrideprotectedvirtual

Implements Common::WinResources.

◆ loadFromEXE() [2/3]

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

Load from an EXE file.

Reimplemented from Common::WinResources.

◆ loadFromEXE() [3/3]

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

Load from an EXE file.

Implements Common::WinResources.

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