pilotclient/src/blackmisc/settingutilities.h

#ifndef BLACKMISC_SETTINGUTILITIES_H
#define BLACKMISC_SETTINGUTILITIES_H

#include "blackmisc/statusmessagelist.h"

namespace BlackMisc
{
    namespace Settings
    {
        //! Helper / utility methods for settings
        class CSettingUtilities
        {
        private:
            CSettingUtilities() {}

        public:

            //! \brief Command validate
            static const QString &CmdValidate()
            {
                static const QString cmd("validate");
                return cmd;
            }

            //! Command Update
            static const QString &CmdUpdate()
            {
                static const QString cmd("update");
                return cmd;
            }

            //! Command Remove
            static const QString &CmdRemove()
            {
                static const QString cmd("remove");
                return cmd;
            }

            //! Command Add
            static const QString &CmdAdd()
            {
                static const QString cmd("add");
                return cmd;
            }

            //! Command Set boolean value true
            static const QString &CmdSetTrue()
            {
                static const QString cmd("set:true");
                return cmd;
            }

            //! Command Set boolean value false
            static const QString &CmdSetFalse()
            {
                static const QString cmd("set:false");
                return cmd;
            }

            //! \brief Wrong path message
            static BlackMisc::CStatusMessage wrongPathMessage(const QString &path = "");

            //! \brief Wrong path messages
            static BlackMisc::CStatusMessageList wrongPathMessages(const QString &path = "");

            //! \brief Value not changed message
            static BlackMisc::CStatusMessage valueNotChangedMessage(const QString &valueName);

            //! \brief Value changed message
            static BlackMisc::CStatusMessage valueChangedMessage(const QString &valueName);

            //! \brief Remove leading path
            static QString removeLeadingPath(const QString &path);

            //! \brief Append setting paths
            static QString appendPaths(const QString &part1, const QString &part2, const QString &part3 = "");

            //! \brief prepare the settings directory, if required create it
            static bool initSettingsDirectory();

            //! \brief get the settings directory
            static const QString &getSettingsDirectory();

            //! \brief get the settings directory
            static const QString &getSettingsFile();

        };
    } // namespace
} // namespace
#endif // guard