wg_menu.h

// wg_menu.h
//
// CMenu interface
//
//
// Copyright (c) 2002-2004 Rob Wiskow
// rob-dev@boxedchaos.com
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//


#ifndef _WG_MENU_H_
#define _WG_MENU_H_

#include "wg_window.h"
#include "wg_painter.h"
#include "wg_renderedstring.h"
#include "wg_resources.h"
#include "wg_timer.h"
#include <vector>
#include <string>


namespace wGui
{

class CPopupMenu;



struct SMenuItem
{
public:
     SMenuItem(std::wstring sItemText, long int iItemId = 0, CPopupMenu* pPopup = 0) :
          sItemText(sItemText), iItemId(iItemId), pPopup(pPopup), bSpacer(false) { }

     SMenuItem(void) : sItemText(L""), iItemId(0), pPopup(0), bSpacer(true) { }

     std::wstring sItemText;  
     long int iItemId;  
     CPopupMenu* pPopup;  
     bool bSpacer;  
};




class CMenuBase : public CWindow
{
public:
     CMenuBase(const CRect& WindowRect, CWindow* pParent, CFontEngine* pFontEngine = 0);

     virtual ~CMenuBase(void);

     virtual void InsertMenuItem(const SMenuItem& MenuItem, int iPosition = -1);

     void RemoveMenuItem(int iPosition);

     int GetMenuItemCount(void) const { return stdex::safe_static_cast<int>(m_MenuItems.size()); }

     void HideActivePopup(void);

     void SetHighlightColor(const CRGBColor& HighlightColor) { m_HighlightColor = HighlightColor; }


     virtual void Draw(void) const = 0;

     virtual bool OnMouseButtonDown(CPoint Point, unsigned int Button);


     // CMessageClient overrides
     virtual bool HandleMessage(CMessage* pMessage);


protected:
     virtual void UpdateCachedRects(void) const = 0;

     virtual void ShowActivePopup(const CRect& ParentRect, const CRect& BoundingRect) = 0;


     CFontEngine* m_pFontEngine;  

     struct s_MenuItemInfo
     {
          s_MenuItemInfo(const SMenuItem& MI, const CRenderedString& RS, const CRect& R)
               : MenuItem(MI), RenderedString(RS), Rect(R)
          { }
          
          SMenuItem MenuItem;  
          CRenderedString RenderedString;  
          CRect Rect;  
     };
     typedef std::vector<s_MenuItemInfo> t_MenuItemVector;  
     mutable t_MenuItemVector m_MenuItems;  
     SMenuItem* m_pHighlightedItem;  
     mutable bool m_bCachedRectsValid;  
     CPopupMenu* m_pActivePopup;  
     CwgBitmapResourceHandle m_hRightArrowBitmap;  
     CRGBColor m_HighlightColor;  
     CTimer* m_pPopupTimer;  


private:
//   void operator=(CMenuBase) { }  //!< The assignment operator is not allowed for CWindow derived objects
};



class CMenu : public CMenuBase
{
public:
     CMenu(const CRect& WindowRect, CWindow* pParent, CFontEngine* pFontEngine = 0);

     virtual ~CMenu(void);

     virtual void InsertMenuItem(const SMenuItem& MenuItem, int iPosition = -1);


     virtual void Draw(void) const;

     virtual bool OnMouseButtonDown(CPoint Point, unsigned int Button);


     // CMessageClient overrides
     virtual bool HandleMessage(CMessage* pMessage);


protected:
     virtual void UpdateCachedRects(void) const;

     virtual void ShowActivePopup(const CRect& ParentRect, const CRect& BoundingRect);


private:
     void operator=(CMenu) { }  
};



class CPopupMenu : public CMenuBase
{
public:
     CPopupMenu(const CRect& WindowRect, CWindow* pParent, CFontEngine* pFontEngine = 0);

     virtual ~CPopupMenu(void);

     void Show(CPoint Position);

     void Hide(void);

     void HideAll(void);

     bool IsInsideChild(const CPoint& Point) const;

     bool IsRootPopup(void) { return !(dynamic_cast<CPopupMenu*>(m_pParentWindow)); }

     void SetParentMenu(CMenu* pParentMenu) { m_pParentMenu = pParentMenu; }


     virtual void Draw(void) const;

     virtual void PaintToSurface(SDL_Surface& ScreenSurface, SDL_Surface& FloatingSurface, const CPoint& Offset) const;

     virtual bool OnMouseButtonDown(CPoint Point, unsigned int Button);


     // CMessageClient overrides
     virtual bool HandleMessage(CMessage* pMessage);


protected:
     virtual void UpdateCachedRects(void) const;

     virtual void ShowActivePopup(const CRect& ParentRect, const CRect& BoundingRect);

     CMenu* m_pParentMenu;


private:
     void operator=(CPopupMenu) { }  
};

}


#include "unit_tests/wg_menu_unittests.h"

#endif  // _WG_MENU_H_

---