MacHelper.h

/*
 * Copyright (C) 2020 Adrian Carpenter
 *
 * This file is part of a regex101.com offline application.
 *
 * https://github.com/fizzyade/regex101
 *
 * =====================================================================
 * The regex101 web content is owned and used with permission from
 * Firas Dib at regex101.com.  This application is an unofficial
 * tool to provide an offline application version of the website.
 * =====================================================================
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef MACHELPER_H
#define MACHELPER_H

#include <QPixmap>

namespace Nedrysoft {
    namespace StandardImage {
        /**
         * @brief               StandardImageName enum
         *
         * @details             Provides parity naming with AppKit standard images.
         */
        enum StandardImageName {
            NSImageNamePreferencesGeneral,
            NSImageNameUserAccounts,
            NSImageNameAdvanced
        };
    };

    /**
     * @brief               MacHelper class
     *
     * @details             Provides helper functions to allow more native mac os functionality
     *                      where required.
     */
    class MacHelper
    {
        public:
            /**
             * @brief           Returns a pixmap of a mac standard icon
             *
             * @param[in]       imageName a image from the standard icons enum
             * @param[in]       size is the required size of the resulting image
             *
             * @returns         A pixmap of the named image
             */
            static QPixmap macStandardImage(StandardImage::StandardImageName imageName, QSize imageSize);
    };
};

#endif