taskbar.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 COMMON_TASKBAR_MANAGER_H
#define COMMON_TASKBAR_MANAGER_H

#include "common/scummsys.h"

#if defined(USE_TASKBAR)

#include "common/str.h"
#include "common/config-manager.h"
#include "common/file.h"

namespace Common {

class TaskbarManager {
public:
    enum TaskbarProgressState {
        kTaskbarNoProgress = 0,
        kTaskbarIndeterminate = 1,
        kTaskbarNormal = 2,
        kTaskbarError = 4,
        kTaskbarPaused = 8
    };

    TaskbarManager() {}
    virtual ~TaskbarManager() {}

    virtual void setOverlayIcon(const String &name, const String &description) {}

    virtual void setProgressValue(int completed, int total) {}

    virtual void setProgressState(TaskbarProgressState state) {}

    virtual void setCount(int count) {}

    virtual void addRecent(const String &name, const String &description) {}

    virtual void notifyError() {}

    virtual void clearError() {}

protected:
    Common::Path getIconPath(const Common::String &target, const Common::String &extension) {
        // We first try to look for a iconspath configuration variable then
        // fallback to the extra path
        //
        // Icons can be either in a subfolder named "icons" or directly in the path

        Common::Path iconsPath = ConfMan.getPath("iconspath");
        Common::Path extraPath = ConfMan.getPath("extrapath");

        Common::String targetIcon = target + extension;
        Common::String qualifiedIcon = ConfMan.get("engineid") + "-" + ConfMan.get("gameid") + extension;
        Common::String gameIcon = ConfMan.get("gameid") + extension;
        Common::String engineIcon = ConfMan.get("engineid") + extension;

#define TRY_ICON_PATH(path) { \
Common::FSNode node((path)); \
if (node.exists()) \
return (path); \
}
        if (!iconsPath.empty()) {
            TRY_ICON_PATH(iconsPath.join(targetIcon));
            TRY_ICON_PATH(iconsPath.join(qualifiedIcon));
            TRY_ICON_PATH(iconsPath.join(gameIcon));
            TRY_ICON_PATH(iconsPath.join(engineIcon));
            TRY_ICON_PATH(iconsPath.join("icons/" + targetIcon));
            TRY_ICON_PATH(iconsPath.join("icons/" + qualifiedIcon));
            TRY_ICON_PATH(iconsPath.join("icons/" + gameIcon));
            TRY_ICON_PATH(iconsPath.join("icons/" + engineIcon));
        }

        if (!extraPath.empty()) {
            TRY_ICON_PATH(extraPath.join(targetIcon));
            TRY_ICON_PATH(extraPath.join(qualifiedIcon));
            TRY_ICON_PATH(extraPath.join(gameIcon));
            TRY_ICON_PATH(extraPath.join(engineIcon));
            TRY_ICON_PATH(extraPath.join("icons/" + targetIcon));
            TRY_ICON_PATH(extraPath.join("icons/" + qualifiedIcon));
            TRY_ICON_PATH(extraPath.join("icons/" + gameIcon));
            TRY_ICON_PATH(extraPath.join("icons/" + engineIcon));
        }
#undef TRY_ICON_PATH

        return Common::Path();
    }
};

} // End of namespace Common

#endif

#endif // COMMON_TASKBAR_MANAGER_H