xtd - Reference Guide  0.1.0
Modern c++17 framework to create console, gui and unit test applications on Windows, macOS and Linux.
Classes | Public Member Functions | Protected Member Functions | List of all members
xtd::forms::settings Class Reference

Represent settings associate to the application. More...

#include <settings.h>

Inheritance diagram for xtd::forms::settings:
xtd::forms::component

Public Member Functions

std::string read (const std::string &key, const std::string &default_value)
 
template<typename type_t >
type_t read (const std::string &key, const type_t &default_value)
 
void reset ()
 
void save ()
 
void write (const std::string &key, const std::string &value)
 
template<typename type_t >
void write (const std::string &key, type_t &&value)
 

Protected Member Functions

virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Detailed Description

Represent settings associate to the application.

Remarks
On Windows settings are stored in registry with '"HKEY_CURRENT_USER\Software\Company Name\Product Name" key or if no Comapny name "\HKEY_CURRENT_USER\Software\Product Name\Product Name" key.
On macos settings are stored in '~/Library/Preferences/Product Name Preferences" file. @remarks On linux settings are stored in '~/.Product Name" file.
The documentation for this class was generated from the following file: