mgui/menu.h

Go to the documentation of this file.

#ifndef  INC_MGUI_MENU_H
#define  INC_MGUI_MENU_H

#ifndef  INC_MGUI_BASE_H
#include <mgui/base.h>
#endif

#ifndef  INC_MI32_ICONID_H
#include <mi32/iconid.h>
#endif

#ifndef GENERATING_DOXYGEN_OUTPUT
class MISTRING;
#endif

namespace MGUI {

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

class MENU {
   public:

      enum TYPE {
         TYPE_MenuBar,              
         TYPE_SubMenu,              
         TYPE_Popup,                
      #ifndef GENERATING_DOXYGEN_OUTPUT
         TYPE_ToolBar               
      #endif
         };

      enum CREATEITEM {
         CREATEITEM_Default =       0,
         CREATEITEM_Check =         0x0001,     
         CREATEITEM_CheckOn =       0x0009,     
         CREATEITEM_Radio =         0x0002,     
         CREATEITEM_RadioOn =       0x000A,     
         CREATEITEM_RadioFirst =    0x0004,     
         CREATEITEM_RadioFirstOn =  0x000C,     
         CREATEITEM_ToggleOn =      0x0008,     
         CREATEITEM_Disabled =      0x0010,     
         CREATEITEM_NoDelegate =    0x0020,     
         CREATEITEM_MI_Internal =   0x0040,     
         CREATEITEM_MI_Programmer = 0x0080,     
         CREATEITEM_Hidden =        0x0100      
         };

      enum POPUP {
         POPUP_AlignLeft =          0x0001,     
         POPUP_AlignCenter =        0x0002,     
         POPUP_AlignRight =         0x0004,     
         POPUP_MouseLeft =          0x0010,     
         POPUP_MouseRight =         0x0020,     
         POPUP_MouseEither =        0x0030,     
         POPUP_Default = POPUP_AlignLeft | POPUP_MouseEither
         };

      enum ITEMHND {
         ITEMHND_None = -1,
         ITEMHND_Last = -2
         };

      typedef fastdelegate::FastDelegate<void(MGUI::ID,bool)> DELEGATE;
      typedef fastdelegate::FastDelegate<void(INT32)> DELEGATE_ONWHEEL;

      static CREATEITEM CREATEITEM_CheckSet (
         bool ToggleOn
         ) { return (ToggleOn ? CREATEITEM_CheckOn : CREATEITEM_Check); }

      static CREATEITEM CREATEITEM_RadioSet (
         bool ToggleOn,
         bool RadioFirst = false
         ) { return (RadioFirst ? (ToggleOn ? CREATEITEM_RadioFirstOn : CREATEITEM_RadioFirst) : (ToggleOn ? CREATEITEM_RadioOn : CREATEITEM_Radio)); }

      MENU ();

      MENU (const MENU& rhs);

      ~MENU ();

      MENU& operator= (const MENU& rhs);

      ITEMHND Add (
         const MISTRING& label,           
         ID id,                           
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND Add (
         ICONID iconid,                   
         const MISTRING& label,           
         ID id,                           
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND Add (
         const MISTRING& label,           
         MGUI::MENU::DELEGATE delegate,   
         ID id = 0,                       
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND Add (
         ICONID iconid,                   
         const MISTRING& label,           
         MGUI::MENU::DELEGATE delegate,   
         ID id = 0,                       
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND Add (
         const MISTRING& label,           
         MENU& submenu,                   
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND Add (
         ICONID iconid,                   
         const MISTRING& label,           
         MENU& submenu,                   
         CREATEITEM createflags = CREATEITEM_Default,
         ITEMHND hndInsertAfter = ITEMHND_Last, 
         UINT32 icid = 0                  
         );

      ITEMHND AddSeparator (
         ITEMHND hndInsertAfter = ITEMHND_Last  
         );

      ITEMHND AddSpaceFixed (
         int space,                       
         ITEMHND hndInsertAfter = ITEMHND_Last  
         );

      void Create (
         TYPE type                        
         );

      void Create (
         TYPE type,                       
         MGUI::MENU::DELEGATE delegate    
         );

      void Delete (
         ITEMHND hndItem                  
         );

      void DeleteAll (
         );

      bool IsCreated (
         ) const { return (m_pPriv != 0); }

      bool IsEmpty (
         ) const;

      bool GetToggleState (
         ITEMHND hndItem                  
         ) const;

      bool GetToggleStateID (
         ID id                            
         ) const;

      ID Popup (
         CTRL& ctrl,                      
         const LPOINT2D& point,           
         POPUP popupflags = POPUP_Default 
         );

      ID Popup (
         CTRL& ctrl,                      
         const MGUI::POINT& point,        
         POPUP popupflags = POPUP_Default 
         );

      void SetDelegate (
         ID id,                           
         DELEGATE delegate                
         );

      void SetDelegateOnPointerWheel (
         DELEGATE_ONWHEEL delegate        
         );

      void SetEnabled (
         ITEMHND hndItem,                 
         bool enabled                     
         );

      void SetEnabledAll (
         bool enabled                     
         );

      void SetEnabledID (
         ID id,                           
         bool enabled                     
         );

      void SetLabel (
         ITEMHND hndItem,                 
         const MISTRING& label            
         );

      void SetLabelID (
         ID id,                           
         const MISTRING& label            
         );

      void SetToggleState (
         ITEMHND hndItem,                 
         bool ToggleOn,                   
         bool notify                      
         );

      void SetToggleStateID (
         ID id,                           
         bool ToggleOn,                   
         bool notify                      
         );

      void SetVisible (
         ITEMHND hndItem,                 
         bool visible                     
         );

      void SetVisibleID (
         ID id,                           
         bool visible                     
         );

   #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;

      typedef fastdelegate::FastDelegate<void(Widget)> DELEGATE_ONCREATEWIDGET;

      // Add delegate to call when menu widget is actually created.
      void AddDelegateOnCreateWidget (
         DELEGATE_ONCREATEWIDGET delegate
         );

      // Create menubar for X, called from MGUI::SHELL::AttachMenuBar().
      void CreateMenuBarX (
         LAYOUT_PANE_BASE& parentpane
         );

      // Create toolbar for X, called from MGUI::CTRL_TOOLBAR::Create()
      Widget CreateToolBarX (
         LAYOUT_PANE_BASE& parentpane,
         LAYOUT_ORIENTATION orientation,
         LAYOUT_SIZEALIGN sizealign
         );

      // Get internal private pointer, called by DLG_CUSTOMIZE.
      PRIV* GetPrivPtr (
         ) const { return (m_pPriv); }

      // Get X Widget from item ID.
      // For internal MGUI use only.
      Widget GetWidgetFromID (
         ID id
         ) const;

   private:
      PRIV *m_pPriv;
   #endif // GENERATING_DOXYGEN_OUTPUT
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(MENU::CREATEITEM)
DEFINE_ENUM_OP_BITWISE(MENU::POPUP)
#endif

//=====================================================================================================================
}  

#endif   // INC_MGUI_MENU_H

---