libnick 2024.12.0
A cross-platform base for native Nickvision applications.
Loading...
Searching...
No Matches
Nickvision::Filesystem Namespace Reference

Namespaces

namespace  UserDirectories
 

Classes

class  FileSystemChangedEventArgs
 An event argument for when a file system object is changed. More...
 
class  FileSystemWatcher
 A watcher of a file system folder. More...
 

Enumerations

enum class  ApplicationUserDirectory { Config , Cache , LocalData }
 Supported application user directories. More...
 
enum class  FileAction { Added = 1 , Removed , Modified , Renamed }
 Actions that cause a file system object to change. More...
 
enum class  UserDirectory {
  Home , Config , Cache , LocalData ,
  Desktop , Documents , Downloads , Music ,
  Pictures , Templates , Videos
}
 Supported user directories. More...
 
enum class  WatcherFlags {
  FileName = 1 , DirectoryName = 2 , Attributes = 4 , Size = 8 ,
  LastWrite = 16 , LastAccess = 32
}
 Flags to describe properties of a file system object that can change.
More...
 

Functions

constexpr WatcherFlags operator~ (WatcherFlags a)
 
constexpr WatcherFlags operator| (WatcherFlags a, WatcherFlags b)
 
constexpr WatcherFlags operator& (WatcherFlags a, WatcherFlags b)
 
constexpr WatcherFlags operator^ (WatcherFlags a, WatcherFlags b)
 
WatcherFlagsoperator|= (WatcherFlags &a, WatcherFlags b)
 
WatcherFlagsoperator&= (WatcherFlags &a, WatcherFlags b)
 
WatcherFlagsoperator^= (WatcherFlags &a, WatcherFlags b)
 

Enumeration Type Documentation

◆ ApplicationUserDirectory

Supported application user directories.

Enumerator
Config 

The application configuration directory.

Cache 

The application cache directory.

LocalData 

The application local data directory.

◆ FileAction

Actions that cause a file system object to change.

Enumerator
Added 

A file was added to the file system object.

Removed 

A file was removed from the file system object.

Modified 

A file was modified in the file system object.

Renamed 

A file was renamed in the file system object.

◆ UserDirectory

Supported user directories.

Enumerator
Home 

The home directory.

Config 

The configuration directory.

Cache 

The cache directory.

LocalData 

The local data directory.

Desktop 

The desktop directory.

Documents 

The documents directory.

Downloads 

The downloads directory.

Music 

The music directory.

Pictures 

The pictures directory.

Templates 

The templates directory.

Videos 

The videos directory.

◆ WatcherFlags

Flags to describe properties of a file system object that can change.

Enumerator
FileName 

The name of a file in the file system object has changed.

DirectoryName 

The name of a directory in the file system object has changed.

Attributes 

The attributes of an item in the file system object have changed.

Size 

The size of an item in the file system object has changed.

LastWrite 

The last write time of an item in the file system object has changed.

LastAccess 

The last access time of an item in the file system object has changed.

Function Documentation

◆ operator&()

WatcherFlags Nickvision::Filesystem::operator& ( WatcherFlags a,
WatcherFlags b )
constexpr

◆ operator&=()

WatcherFlags & Nickvision::Filesystem::operator&= ( WatcherFlags & a,
WatcherFlags b )
inline

◆ operator^()

WatcherFlags Nickvision::Filesystem::operator^ ( WatcherFlags a,
WatcherFlags b )
constexpr

◆ operator^=()

WatcherFlags & Nickvision::Filesystem::operator^= ( WatcherFlags & a,
WatcherFlags b )
inline

◆ operator|()

WatcherFlags Nickvision::Filesystem::operator| ( WatcherFlags a,
WatcherFlags b )
constexpr

◆ operator|=()

WatcherFlags & Nickvision::Filesystem::operator|= ( WatcherFlags & a,
WatcherFlags b )
inline

◆ operator~()

WatcherFlags Nickvision::Filesystem::operator~ ( WatcherFlags a)
constexpr