IMenuManager.h

Go to the documentation of this file.

#ifndef _INCLUDE_SOURCEMOD_MENU_SYSTEM_H_
#define _INCLUDE_SOURCEMOD_MENU_SYSTEM_H_

#include <IShareSys.h>
#include <IHandleSys.h>

#define SMINTERFACE_MENUMANAGER_NAME            "IMenuManager"
#define SMINTERFACE_MENUMANAGER_VERSION         16

namespace SourceMod
{
        enum ItemSelection
        {
                ItemSel_None,                                   
                ItemSel_Back,                                   
                ItemSel_Next,                                   
                ItemSel_Exit,                                   
                ItemSel_Item,                                   
                ItemSel_ExitBack,                               
        };

        enum ItemOrder
        {
                ItemOrder_Ascending,                    
                ItemOrder_Descending,                   
        };

        struct menu_slots_t
        {
                ItemSelection type;                             
                unsigned int item;                              
        };

        class IBaseMenu;
        class IMenuPanel;
        class IMenuHandler;

        struct menu_states_t
        {
                unsigned int apiVers;                   
                IBaseMenu *menu;                                
                IMenuHandler *mh;                               
                unsigned int firstItem;                 
                unsigned int lastItem;                  
                unsigned int item_on_page;              
                menu_slots_t slots[11];                 
        };

        #define ITEMDRAW_DEFAULT                (0)             
        #define ITEMDRAW_DISABLED               (1<<0)  
        #define ITEMDRAW_RAWLINE                (1<<1)  
        #define ITEMDRAW_NOTEXT                 (1<<2)  
        #define ITEMDRAW_SPACER                 (1<<3)  
        #define ITEMDRAW_IGNORE ((1<<1)|(1<<2)) 
        #define ITEMDRAW_CONTROL                (1<<4)  
        struct ItemDrawInfo
        {
                ItemDrawInfo(const char *DISPLAY=NULL, unsigned int STYLE=ITEMDRAW_DEFAULT, 
                                         unsigned int FLAGS=0, const char *HELPTEXT=NULL) 
                        : display(DISPLAY), style(STYLE)
                {
                }
                const char *display;                    
                unsigned int style;                             
        };

        struct menu_vote_result_t
        {
                unsigned int num_clients;               
                unsigned int num_votes;                 
                struct menu_client_vote_t
                {
                        int client;                                     
                        int item;                                       
                } *client_list;                                 
                unsigned int num_items;                 
                struct menu_item_vote_t
                {
                        unsigned int item;                      
                        unsigned int count;                     
                } *item_list;                                   
        };

        enum MenuCancelReason
        {
                MenuCancel_Disconnected = -1,   
                MenuCancel_Interrupted = -2,    
                MenuCancel_Exit = -3,                   
                MenuCancel_NoDisplay = -4,              
                MenuCancel_Timeout = -5,                
                MenuCancel_ExitBack = -6,               
        };

        enum MenuEndReason
        {
                MenuEnd_Selected = 0,                           
                MenuEnd_VotingDone = -1,                        
                MenuEnd_VotingCancelled = -2,           
                MenuEnd_Cancelled = -3,                         
                MenuEnd_Exit = -4,                                      
                MenuEnd_ExitBack = -5,                          
        };

        enum VoteCancelReason
        {
                VoteCancel_Generic = -1,                
                VoteCancel_NoVotes = -2,                
        };

        #define MENU_NO_PAGINATION                      0               
        #define MENU_TIME_FOREVER                       0               
        #define MENUFLAG_BUTTON_EXIT            (1<<0)  
        #define MENUFLAG_BUTTON_EXITBACK        (1<<1)  
        #define MENUFLAG_NO_SOUND                       (1<<2)  
        #define MENUFLAG_BUTTON_NOVOTE          (1<<3)  
        #define VOTEFLAG_NO_REVOTES                     (1<<0)  
        enum MenuOption
        {
                MenuOption_IntroMessage,                                
                MenuOption_IntroColor,                                  
                MenuOption_Priority,                                    
        };

        enum MenuSource
        {
                MenuSource_None = 0,                                    
                MenuSource_External = 1,                                
                MenuSource_BaseMenu = 2,                                
                MenuSource_Display = 3,                                 
        };

        class IMenuStyle;

        class IMenuPanel
        {
        public:
                virtual IMenuStyle *GetParentStyle() =0;

                virtual void Reset() =0;

                virtual void DrawTitle(const char *text, bool onlyIfEmpty=false) =0;

                virtual unsigned int DrawItem(const ItemDrawInfo &item) =0;

                virtual bool DrawRawLine(const char *rawline) =0;

                virtual bool SetExtOption(MenuOption option, const void *valuePtr) =0;

                virtual bool CanDrawItem(unsigned int drawFlags) =0;

                virtual bool SendDisplay(int client, IMenuHandler *handler, unsigned int time) =0;

                virtual void DeleteThis() =0;

                virtual bool SetSelectableKeys(unsigned int keymap) =0;

                virtual unsigned int GetCurrentKey() =0;

                virtual bool SetCurrentKey(unsigned int key) =0;

                virtual int GetAmountRemaining() =0;

                virtual unsigned int GetApproxMemUsage() =0;
                
                virtual bool DirectSet(const char *str) =0;
        };

        class IMenuStyle
        {
        public:
                virtual unsigned int GetStyleAPIVersion()
                {
                        return SMINTERFACE_MENUMANAGER_VERSION;
                }

                virtual const char *GetStyleName() =0;

                virtual IMenuPanel *CreatePanel() =0;

                virtual IBaseMenu *CreateMenu(IMenuHandler *handler, IdentityToken_t *pOwner=NULL) =0;

                virtual unsigned int GetMaxPageItems() =0;

                virtual MenuSource GetClientMenu(int client, void **object) =0;

                virtual bool CancelClientMenu(int client, bool autoIgnore=false) =0;

                virtual Handle_t GetHandle() =0;

                virtual unsigned int GetApproxMemUsage() =0;
                
                virtual bool IsSupported() =0;
        };

        class IBaseMenu
        {
        public:
                virtual bool AppendItem(const char *info, const ItemDrawInfo &draw) =0;

                virtual bool InsertItem(unsigned int position, const char *info, const ItemDrawInfo &draw) =0;

                virtual bool RemoveItem(unsigned int position) =0;

                virtual void RemoveAllItems() =0;

                virtual const char *GetItemInfo(unsigned int position, ItemDrawInfo *draw) =0;

                virtual unsigned int GetItemCount() =0;

                virtual bool SetPagination(unsigned int itemsPerPage) =0;

                virtual unsigned int GetPagination() =0;

                virtual IMenuStyle *GetDrawStyle() =0;

                virtual void SetDefaultTitle(const char *message) =0;

                virtual const char *GetDefaultTitle() =0;

                virtual bool SetExtOption(MenuOption option, const void *valuePtr) =0;

                virtual IMenuPanel *CreatePanel() =0;

                virtual bool Display(int client, unsigned int time, IMenuHandler *alt_handler=NULL) =0;

                virtual void Destroy(bool releaseHandle=true) =0;

                virtual void Cancel() =0;

                virtual Handle_t GetHandle() =0;
                
                virtual unsigned int GetMenuOptionFlags() =0;

                virtual void SetMenuOptionFlags(unsigned int flags) =0;

                virtual IMenuHandler *GetHandler() =0;

                virtual bool DisplayAtItem(int client,
                        unsigned int time,
                        unsigned int start_item,
                        IMenuHandler *alt_handler=NULL) =0;

                virtual unsigned int GetApproxMemUsage() =0;
        };

        class IMenuHandler
        {
        public:
                virtual unsigned int GetMenuAPIVersion2()
                {
                        return SMINTERFACE_MENUMANAGER_VERSION;
                }

                virtual void OnMenuStart(IBaseMenu *menu)
                {
                }

                virtual void OnMenuDisplay(IBaseMenu *menu, int client, IMenuPanel *display)
                {
                }

                virtual void OnMenuSelect(IBaseMenu *menu, int client, unsigned int item)
                {
                }

                virtual void OnMenuCancel(IBaseMenu *menu, int client, MenuCancelReason reason)
                {
                }

                virtual void OnMenuEnd(IBaseMenu *menu, MenuEndReason reason)
                {
                }

                virtual void OnMenuDestroy(IBaseMenu *menu)
                {
                }

                virtual void OnMenuDrawItem(IBaseMenu *menu, int client, unsigned int item, unsigned int &style)
                {
                }

                virtual unsigned int OnMenuDisplayItem(IBaseMenu *menu, 
                                                                                           int client, 
                                                                                           IMenuPanel *panel,
                                                                                           unsigned int item, 
                                                                                           const ItemDrawInfo &dr)
                {
                        return 0;
                }

                virtual void OnMenuVoteStart(IBaseMenu *menu)
                {
                }

                virtual void OnMenuVoteResults(IBaseMenu *menu, const menu_vote_result_t *results)
                {
                }

                virtual void OnMenuVoteCancel(IBaseMenu *menu, VoteCancelReason reason)
                {
                }

                virtual bool OnSetHandlerOption(const char *option, const void *data)
                {
                        return false;
                }

                virtual void OnMenuSelect2(IBaseMenu *menu,
                        int client,
                        unsigned int item,
                        unsigned int item_on_page)
                {
                }
        };

        class IMenuManager : public SMInterface
        {
        public:
                virtual const char *GetInterfaceName()
                {
                        return SMINTERFACE_MENUMANAGER_NAME;
                }
                virtual unsigned int GetInterfaceVersion()
                {
                        return SMINTERFACE_MENUMANAGER_VERSION;
                }
                virtual bool IsVersionCompatible(unsigned int version)
                {
                        if (version < 11 || version > GetInterfaceVersion())
                        {
                                return false;
                        }
                        return true;
                }
        public:
                virtual IMenuStyle *FindStyleByName(const char *name) =0;

                virtual IMenuStyle *GetDefaultStyle() =0;

                virtual IMenuPanel *RenderMenu(int client, menu_states_t &states, ItemOrder order) =0;

                virtual void CancelMenu(IBaseMenu *menu) =0;

                virtual bool StartVote(IBaseMenu *menu,
                                                                unsigned int num_clients,
                                                                int clients[],
                                                                unsigned int max_time,
                                                                unsigned int flags=0) =0;

                virtual bool IsVoteInProgress() =0;

                virtual void CancelVoting() =0;

                virtual unsigned int GetRemainingVoteDelay() =0;

                virtual bool IsClientInVotePool(int client) =0;

                virtual bool RedrawClientVoteMenu(int client) =0;

                virtual bool RedrawClientVoteMenu2(int client, bool revotes) =0;
        };
}

#endif //_INCLUDE_SOURCEMOD_MENU_SYSTEM_H_