HOM_PluginHotkeyDefinitions.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS:
 */

#ifndef HOM_PluginHotkeyDefinitions_h
#define HOM_PluginHotkeyDefinitions_h

#include "HOM_API.h"
#include "HOM_Module.h"
//#include "HOM_EnumValue.h"
//#include "HOM_Defines.h"

#include <string>
#include <vector>

SWIGOUT(%rename(PluginHotkeyDefinitions) HOM_PluginHotkeyDefinitions;)
SWIGOUT(%feature("notabstract") HOM_PluginHotkeyDefinitions;)

class HOM_API HOM_PluginHotkeyDefinitions
{
public:
#ifdef SWIG
%extend
{
    HOM_PluginHotkeyDefinitions()
    {
        return HOM().newPluginHotkeyDefinitions();
    }
}
#else
    HOM_PluginHotkeyDefinitions()
    { HOM_CONSTRUCT_OBJECT(this) }
#endif

    virtual ~HOM_PluginHotkeyDefinitions()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() = 0;


    virtual void addCommandCategory(
        std::string const& symbol,
        std::string const& label,
        std::string const& description) = 0;
    virtual void addCommand(
        std::string const& symbol,
        std::string const& label,
        std::string const& description) = 0;
    virtual void addContext(
        std::string const& symbol,
        std::string const& label,
        std::string const& description) = 0;
    virtual void addDefaultBinding(
        std::string const& context,
        std::string const& command,
        const std::vector<std::string> &assignments
            = std::vector<std::string>(),
        bool apply_platform_modifier_mappings = true) = 0;

    virtual bool containsCommandCategory(std::string const& symbol) = 0;
    virtual bool containsCommand(std::string const& symbol) = 0;
    virtual bool containsContext(std::string const& symbol) = 0;
    virtual bool containsDefaultBinding(
        std::string const& context,
        std::string const& command) = 0;
};

#endif // HOM_PluginHotkeyDefinitions_h