HOM_RadialMenu.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_RadialMenu_h__
#define __HOM_RadialMenu_h__

#include "HOM_RadialItem.h"

class HOM_RadialSubmenu;
class HOM_RadialScriptItem;

SWIGOUT(%rename(RadialMenu) HOM_RadialMenu;)

class HOM_API HOM_RadialMenu
{
public:
    HOM_RadialMenu()
    { HOM_CONSTRUCT_OBJECT(this) }
    HOM_RadialMenu(const HOM_RadialMenu &)
    { HOM_CONSTRUCT_OBJECT(this) }
    virtual ~HOM_RadialMenu()
    { HOM_DESTRUCT_OBJECT(this) }

    virtual std::string __repr__() = 0;

    virtual void destroy() = 0;

    virtual std::string name() = 0;

    virtual const char *categories() = 0;

    virtual void setCategories(const std::string &s) = 0;

    virtual const char *sourceFile() = 0;

    virtual void save(const std::string &s) = 0;

    SWIGOUT(%newobject root;)
    virtual HOM_RadialItem *root() = 0;

    // Deprecated methods from when RadialMenu was a subclass
    // of RadialSubmenu. Use root() to get the submenu.

    // This method is deprecated. Use root()->label() instead.
    virtual const char *label() = 0;

    // This method is deprecated. Use root()->setLabel() instead.
    virtual void setLabel(const char *s) = 0;

    // This method is deprecated. Use root()->shortcut() instead.
    virtual const char *shortcut() = 0;

    // This method is deprecated. Use root()->setShortcut() instead.
    virtual void setShortcut(const char *s) = 0;

    // This method is deprecated. Use root()->item() instead (submenu only).
    SWIGOUT(%newobject item;)
    virtual HOM_RadialItem *item(HOM_EnumValue &location) = 0;

    // This method is deprecated. Use root()->items() instead (submenu only).
    virtual std::map<HOM_EnumValue *, HOM_ElemPtr<HOM_RadialItem> > items() = 0;

    // This method is deprecated. Use root()->createSubmenu() instead (submenu only).
    SWIGOUT(%newobject createSubmenu;)
    SWIGOUT(%kwargs createSubmenu;)
    virtual HOM_RadialSubmenu *createSubmenu(
        HOM_EnumValue &location,
        const char *label=nullptr,
        const char *shortcut=nullptr) = 0;

    // This method is deprecated. Use root()->createScriptItem() instead (submenu only).
    SWIGOUT(%newobject createScriptItem;)
    SWIGOUT(%kwargs createScriptItem;)
    virtual HOM_RadialScriptItem *createScriptItem(
        HOM_EnumValue &location,
        const char *label=nullptr,
        const char *icon=nullptr,
        const char *check=nullptr,
        const char *script=nullptr,
        const char *shortcut=nullptr) = 0;
};

#endif