ConfigCmd.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 The V-Gears Team
 *
 * This file is part of V-Gears
 *
 * V-Gears is free software: you can redistribute it and/or modify it under
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, version 3.0 (GPLv3) of the License.
 *
 * V-Gears 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.
 */
 
#pragma once
 
#include <OgreString.h>
#include <OgreStringVector.h>
 
class ConfigCmdHandler;
 
typedef void (*ConfigCmdParams)(const Ogre::StringVector& params);
 
typedef void (*ConfigCmdCompletion)(Ogre::StringVector& complete_params);
 
 
class ConfigCmd{
 
    friend class ConfigCmdHandler;
 
    public:
 
        ConfigCmd(
          const Ogre::String& name, const Ogre::String& description,
          const Ogre::String& params_description, ConfigCmdParams params,
          ConfigCmdCompletion completion
        );
 
        const Ogre::String& GetName() const;
 
        const Ogre::String& GetDescription() const;
 
        const Ogre::String& GetParamsDescription() const;
 
        ConfigCmdParams GetHandler() const;
 
        ConfigCmdCompletion GetCompletion() const;
 
    private:
 
        ConfigCmd(const ConfigCmd& rhs) = delete;
 
        ConfigCmd& operator =(const ConfigCmd& rhs) = delete;
 
        Ogre::String name_;
 
        Ogre::String description_;
 
        Ogre::String params_description_;
 
        ConfigCmdParams params_;
 
        ConfigCmdCompletion completion_;
};