MMenu

MMenu_Create( pOptions  =  "" )

Creates new menu and sets its options.  It returns menu handle that is used in other menu functions.

Parameters

You can specify any combination of following options (space separated):

Returns

Menu handle

Examples

;
     myMenu := Menu_Create()              ;create with default options
     myMenu := Menu_Create("S64 O20")     ;set icon size to 64 and offset to 20
     myMenu := Menu_Create("C0 TFFFFFF")  ;set background color to black and text color to white

MMenu_Add( pMenu,    pTitle  =  "", pIcon  =  "", pItem  =  0, pOptions  =  "" )

Adds a new menu item into the specified menu.

Parameters

Options

Returns

false if there was an error

Item identification

There are 3 methods to identify the item – by ID, by 1-based position and by title.  You can use anything that is more appropriate in your scripting environment.  All of MMenu functions dealing with items have item parameter that you use to point on specific menu item.  If you set item to be positive number, it will be seen as a position.  If you pass string instead of number, it will be seen as as item ID.  Item ID is any vaild Autohotkey name that you associate with item when you add it to the menu.  If you set the ID to the already existing, you will remove ID of the item previously associated with it.  Item ID is unique acros all menus that you create.  If item ends with A_SPACE, it will be seen as items title without ending space (the reason for this is that valid item ID’s can not have space).  As you can have more items with the same title, this will return the one with lowest position in the menu.

;
             1         - identifies the item at position 1
          "myItem"     - identifies the item with ID=myItem
          "myItem "    - identifies the item with Title=myItem

Examples

;
       Menu_Add( myMenu, "title 1")                    ;append item, set the title
       Menu_Add( myMenu, "title 2", "icons\item.ico")  ;append item, set the title and icon
       Menu_Add( myMenu, "title 3", "", 3)             ;add item without icon on third position
       Menu_Add( myMenu, "title 4", "", , "imyItem c") ;append item with ID=myItem, set its title and check it
       Menu_Add( myMenu, "title 5", "", "myItem")      ;add item without icon before item with ID=myItem
       Menu_Add( myMenu )                              ;append separator

       mySubMenu := Menu_Create()
       Menu_Add( myMenu, "My Submenu", "icons\submenu.ico", 2, "M" mySubMenu) ;add submenu on second position

MMenu_Remove( pMenu,    pItem  =  )

Removes the item from the given menu and if item opens the submenu, deattaches submenu.  If you specify item by title, the item with the lowest position with that title will be removed.

Parameters

Returns

true on success, false if error occured

Note

If you want to remove the item using its title as identification you must A_SPACE at the end of it.

Without space it will be understood as item ID or item position, depending on title value

;
      Menu_Remove(main, "1")         ;remove the item with position=1
      Menu_Remove(main, "1 ")        ;remove the item with title=1

MMenu_Set( pMenu,    pItem,    pTitle  =  "", pIcon  =  "", pOptions  =  "" )

Set item’s title and/or icon and/or options on already crated items.

Parameters

Notes

If you want to remove title or icon use A_SPACE instead of empty string.

Use the empty string to leave the option untouched.

To unset the flag option, use – in front of it (-c –b –m -g). d option can not be unset.

Examples

Menu_Set( myMenu, 1,            "new title","","i33" )      ;change the title and ID of first item
Menu_Set( myMenu, "new title ", "", A_SPACE ,"c" )          ;check the first item with title"new title", and remove icon
Menu_Set( myMenu, "i101",       "","disabled.ico","g -c" )  ;gray and uncheck item with ID=i101 and change its icon

MMenu_Destroy( pMenu )

Destroy the menu and its submenus.  Submenus are destroyed recursively.

If you don’t want to destroy submenus first deattach them with MMenu.Remove function or use MMenu.Set with an -m option.

Parameters

MMenu_Count( pMenu )

Get the count of items in the menu

Parameters : pMenu - Menu handle

Returns

Item count

MMenu_Hide()

Closes the currently opened menu.

Examples

To show the context menu for the menu item when it is right clicked you can set up things like this:

;
      mainMenu  := MMenu_Create(),  contextMenu  := MMenu_Create()
      ...
      Mmenu_Show( mainMenu, 0, 0, “OnMainMenuClick, “ROnMainRightClick”)
      ...

      OnMainRightClick:
          MMenu_GetPosition(M_MENU, cX, cY, true)      ;get coordinates of clicked item
          MMenu_Hide()
          SetTimer, LaunchContextMenu, 50          ;allow mmenu to close (show function to return)
      Return

      LaunchContextMenu:
          SetTimer, LaunchContextMenu, off
          MMenu_Show(contextMenu, cX, cY, "OnContextMenuClick")
      Return

MMenu_Show( pMenu,    pX,    pY,    pOnClick,    pHandlers  =  "" )

Show the menu on screen position X, Y.

You can not call Show function while it is already running.

Parameters

Events

Example

 
      MMenu_Show( mainMenu, X, Y, "OnClick", "SOnSelect UOnUninit")
      ...

      OnSelect:
             MMenu_GetPosition(M_SMENU, X, Y)    ; get the position of the currently open menu
             msg := aMyTooltips%M_SID%           ; aMyTooltips is array containing tooltips for eatch item
             Tooltip, %msg%, % X + 5, % Y – 30   ; and display tooltip above the current menu
      Return

      OnUninit:
             Tooltip  ;close the tooltip when the (sub)menu closes
      Return

MMenu_About()

Displays the message containing version and other information.