platformdirs 0.1.0
📂 Python's platformdirs module for C++
Loading...
Searching...
No Matches
platformdirs::windows::windows Class Reference

#include <windows.h>

Inheritance diagram for platformdirs::windows::windows:
platformdirs::api::platform_dirs_abc

Public Member Functions

 windows (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool multipath=false, bool opinion=true, bool ensure_exists=false)
 
std::string user_data_dir () const override
 
std::string site_data_dir () const override
 
std::string user_config_dir () const override
 
std::string site_config_dir () const override
 
std::string user_cache_dir () const override
 
std::string site_cache_dir () const override
 
std::string user_state_dir () const override
 
std::string user_log_dir () const override
 
std::string user_documents_dir () const override
 
std::string user_downloads_dir () const override
 
std::string user_pictures_dir () const override
 
std::string user_videos_dir () const override
 
std::string user_music_dir () const override
 
std::string user_desktop_dir () const override
 
std::string user_runtime_dir () const override
 
std::string site_runtime_dir () const override
 
- Public Member Functions inherited from platformdirs::api::platform_dirs_abc
 platform_dirs_abc (const std::optional< std::string > &appname=std::nullopt, const std::variant< std::string, std::nullopt_t, bool > &appauthor=std::nullopt, const std::optional< std::string > &version=std::nullopt, bool roaming=false, bool multipath=false, bool opinion=true, bool ensure_exists=false)
 
virtual std::filesystem::path user_data_path () const
 
virtual std::filesystem::path site_data_path () const
 
virtual std::filesystem::path user_config_path () const
 
virtual std::filesystem::path site_config_path () const
 
virtual std::filesystem::path user_cache_path () const
 
virtual std::filesystem::path site_cache_path () const
 
virtual std::filesystem::path user_state_path () const
 
virtual std::filesystem::path user_log_path () const
 
virtual std::filesystem::path user_documents_path () const
 
virtual std::filesystem::path user_downloads_path () const
 
virtual std::filesystem::path user_pictures_path () const
 
virtual std::filesystem::path user_videos_path () const
 
virtual std::filesystem::path user_music_path () const
 
virtual std::filesystem::path user_desktop_path () const
 
virtual std::filesystem::path user_runtime_path () const
 
virtual std::filesystem::path site_runtime_path () const
 

Additional Inherited Members

- Public Attributes inherited from platformdirs::api::platform_dirs_abc
std::optional< std::string > appname
 
std::variant< std::string, std::nullopt_t, bool > appauthor
 
std::optional< std::string > version
 
bool roaming
 
bool multipath
 
bool opinion
 
bool ensure_exists
 
- Protected Member Functions inherited from platformdirs::api::platform_dirs_abc
auto append_app_name_and_version (const std::vector< std::string > &base) const -> std::string
 
auto optionally_create_directory (const std::string &path) const -> void
 

Constructor & Destructor Documentation

◆ windows()

platformdirs::windows::windows::windows ( const std::optional< std::string > & appname = std::nullopt,
const std::variant< std::string, std::nullopt_t, bool > & appauthor = std::nullopt,
const std::optional< std::string > & version = std::nullopt,
bool roaming = false,
bool multipath = false,
bool opinion = true,
bool ensure_exists = false )

Member Function Documentation

◆ site_cache_dir()

auto platformdirs::windows::windows::site_cache_dir ( ) const
overridevirtual

◆ site_config_dir()

auto platformdirs::windows::windows::site_config_dir ( ) const
overridevirtual

◆ site_data_dir()

auto platformdirs::windows::windows::site_data_dir ( ) const
overridevirtual

◆ site_runtime_dir()

auto platformdirs::windows::windows::site_runtime_dir ( ) const
overridevirtual

◆ user_cache_dir()

auto platformdirs::windows::windows::user_cache_dir ( ) const
overridevirtual

◆ user_config_dir()

auto platformdirs::windows::windows::user_config_dir ( ) const
overridevirtual

◆ user_data_dir()

auto platformdirs::windows::windows::user_data_dir ( ) const
overridevirtual

◆ user_desktop_dir()

auto platformdirs::windows::windows::user_desktop_dir ( ) const
overridevirtual

◆ user_documents_dir()

auto platformdirs::windows::windows::user_documents_dir ( ) const
overridevirtual

◆ user_downloads_dir()

auto platformdirs::windows::windows::user_downloads_dir ( ) const
overridevirtual

◆ user_log_dir()

auto platformdirs::windows::windows::user_log_dir ( ) const
overridevirtual

◆ user_music_dir()

auto platformdirs::windows::windows::user_music_dir ( ) const
overridevirtual

◆ user_pictures_dir()

auto platformdirs::windows::windows::user_pictures_dir ( ) const
overridevirtual

◆ user_runtime_dir()

auto platformdirs::windows::windows::user_runtime_dir ( ) const
overridevirtual

◆ user_state_dir()

auto platformdirs::windows::windows::user_state_dir ( ) const
overridevirtual

◆ user_videos_dir()

auto platformdirs::windows::windows::user_videos_dir ( ) const
overridevirtual

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