gKeyMapper/src/mappings.h

// gKeyMapper - GUI glue between the mappings file and the row widgets.
#ifndef GKEYMAPPER_MAPPINGS_H
#define GKEYMAPPER_MAPPINGS_H

#include <string>
#include <vector>

#include "keyrow.h"
#include "mapping.h"

namespace gkeymapper {

// The rows' current state, or a file's content put into the rows. Both are also
// what write/read use, so the widget <-> file mapping lives in one place; and a
// window that is rebuilt (language switch) carries the rows over this way
// without writing a file, so unsaved edits survive.
MappingSet collect_mappings(const std::vector<KeyRow>& rows);
void apply_mappings(const MappingSet& set, const std::vector<KeyRow>& rows);

// The same round trip as text (the mappings file format), for rows that have to
// leave the process: the window that replaces a running instance is given them by
// it (see src/singleinstance), so edits that were never saved survive a second
// start as well.
std::string mappings_text(const std::vector<KeyRow>& rows);
void apply_mappings_text(const std::string& text, const std::vector<KeyRow>& rows);

// Collects the current widget state and writes it to path.
bool write_mappings(const std::string& path, const std::vector<KeyRow>& rows);

// Loads path into the rows' widgets (type dropdown + target entry).
void read_mappings(const std::string& path, const std::vector<KeyRow>& rows);

} // namespace gkeymapper

#endif // GKEYMAPPER_MAPPINGS_H