IGUIContextMenu.h

Go to the documentation of this file.

// Copyright (C) 2002-2012 Nikolaus Gebhardt
// This file is part of the "Irrlicht Engine".
// For conditions of distribution and use, see copyright notice in irrlicht.h

#ifndef __I_GUI_CONTEXT_MENU_H_INCLUDED__
#define __I_GUI_CONTEXT_MENU_H_INCLUDED__

#include "IGUIElement.h"

namespace irr
{
namespace gui
{
    enum ECONTEXT_MENU_CLOSE
    {
        ECMC_IGNORE = 0,

        ECMC_REMOVE = 1,

        ECMC_HIDE = 2

        // note to implementors - this is planned as bitset, so continue with 4 if you need to add further flags.
    };


    class IGUIContextMenu : public IGUIElement
    {
    public:

        IGUIContextMenu(IGUIEnvironment* environment, IGUIElement* parent, s32 id, core::rect<s32> rectangle)
            : IGUIElement(EGUIET_CONTEXT_MENU, environment, parent, id, rectangle) {}

        virtual void setCloseHandling(ECONTEXT_MENU_CLOSE onClose) = 0;

        virtual ECONTEXT_MENU_CLOSE getCloseHandling() const = 0;

        virtual u32 getItemCount() const = 0;


        virtual u32 addItem(const wchar_t* text, s32 commandId=-1, bool enabled=true,
            bool hasSubMenu=false, bool checked=false, bool autoChecking=false) = 0;


        virtual u32 insertItem(u32 idx, const wchar_t* text, s32 commandId=-1, bool enabled=true,
            bool hasSubMenu=false, bool checked=false, bool autoChecking=false) = 0;


        virtual s32 findItemWithCommandId(s32 commandId, u32 idxStartSearch=0) const = 0;

        virtual void addSeparator() = 0;


        virtual const wchar_t* getItemText(u32 idx) const = 0;


        virtual void setItemText(u32 idx, const wchar_t* text) = 0;


        virtual bool isItemEnabled(u32 idx) const = 0;


        virtual void setItemEnabled(u32 idx, bool enabled) = 0;


        virtual void setItemChecked(u32 idx, bool enabled) = 0;


        virtual bool isItemChecked(u32 idx) const = 0;


        virtual void removeItem(u32 idx) = 0;

        virtual void removeAllItems() = 0;


        virtual s32 getSelectedItem() const = 0;


        virtual s32 getItemCommandId(u32 idx) const = 0;


        virtual void setItemCommandId(u32 idx, s32 id) = 0;


        virtual IGUIContextMenu* getSubMenu(u32 idx) const = 0;

        virtual void setItemAutoChecking(u32 idx, bool autoChecking) = 0;

        virtual bool getItemAutoChecking(u32 idx) const = 0;

        virtual void setEventParent(IGUIElement *parent) = 0;
    };

} // end namespace gui
} // end namespace irr

#endif