topic Re: Add menu icon in Archicad C++ API

Add menu icon

Martin Walter — Tue, 24 Sep 2024 07:45:13 GMT

I would like to add an icon to my menu entries:
How can I do this?

Re: Add menu icon

Ralph Wessel — Sun, 16 Feb 2020 22:18:23 GMT

Add the icon resource ID in the menu item resource like this:

"Help^32529"

Re: Add menu icon

Martin Walter — Mon, 17 Feb 2020 18:57:07 GMT

I can't get it working.
No icon pictures show in my menu.

But the image is compiled correctly because in the RO directory appears a buttonVekaCreate&96.ico file.

This is my code:
------------------------------------

in RegisterInterface (void):

err = ACAPI_Register_Menu(ID_MENU_STRINGS1, ID_STATUS_STRINGS1, MenuCode_UserDef, MenuFlag_Default);

------------------------------------

in file .grc:

'STR#' ID_MENU_STRINGS1 "Menu strings" {
/* [  1] */		"WinDoPlan"
/* [  2] */		"Neues Fenster oder Tür^33000"
}
--------------------------------------
in file ...fix.grc:

'GICN' 33000 "buttonVekaCreate icon" {
    "buttonVekaCreate"
}

Re: Add menu icon

Ralph Wessel — Mon, 17 Feb 2020 22:15:05 GMT

How about the format and naming of your source images?

Re: Add menu icon

Martin Walter — Tue, 18 Feb 2020 12:21:09 GMT

I'm working on windows and saved the images into the folder ..\RFIX\Images\
as .png
e.g. buttonVekaCreate.png

and my command for compiling the resources is taken from the examples:

..\APIDevelopmentKit23\Tools\Win\ResConv.exe" -m r -D WINDOWS -T W -q utf8 1252 -i "RINT\$(ProjectName).grc" -D _DEBUG -o "$(OutDir)\RO\$(ProjectName).grc.rc2

Re: Add menu icon

Ralph Wessel — Tue, 18 Feb 2020 12:53:54 GMT

Are you able to confirm that the resources and images are correctly embedded in the built add-on?

Re: Add menu icon

Martin Walter — Tue, 18 Feb 2020 14:29:10 GMT

the file ArchicadPluginFix.grc.rc2 in the RO folder looks like this:


//nclude "DGDefs.h"

/*---- This file was created by GRC compiler --------------------------------------------*/
/*                                                                                       */
/*     Source file: RFIX\ArchicadPluginFix.grc              Code table: NUL              */
/*                                                                                       */
/*---- Version 2.0 - Windows ------------------------------ (c) 1996-2019 by GRAPHISOFT -*/


#include "MDIDs_APICD.h"

32500 MDID
BEGIN
	8, 0,
	0L + 707017037,
	0L + 4022811608
END

I33000&96	ICON "buttonVekaCreate&96.ico"

I33001&96	ICON "buttonVekaChange&96.ico"

I33002&96	ICON "buttonVekaSettings&96.ico"

-------------------------------------

so the icons are created
and I find the files in the RO folder:
buttonVekaChange&96.ico
buttonVekaCreate&96.ico
buttonVekaSettings&96.ico

what else can I check?

Re: Add menu icon

Martin Walter — Fri, 21 Feb 2020 19:53:33 GMT

Obviously this is a BUG in Archicad API.
For the second level menu items the icons are working.
But not for the first level:


'STR#' DGTEST_MENU_STRINGSID "Menu strings" {
/* [   ] */		"Test"
/* [   ] */		"DG Functions^10000"
/* [  1] */			"Fill Settings^EL^10000"
/* [  2] */			"Library Browser^EL^10080"

Re: Add menu icon

dushyant — Fri, 06 Mar 2020 11:59:43 GMT

I am also facing the same issue - not able to get the icon at that level. And looking at ArchiCAD's default menus, icons are visible at that level. So it seems it should be possible..

Re: Add menu icon

Ralph Wessel — Fri, 06 Mar 2020 12:33:54 GMT

I don't think the API allows you to set the icon for the parent item of a sub-menu

Re: Add menu icon

Martin Walter — Sat, 07 Mar 2020 13:41:44 GMT

I finally solved the problem for me.
The indexes are the problem. It is not working this way:

'STR#' ID_MENU_STRINGS_NEW "Menu strings" {
/* [    ] */		"Planersoftware 2.0"
/* [  1] */		"Erstelle neues Fenster oder Tür^32101"
}

But this way:

'STR#' ID_MENU_STRINGS_NEW "Menu strings" {
/* [  1] */		"Planersoftware 2.0"
/* [  2] */		"Erstelle neues Fenster oder Tür^32101"
}

Re: Add menu icon

dushyant — Mon, 09 Mar 2020 09:06:21 GMT

Hi Martin,
I just tried indexing your way (starting from 1 for the main menu), but I'm still not getting the menu-icon.

Dushyant Basson

Re: Add menu icon

Martin Walter — Thu, 12 Mar 2020 13:29:39 GMT

Here is a working example for the first menu level.

Re: Add menu icon

dushyant — Fri, 13 Mar 2020 06:22:23 GMT

In your attached example,
DG_Test.grc has: "DG Functions^10000"
But DG_TestFix.grc has no identifier with 10000.

Re: Add menu icon

Ralph Wessel — Fri, 13 Mar 2020 08:33:41 GMT

Martin wrote:
The indexes are the problem. It is not working this way:
'STR#' ID_MENU_STRINGS_NEW "Menu strings" {
/* [ ] */ "Planersoftware 2.0"
/* [ 1] */ "Erstelle neues Fenster oder Tür^32101"
}

Those aren't indices – they're just comments. The compiler ignores them, so they could contain nothing or not be there at all. We put them in as an easy visual check when referencing the menu items in code, i.e. ensuring the code aligns to the resources.

Re: Add menu icon

dushyant — Fri, 13 Mar 2020 14:22:54 GMT

What guides the indenting of sub-menus? How to control which sub-menu can further have its own sub-menus?

Re: Add menu icon

Ralph Wessel — Fri, 13 Mar 2020 14:35:47 GMT

If you're adding a custom menu, the number of items in the resource determines if it's a single menu item of a submenu. If there's only 2 items, the first is the main menu and the second is the menu item. If more than 2, the first is them main menu, the second is the submenu and any additional items are listed under the submenu. You can't nest menus any deeper than that.
For example:


'STR#' 32510  "Nested Menu" {
	"Main Menu"
	"Submenu"
	"Item 1"
	"Item 2"
	"Item 3"
}


'STR#' 32511  "Single Item" {
	"Main Menu"
	"Item 1"
}

The single menu item and submenu above will both appear under the menu "Main Menu".

Re: Add menu icon

Anonymous — Tue, 22 Jun 2021 22:46:06 GMT

We have our company standards available in our 'JHP' drop down menu and are able to get an icon at the parent level. One thing we have discovered is that the integer used as the reference for the menu item is of type short with a max value of 32767. Your original example, that did not work, uses 33000. The subsequent examples that do work use 32501, 32101, 10000, etc. - - all less than 32767.

Just a guess...