MapLibre Native Core
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
mbgl::platform::Settings Class Referencefinal

Settings class provides non-persistent, in-process key-value storage. More...

#include <settings.hpp>

Public Member Functions

void set (const std::string &key, mapbox::base::Value value) noexcept
 Sets setting value for a specified key. More...
 
void set (const mapbox::base::ValueObject &values) noexcept
 
mapbox::base::Value get (const std::string &key) const noexcept
 
mapbox::base::ValueObject get (const std::vector< std::string > &keys) const noexcept
 

Static Public Member Functions

static SettingsgetInstance () noexcept
 Returns singleton instance. More...
 

Detailed Description

Settings class provides non-persistent, in-process key-value storage.

Definition at line 19 of file settings.hpp.

Member Function Documentation

◆ get() [1/2]

mapbox::base::Value mbgl::platform::Settings::get ( const std::string &  key) const
noexcept

Returns setting value for a specified key or NullValue if element for specified key is missing.

◆ get() [2/2]

mapbox::base::ValueObject mbgl::platform::Settings::get ( const std::vector< std::string > &  keys) const
noexcept

Returns values for settings whose keys are equal to the ones provided in keys argument. Null values would be provided for keys whose elements are missing in Settings.

◆ getInstance()

static Settings& mbgl::platform::Settings::getInstance ( )
staticnoexcept

Returns singleton instance.

◆ set() [1/2]

void mbgl::platform::Settings::set ( const mapbox::base::ValueObject &  values)
noexcept

Sets multiple setting values by merging current Settings object with provided values object.

◆ set() [2/2]

void mbgl::platform::Settings::set ( const std::string &  key,
mapbox::base::Value  value 
)
noexcept

Sets setting value for a specified key.


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