ResidualVM logo ResidualVM website - Forums - Contact us BuildBot - Doxygen - Wiki curved edge

OSystem_Win32 Class Reference

#include <win32.h>

Inheritance diagram for OSystem_Win32:
Collaboration diagram for OSystem_Win32:

List of all members.

Public Member Functions

virtual void init ()
 Pre-initialize backend.
virtual void initBackend ()
 The following method is called once, from main.cpp, after all config data (including command line params etc.
virtual void addSysArchivesToSearchSet (Common::SearchSet &s, int priority=0)
 Add system specific Common::Archive objects to the given SearchSet.
virtual bool hasFeature (Feature f)
 Determine whether the backend supports the specified feature.
virtual bool displayLogFile ()
 Open the log file in a way that allows the user to review it, and possibly email it (or parts of it) to the ScummVM team, e.g.
virtual bool openUrl (const Common::String &url)
 Open the given Url in the default browser (if available on the target system).
virtual void logMessage (LogMessageType::Type type, const char *message)
 Logs a given message.
virtual Common::String getSystemLanguage () const
 Returns the locale of the system.
virtual Common::String getScreenshotsPath ()

Protected Member Functions

virtual Common::String getDefaultConfigFileName ()
 Get the default file name (or even path) where the user configuration of ScummVM will be saved.
virtual Common::String getDefaultLogFileName ()
virtual AudioCDManagercreateAudioCDManager ()
 Create the audio CD manager.
HWND getHwnd ()
virtual char * convertEncoding (const char *to, const char *from, const char *string, size_t length)
 This allows derived classes to implement encoding conversion using platform specific API.

Detailed Description

Definition at line 29 of file win32.h.


Member Function Documentation

virtual void OSystem_Win32::addSysArchivesToSearchSet ( Common::SearchSet s,
int  priority = 0 
) [virtual]

Add system specific Common::Archive objects to the given SearchSet.

E.g. on Unix the dir corresponding to DATA_PATH (if set), or on Mac OS X the 'Resource' dir in the app bundle.

Todo:
Come up with a better name. This one sucks.
Parameters:
s the SearchSet to which the system specific dirs, if any, are added
priority the priority with which those dirs are added

Reimplemented from OSystem_SDL.

virtual char* OSystem_Win32::convertEncoding ( const char *  to,
const char *  from,
const char *  string,
size_t  length 
) [protected, virtual]

This allows derived classes to implement encoding conversion using platform specific API.

This method shouldn't be called directly. Use Common::Encoding instead.

Parameters:
to Encoding to convert the string to
from Encoding to convert the string from
string The string that should be converted
length Size of the string in bytes
Returns:
Converted string, which must be freed by the caller (using free() and not delete[]), or nullptr if the conversion isn't possible.

Reimplemented from OSystem_SDL.

virtual AudioCDManager* OSystem_Win32::createAudioCDManager (  )  [protected, virtual]

Create the audio CD manager.

Reimplemented from OSystem_SDL.

virtual bool OSystem_Win32::displayLogFile (  )  [virtual]

Open the log file in a way that allows the user to review it, and possibly email it (or parts of it) to the ScummVM team, e.g.

as part of a bug report.

On a desktop operating system, this would typically launch some kind of (external) text editor / viewer. On a phone, it might also cause a context switch to another application. Finally, on some ports, it might not be supported at all, and so do nothing.

The kFeatureDisplayLogFile feature flag can be used to test whether this call has been implemented by the active backend.

Returns:
true if all seems to have gone fine, false if an error occurred
Note:
An error could mean that the log file did not exist, or the editor could not launch. However, a return value of true does not guarantee that the user actually will see the log file.
It is up to the backend to ensure that the system is in a state that allows the user to actually see the displayed log files. This might for example require leaving fullscreen mode.

Reimplemented from OSystem.

virtual Common::String OSystem_Win32::getDefaultConfigFileName (  )  [protected, virtual]

Get the default file name (or even path) where the user configuration of ScummVM will be saved.

Note that not all ports may use this.

Reimplemented from OSystem.

virtual Common::String OSystem_Win32::getDefaultLogFileName (  )  [protected, virtual]

Reimplemented from OSystem_SDL.

HWND OSystem_Win32::getHwnd (  )  [inline, protected]

Definition at line 56 of file win32.h.

virtual Common::String OSystem_Win32::getScreenshotsPath (  )  [virtual]

Reimplemented from OSystem_SDL.

virtual Common::String OSystem_Win32::getSystemLanguage (  )  const [virtual]

Returns the locale of the system.

This returns the currently set up locale of the system, on which ScummVM is run.

The format of the locale is language_country. These should match the POSIX locale values.

For information about POSIX locales read here: http://en.wikipedia.org/wiki/Locale#POSIX-type_platforms

The default implementation returns "en_US".

Returns:
locale of the system

Reimplemented from OSystem_SDL.

virtual bool OSystem_Win32::hasFeature ( Feature  f  )  [virtual]

Determine whether the backend supports the specified feature.

Reimplemented from OSystem_SDL.

virtual void OSystem_Win32::init (  )  [virtual]

Pre-initialize backend.

It should be called after instantiating the backend. Early needed managers are created here.

Reimplemented from OSystem_SDL.

virtual void OSystem_Win32::initBackend (  )  [virtual]

The following method is called once, from main.cpp, after all config data (including command line params etc.

) are fully loaded.

Note:
Subclasses should always invoke the implementation of their parent class. They should do so near the end of their own implementation.

Reimplemented from OSystem_SDL.

virtual void OSystem_Win32::logMessage ( LogMessageType::Type  type,
const char *  message 
) [virtual]

Logs a given message.

It is up to the backend where to log the different messages. The backend should aim at using a non-buffered output for it so that no log data is lost in case of a crash.

The default implementation outputs them on stdout/stderr.

Parameters:
type the type of the message
message the message itself

Reimplemented from OSystem_SDL.

virtual bool OSystem_Win32::openUrl ( const Common::String url  )  [virtual]

Open the given Url in the default browser (if available on the target system).

Returns:
true on success, false otherwise.
Note:
It is up to the backend to ensure that the system is in a state that allows the user to actually see the web page. This might for example require leaving fullscreen mode.

url the URL to open

Reimplemented from OSystem.


The documentation for this class was generated from the following file:
  • backends/platform/sdl/win32/win32.h


Generated on Sat Jul 4 2020 05:02:59 for ResidualVM by doxygen 1.7.1
curved edge   curved edge