CMenuItem.hpp

Go to the documentation of this file.

#ifndef __CMenuItem__
#define __CMenuItem__

#include <Basics/CString.hpp>
#include <Basics/CCountedObject.hpp>
#include "../Graphics/IImage.hpp"
#include "../Basics/CAlphaColour.hpp"

//  ===========================================================================

using Exponent::Basics::CString;
using Exponent::Basics::CCountedObject;
using Exponent::GUI::Graphics::IImage;
using Exponent::GUI::Basics::CAlphaColour;

//  ===========================================================================

namespace Exponent
{
    namespace GUI
    {
        namespace Controls
        {
            class CMenuItem : public CCountedObject
            {
                EXPONENT_CLASS_DECLARATION;
//  ===========================================================================

            public:

//  ===========================================================================

                enum EMenuItemTypes
                {
                    e_menuItemNormal = 0,       
                    e_menuItemHtmlLink,         
                    e_menuItemSeperator,        
                    e_menuItemSelectable,       
                    e_subMenuHolder,            
                    e_verticalSeperator,        
                };

//  ===========================================================================
                
                CMenuItem(const CString &text, const long identifier, const EMenuItemTypes type = e_menuItemNormal, const bool enabled = true);

                virtual ~CMenuItem();

//  ===========================================================================
                
                virtual void setText(const CString &text) { m_text = text; }
                
                virtual void setId(const long id) { m_id = id; }
                
                virtual void setType(const EMenuItemTypes type) { m_type = type; }
                
                virtual void enable(const bool enabled = true) { m_isEnabled = enabled; }
                
                virtual void setIndex(const long index) { m_index = index; }

                virtual void setImages(IImage *normalImage, IImage *rolloverImage)
                {
                    EXCHANGE_COUNTED_OBJECTS(m_normalImage, normalImage);
                    EXCHANGE_COUNTED_OBJECTS(m_rolloverImage, rolloverImage);
                }

//  ===========================================================================
                
                virtual const CString &getText() const { return m_text; }
                
                virtual long getId() const { return m_id; }
                
                virtual EMenuItemTypes getType() const { return m_type; }
                
                virtual bool isEnabled() const { return m_isEnabled; }
                
                virtual long getIndex() const { return m_index; }

                virtual IImage *getNormalImage() const { return m_normalImage; }

                virtual IImage *getRolloverImage() const { return m_rolloverImage; }

                void setTextColour(const CAlphaColour &colour) { m_textColour = colour; }

                const CAlphaColour &getTextColour() const { return m_textColour; }

                void overrideTextColour(const bool override) { m_overrideTextColour = override; }

                bool overrideTextColour() const { return m_overrideTextColour; }

//  ===========================================================================

            protected:

//  ===========================================================================

                CString m_text;                 
                long m_id;                      
                long m_index;                   
                EMenuItemTypes m_type;          
                bool m_isEnabled;               
                IImage *m_normalImage;          
                IImage *m_rolloverImage;        
                CAlphaColour m_textColour;      
                bool m_overrideTextColour;      
            };
        }
    }
}
#endif  // End of CMenuItem.hpp

---