Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::state::ApplicationProperties Class Reference

Application-level properties with platform-standard paths. More...

#include <properties_file.hpp>

Public Member Functions

 ApplicationProperties (std::string_view app_name)
 Initialize with application name (determines storage path).
PropertiesFile & user_settings ()
 User-specific settings (e.g., ~/Library/Preferences/AppName.json on macOS).
const PropertiesFile & user_settings () const
PropertiesFile & common_settings ()
 Common/shared settings (e.g., /Library/Application Support/AppName/settings.json).
const PropertiesFile & common_settings () const
void load ()
 Load both user and common settings from their platform paths.
void save ()
 Save both settings files.
const std::string & app_name () const
 Application name.

Static Public Member Functions

static std::string user_settings_dir (std::string_view app_name)
 Platform-specific user settings directory.
static std::string common_settings_dir (std::string_view app_name)
 Platform-specific common settings directory.

Detailed Description

Application-level properties with platform-standard paths.

Provides user-specific and shared settings.

Constructor & Destructor Documentation

◆ ApplicationProperties()

pulp::state::ApplicationProperties::ApplicationProperties ( std::string_view app_name)
explicit

Initialize with application name (determines storage path).

Member Function Documentation

◆ app_name()

const std::string & pulp::state::ApplicationProperties::app_name ( ) const
inline

Application name.

◆ common_settings() [1/2]

PropertiesFile & pulp::state::ApplicationProperties::common_settings ( )
inline

Common/shared settings (e.g., /Library/Application Support/AppName/settings.json).

◆ common_settings() [2/2]

const PropertiesFile & pulp::state::ApplicationProperties::common_settings ( ) const
inline

◆ common_settings_dir()

std::string pulp::state::ApplicationProperties::common_settings_dir ( std::string_view app_name)
static

Platform-specific common settings directory.

◆ load()

void pulp::state::ApplicationProperties::load ( )

Load both user and common settings from their platform paths.

◆ save()

void pulp::state::ApplicationProperties::save ( )

Save both settings files.

◆ user_settings() [1/2]

PropertiesFile & pulp::state::ApplicationProperties::user_settings ( )
inline

User-specific settings (e.g., ~/Library/Preferences/AppName.json on macOS).

◆ user_settings() [2/2]

const PropertiesFile & pulp::state::ApplicationProperties::user_settings ( ) const
inline

◆ user_settings_dir()

std::string pulp::state::ApplicationProperties::user_settings_dir ( std::string_view app_name)
static

Platform-specific user settings directory.


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