Public Member Functions |
| FileSystem (Context *context) |
| Construct.
|
| ~FileSystem () |
| Destruct.
|
bool | SetCurrentDir (const String &pathName) |
| Set the current working directory.
|
bool | CreateDir (const String &pathName) |
| Create a directory.
|
int | SystemCommand (const String &commandLine) |
| Run a program using the command interpreter, block until it exits and return the exit code. Will fail if any allowed paths are defined.
|
int | SystemRun (const String &fileName, const Vector< String > &arguments) |
| Run a specific program, block until it exits and return the exit code. Will fail if any allowed paths are defined.
|
bool | SystemOpen (const String &fileName, const String &mode=String()) |
| Open a file in an external program, with mode such as "edit" optionally specified. Will fail if any allowed paths are defined.
|
bool | Copy (const String &srcFileName, const String &destFileName) |
| Copy a file. Return true if successful.
|
bool | Rename (const String &srcFileName, const String &destFileName) |
| Rename a file. Return true if successful.
|
bool | Delete (const String &fileName) |
| Delete a file. Return true if successful.
|
void | RegisterPath (const String &pathName) |
| Register a path as allowed to access. If no paths are registered, all are allowed.
|
String | GetCurrentDir () const |
| Return the absolute current working directory.
|
bool | HasRegisteredPaths () const |
| Return whether paths have been registered.
|
bool | CheckAccess (const String &pathName) const |
| Check if a path is allowed to be accessed. If no paths are registered, all are allowed.
|
unsigned | GetLastModifiedTime (const String &fileName) const |
| Returns the file's last modified time as seconds since 1.1.1970, or 0 if can not be accessed.
|
bool | FileExists (const String &fileName) const |
| Check if a file exists.
|
bool | DirExists (const String &pathName) const |
| Check if a directory exists.
|
void | ScanDir (Vector< String > &result, const String &pathName, const String &filter, unsigned flags, bool recursive) const |
| Scan a directory for specified files.
|
String | GetProgramDir () const |
| Return the program's directory.
|
String | GetUserDocumentsDir () const |
| Return the user documents directory.
|
| Object (Context *context) |
| Construct.
|
virtual | ~Object () |
| Destruct. Clean up self from event sender & receiver structures.
|
virtual ShortStringHash | GetType () const =0 |
| Return type hash.
|
virtual const String & | GetTypeName () const =0 |
| Return type name.
|
virtual void | OnEvent (Object *sender, StringHash eventType, VariantMap &eventData) |
| Handle event.
|
void | SubscribeToEvent (StringHash eventType, EventHandler *handler) |
| Subscribe to an event that can be sent by any sender.
|
void | SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler) |
| Subscribe to a specific sender's event.
|
void | UnsubscribeFromEvent (StringHash eventType) |
| Unsubscribe from an event.
|
void | UnsubscribeFromEvent (Object *sender, StringHash eventType) |
| Unsubscribe from a specific sender's event.
|
void | UnsubscribeFromEvents (Object *sender) |
| Unsubscribe from a specific sender's events.
|
void | UnsubscribeFromAllEvents () |
| Unsubscribe from all events.
|
void | UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData) |
| Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
|
void | SendEvent (StringHash eventType) |
| Send event to all subscribers.
|
void | SendEvent (StringHash eventType, VariantMap &eventData) |
| Send event with parameters to all subscribers.
|
Context * | GetContext () const |
| Return execution context.
|
Object * | GetSubsystem (ShortStringHash type) const |
| Return subsystem by type.
|
Object * | GetEventSender () const |
| Return active event sender. Null outside event handling.
|
EventHandler * | GetEventHandler () const |
| Return active event handler. Null outside event handling.
|
bool | HasSubscribedToEvent (StringHash eventType) const |
| Return whether has subscribed to an event without specific sender.
|
bool | HasSubscribedToEvent (Object *sender, StringHash eventType) const |
| Return whether has subscribed to a specific sender's event.
|
template<class T > |
T * | GetSubsystem () const |
| Template version of returning a subsystem.
|
| RefCounted () |
| Construct. Allocate the reference count structure and set an initial self weak reference.
|
virtual | ~RefCounted () |
| Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
|
void | AddRef () |
| Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
|
void | ReleaseRef () |
| Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
|
int | Refs () const |
| Return reference count.
|
int | WeakRefs () const |
| Return weak reference count.
|
RefCount * | RefCountPtr () |
| Return pointer to the reference count structure.
|
Subsystem for file and directory operations and access control.