KiCad PCB EDA Suite
Loading...
Searching...
No Matches
STRING_UTF8_MAP Class Reference

A name/value tuple with unique names and optional values. More...

#include <string_utf8_map.h>

Inheritance diagram for STRING_UTF8_MAP:

Public Member Functions

bool Clear (const std::string &aProperty)
 
bool Exists (const std::string &aProperty) const
 
bool Value (const char *aName, UTF8 *aFetchedValue=nullptr) const
 Fetch a property by aName and returns true if that property was found, else false.
 

Public Attributes

keys
 STL member.
 
elements
 STL member.
 

Detailed Description

A name/value tuple with unique names and optional values.

The names may be iterated alphabetically.

Definition at line 33 of file string_utf8_map.h.

Member Function Documentation

◆ Clear()

bool STRING_UTF8_MAP::Clear ( const std::string &  aProperty)
inline

Definition at line 36 of file string_utf8_map.h.

◆ Exists()

bool STRING_UTF8_MAP::Exists ( const std::string &  aProperty) const
inline

◆ Value()

bool STRING_UTF8_MAP::Value ( const char *  aName,
UTF8 aFetchedValue = nullptr 
) const

Fetch a property by aName and returns true if that property was found, else false.

If not found, aFetchedValue is not touched.

Parameters
aNameis the property or option to look for.
aFetchedValueis where to put the value of the property if it exists and aFetchedValue is not NULL.
Returns
true if property is found, else false.

Definition at line 24 of file string_utf8_map.cpp.

References find.

Referenced by PCB_IO_CADSTAR_ARCHIVE::LoadBoard(), and DIALOG_PLUGIN_OPTIONS::onListBoxItemSelected().

Member Data Documentation

◆ elements

T std::map< K, T >::elements
inherited

STL member.

◆ keys

K std::map< K, T >::keys
inherited

STL member.


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