Devel:CoreLibs:CoreIni

Материал из Core-X! IRC Bot Kernel, Plugin, Client!

Содержание 1 Класс CoreIni 1.1 Слоты, предоставляемые классом CoreIni 1.1.1 Загрузка ini файла (Load) 1.1.2 Сохранение данных в ini файл (Save) 1.1.3 Сохранение всех файлов (SaveAll) 1.1.4 Закрытие ini файла (Unload) 1.1.5 Закрытие всех файлов (UnloadAll) 1.1.6 Запрос списка загруженных файлов (GetFileList) 1.1.7 Проверка открытия файла (isOpen) 1.1.8 Запрос списка секций (GetSectionList) 1.1.9 Переименование секции (RenameSection) 1.1.10 Копирование секции (CopySection) 1.1.11 Удаление секции (DelSection) 1.1.12 Запрос списка параметров в секции (GetParamList) 1.1.13 Запрос значения параметра (GetValue) 1.1.14 Установка значения параметра (SetValue) 1.1.15 Удаление параметра (DelParam) 1.2 Сигналы, предоставляемые классом CoreIni 1.2.1 Сигнал загрузки файла (IniFileLoaded) 1.2.2 Сигнал сохранения файла (IniFileSaved) 1.2.3 Сигнал сохранения всех файлов (AllIniFilesSaved) 1.2.4 Сигнал выгрузки файла (IniFileUnloaded) 1.2.5 Сигнал выгрузки всех файлов (AllIniFilesUnloaded) 1.3 Взаимодействие с другими классами

Класс CoreIni

Класс CoreIni предназначен для работы с конфигурационными файлами.

Данный класс является наследником класса QObject и имеет имя "CoreIni".

Слоты, предоставляемые классом CoreIni

Слоты, предоставляемые классом CoreIni:

1. Загрузка ini файла (Load);
2. Сохранение данных в ini файл (Save);
3. Сохранение всех файлов (SaveAll);
4. Закрытие ini файла (Unload);
5. Закрытие всех файлов (UnloadAll);
6. Запрос списка загруженных файлов (GetFileList);
7. Проверка открытия файла (isOpen);
8. Запрос списка секций (GetSectionList);
9. Переименование секции (RenameSection);
10. Копирование секции (CopySection);
11. Удаление секции (DelSection);
12. Запрос списка параметров в секции (GetParamList);
13. Запрос значения параметра (GetValue);
14. Установка значения параметра (SetValue);
15. Удаление параметра (DelParam).

Загрузка ini файла (Load)

Слот Load предназначен для открытия ini файла и загрузки содержимого файла во внутренний массив класса.

Описание:

void Load(const QString& file, int& res);
void Load(const QString& file, bool& res);
void Load(const QString& file);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• res (выходной параметр) - результат открытия файла.

Параметр res может принимать следующие значения:

• 0 - открытие и загрузка выполнены успешно;
• 1 - не указано файла;
• 2 - ошибка чтения файла;
• -1 - создан файл.

Сохранение данных в ini файл (Save)

Слот Save предназначен для сохранения данных в ini файл из внутреннего массива класса.

Описание:

void Save(const QString& file, int& res);
void Save(const QString& file, bool& res);
void Save(const QString& file);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• res (выходной параметр) - результат сохранения файла.

Параметр res может принимать следующие значения:

• 0 - сохранение выполнены успешно;
• 1 - не указано имя файла;
• 2 - ошибка записи в файл.

Сохранение всех файлов (SaveAll)

Слот SaveAll предназначен для сохранения всех ранее открытых ini файлов.

Описание:

void SaveAll(int& res);
void SaveAll(bool& res);
void SaveAll();

где

• res (выходной параметр) - результат сохранения.

Параметр res может принимать следующие значения:

• 0 - закрытие выполнено успешно;
• 1 - ошибка сохранения.

Закрытие ini файла (Unload)

Слот Unload предназначен для закрытия ini файла.

Описание:

void Unload(const QString& file, int& res);
void Unload(const QString& file, bool& res);
void Unload(const QString& file);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• res (выходной параметр) - результат закрытия файла.

Параметр res может принимать следующие значения:

• 0 - закрытие выполнено успешно;
• 1 - не указано имя файла;
• 2 - ошибка закрытия файла.
• -1 - файл не был загружен;

Закрытие всех файлов (UnloadAll)

Слот UnloadAll предназначен для закрытия всех ранее открытых ini файлов.

Описание:

void UnloadAll(int& res);

где

• res (выходной параметр) - результат закрытия.

Параметр res может принимать следующие значения:

• 0 - закрытие выполнено успешно;
• 1 - ошибка закрытия.

Запрос списка загруженных файлов (GetFileList)

Слот GetFileList предназначен для запроса списка загруженных ini файлов.

Описание:

void GetFileList(QStringList& filelist);

где

• filelist(выходной параметр) - список открытых ini файлов.

Проверка открытия файла (isOpen)

Слот isOpen предназначен для проверки был ли загружен ini файл.

Описание:

void isOpen(const QString& file, int& res);
void isOpen(const QString& file, bool& res);
void isOpen(const QString& file);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• res (выходной параметр) - результат проверки файла.

Запрос списка секций (GetSectionList)

Слот GetSectionList предназначен для запроса списка секций в ini файле.

Описание:

void GetSectionList(const QString& file, QStringList& seclist, int& res);
void GetSectionList(const QString& file, QStringList& seclist, bool& res);
void GetSectionList(const QString& file, QStringList& seclist);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• seclist(выходной параметр) - список секций в ini файле;
• res (выходной параметр) - результат запроса.

Параметр res может принимать следующие значения:

• 0 - запрос выполнен успешно;
• 1 - не указано имя файла.
• 2 - ошибка открытия файла;
• 3 - ошибка закрытия файла.

Переименование секции (RenameSection)

Слот RenameSection предназначен для переименования секции.

Описание:

void RenameSection(const QString& file, const QString& sec, const QString& newsec, int& res);
void RenameSection(const QString& file, const QString& sec, const QString& newsec, bool& res);
void RenameSection(const QString& file, const QString& sec, const QString& newsec);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec (входной параметр) - имя секции;
• newsec (входной параметр) - новое имя секции;
• res (выходной параметр) - результат переименования секции.

Параметр res может принимать следующие значения:

• 0 - переименование выполнено успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - не указано новое имя секции;
• 4 - секция sec не существует;
• 5 - ошибка открытия файла;
• 6 - ошибка закрытия файла.

Копирование секции (CopySection)

Слот CopySection предназначен для копирования секции.

Описание:

void CopySection(const QString& file, const QString& sec, const QString& newsec, int& res);
void CopySection(const QString& file, const QString& sec, const QString& newsec, bool& res);
void CopySection(const QString& file, const QString& sec, const QString& newsec);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec (входной параметр) - имя секции;
• newsec (входной параметр) - имя новой секции;
• res (выходной параметр) - результат копирования секции.

Параметр res может принимать следующие значения:

• 0 - копирование выполнено успешно;
• 1 - не указано имя файла;
• 2 - секция sec не существует;
• 3 - секция newsec уже существует;
• 4 - ошибка открытия файла;
• 5 - ошибка закрытия файла.

Удаление секции (DelSection)

Слот DelSection предназначен для удаления секции из ini файла.

Описание:

void DelSection(const QString& file, const QString& sec, int& res);
void DelSection(const QString& file, const QString& sec, bool& res);
void DelSection(const QString& file, const QString& sec);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec (входной параметр) - имя секции;
• res (выходной параметр) - результат удаления секции.

Параметр res может принимать следующие значения:

• 0 - удаление выполнено успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - ошибка открытия файла;
• 4 - ошибка закрытия файла;
• -1 - такая секция не существует.

Запрос списка параметров в секции (GetParamList)

Слот GetParamList предназначен для запроса списка секций в ini файле.

Описание:

void GetParamList(const QString& file, const QString& sec, QStringList& parlist, int& res);
void GetParamList(const QString& file, const QString& sec, QStringList& parlist, bool& res);
void GetParamList(const QString& file, const QString& sec, QStringList& parlist);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec(входной параметр) - имя секции;
• parlist(выходной параметр) - список параметров в секции;
• res (выходной параметр) - результат запроса.

Параметр res может принимать следующие значения:

• 0 - запрос выполнен успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - ошибка открытия файла;
• 4 - ошибка закрытия файла;
• -1 - секция не существует.

Запрос значения параметра (GetValue)

Слот GetValue предназначен для запроса значения параметра.

Описание:

void GetValue(const QString& file, const QString& sec, const QString& par, QString& val, int& res);
void GetValue(const QString& file, const QString& sec, const QString& par, QString& val, bool& res);
void GetValue(const QString& file, const QString& sec, const QString& par, QString& val);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec(входной параметр) - имя секции;
• par(входной параметр) - имя параметра в секции;
• val(выходной параметр) - значение параметра;
• res (выходной параметр) - результат запроса.

Параметр res может принимать следующие значения:

• 0 - запрос выполнен успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - не указано имя параметра;
• 4 - ошибка открытия файла;
• 5 - ошибка закрытия файла;
• -1 - секция не существует;
• -2 - параметр не существует.

Установка значения параметра (SetValue)

Слот SetValue предназначен для установки значения параметра.

Описание:

void SetValue(const QString& file, const QString& sec, const QString& par, const QString& val, int& res);
void SetValue(const QString& file, const QString& sec, const QString& par, const QString& val, bool& res);
void SetValue(const QString& file, const QString& sec, const QString& par, const QString& val);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec(входной параметр) - имя секции в ini файле;
• par(входной параметр) - имя параметра в секции;
• val(входной параметр) - значение параметра;
• res (выходной параметр) - результат выполнения.

Параметр res может принимать следующие значения:

• 0 - запрос выполнен успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - не указано имя параметра;
• 4 - некорректное имя параметра.
• 5 - ошибка открытия файла;
• 6 - ошибка закрытия файла;

Удаление параметра (DelParam)

Слот DelParam предназначен для установки значения параметра.

Описание:

void DelParam(const QString& file, const QString& sec, const QString& par, int& res);
void DelParam(const QString& file, const QString& sec, const QString& par, bool& res);
void DelParam(const QString& file, const QString& sec, const QString& par);

где

• file (входной параметр) - полный или относительный путь к ini файлу;
• sec(входной параметр) - имя секции в ini файле;
• par(входной параметр) - имя параметра в секции;
• res (выходной параметр) - результат удаления параметра.

Параметр res может принимать следующие значения:

• 0 - запрос выполнен успешно;
• 1 - не указано имя файла;
• 2 - не указано имя секции;
• 3 - не указано имя параметра;
• 4 - некорректное имя параметра.
• 5 - ошибка открытия файла;
• 6 - ошибка закрытия файла;
• -1 - секция не существует
• -2 - параметр не существует.

Сигналы, предоставляемые классом CoreIni

Сигналы, предоставляемые классом CoreIni:

1. Сигнал загрузки файла (IniFileLoaded);
2. Сигнал сохранения файла (IniFileSaved);
3. Сигнал сохранения всех файлов (AllIniFilesSaved);
4. Сигнал выгрузки файла (IniFileUnloaded);
5. Сигнал выгрузки всех файлов (AllIniFilesUnloaded).

Сигнал загрузки файла (IniFileLoaded)

Сигнал IniFileLoaded вызывается при успешной загрузке файла.

Описание:

void IniFileLoaded(const QString& file);

где

• file - имя загруженного файла.

Сигнал сохранения файла (IniFileSaved)

Сигнал IniFileSaved вызывается при успешном сохранении данных в файл.

Описание:

void IniFileSaved(const QString& file);

где

• file - имя сохраненного файла.

Сигнал сохранения всех файлов (AllIniFilesSaved)

Сигнал AllIniFilesSaved вызывается при успешном сохранении всех файлов.

Описание:

void AllIniFilesSaved();

Сигнал выгрузки файла (IniFileUnloaded)

Сигнал IniFileLoaded вызывается при успешной выгрузке файла.

Описание:

void IniFileLoaded(const QString& file);

где

• file - имя выгруженного файла.

Сигнал выгрузки всех файлов (AllIniFilesUnloaded)

Сигнал AllIniFilesUnloaded вызывается при успешной выгрузке всех файлов.

Описание:

void AllIniFilesUnloaded();

Взаимодействие с другими классами