tb_application_menu.hpp

#ifndef TurtleBrains_ApplicationMenu_hpp
#define TurtleBrains_ApplicationMenu_hpp

#include <turtle_brains/application/implementation/tbi_application_information.hpp>
#include <turtle_brains/core/tb_types.hpp>

#include <vector>

namespace TurtleBrains
{
    namespace Application
    {

        class ApplicationHandlerInterface;

        typedef unsigned short MenuIdentifier;

        typedef unsigned short MenuItemIdentifier;

        extern const MenuItemIdentifier kInvalidMenuItemIdentifier;

//-------------------------------------------------------------------------------------------------------------------//

        class ApplicationMenu
        {
        public:
            explicit ApplicationMenu(const MenuIdentifier& menuIdentifier);

            ~ApplicationMenu(void);

            const MenuIdentifier& GetIdentifier(void) const;

            void AddMenuItem(const MenuItemIdentifier& itemIdentifier, const tbCore::tbString& displayName,
                    const MenuItemIdentifier& parentIdentifier = kInvalidMenuItemIdentifier, const bool isEnabled = true,
                    const bool isChecked = false, const bool isVisible = true);

            const tbCore::tbString& GetDisplayName(const MenuItemIdentifier& itemIdentifier) const;

            bool IsEnabled(const MenuItemIdentifier& itemIdentifier) const;

            bool IsChecked(const MenuItemIdentifier& itemIdentifier) const;

            bool IsVisible(const MenuItemIdentifier& itemIdentifier) const;

            void SetDisplayName(const MenuItemIdentifier& itemIdentifier, const tbCore::tbString& displayName);

            void SetEnabled(const MenuItemIdentifier& itemIdentifier, bool isEnabled);

            void SetChecked(const MenuItemIdentifier& itemIdentifier, bool isChecked);

            void SetVisible(const MenuItemIdentifier& itemIdentifier, bool isVisible);

            static void SetItemSafeForDuplication(const MenuItemIdentifier& itemIdentifier);

        private:
            MenuIdentifier mIdentifier;
        };

    }; /* namespace Application */
}; /* namespace TurtleBrains */

namespace tbApplication = TurtleBrains::Application;

#endif /* TurtleBrains_ApplicationMenu_hpp */