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

OSystem_MacOSX Class Reference

#include <macosx.h>

Inheritance diagram for OSystem_MacOSX:
Collaboration diagram for OSystem_MacOSX:

List of all members.

Public Member Functions

 OSystem_MacOSX ()
 ~OSystem_MacOSX ()
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 hasTextInClipboard ()
 Returns whether there is text available in the clipboard.
virtual Common::String getTextFromClipboard ()
 Returns clipboard contents as a String.
virtual bool setTextInClipboard (const Common::String &text)
 Set the content of the clipboard to the given string.
virtual bool openUrl (const Common::String &url)
 Open the given Url in the default browser (if available on the target system).
virtual Common::String getSystemLanguage () const
 Returns the locale of the system.
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 Common::String getScreenshotsPath ()

Protected Member Functions

virtual AudioCDManagercreateAudioCDManager ()
 Create the audio CD manager.

Detailed Description

Definition at line 28 of file macosx.h.


Constructor & Destructor Documentation

OSystem_MacOSX::OSystem_MacOSX (  ) 
OSystem_MacOSX::~OSystem_MacOSX (  ) 

Member Function Documentation

virtual void OSystem_MacOSX::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_POSIX.

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

Create the audio CD manager.

Reimplemented from OSystem_POSIX.

virtual bool OSystem_MacOSX::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_POSIX.

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

Reimplemented from OSystem_POSIX.

virtual Common::String OSystem_MacOSX::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 Common::String OSystem_MacOSX::getTextFromClipboard (  )  [virtual]

Returns clipboard contents as a String.

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

Returns:
clipboard contents ("" if hasTextInClipboard() == false)

Reimplemented from OSystem_SDL.

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

Determine whether the backend supports the specified feature.

Reimplemented from OSystem_POSIX.

virtual bool OSystem_MacOSX::hasTextInClipboard (  )  [virtual]

Returns whether there is text available in the clipboard.

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

Returns:
true if there is text in the clipboard, false otherwise

Reimplemented from OSystem_SDL.

virtual void OSystem_MacOSX::init (  )  [virtual]

Pre-initialize backend.

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

Reimplemented from OSystem_POSIX.

virtual void OSystem_MacOSX::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_POSIX.

virtual bool OSystem_MacOSX::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_POSIX.

virtual bool OSystem_MacOSX::setTextInClipboard ( const Common::String text  )  [virtual]

Set the content of the clipboard to the given string.

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

Returns:
true if the text was properly set in the clipboard, false otherwise

Reimplemented from OSystem_SDL.


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


Generated on Sat Jul 13 2019 05:02:54 for ResidualVM by doxygen 1.7.1
curved edge   curved edge