BOOPSI Popup Menus - Part 2 - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:24:52Z

Text replacement - "<syntaxhighlight>" to "<syntaxhighlight lang="C" line>"

← Older revision		Revision as of 19:24, 26 January 2025
Line 17:		Line 17:
	The adding of custom options is done via the "Hook" method, and the hook function should use the standard popupmenu.class way of adding items. The hook function is called like so:		The adding of custom options is done via the "Hook" method, and the hook function should use the standard popupmenu.class way of adding items. The hook function is called like so:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	LONG PopupHook( struct Hook *hook, APTR o, UNUSED APTR reserved )		LONG PopupHook( struct Hook *hook, APTR o, UNUSED APTR reserved )
	</syntaxhighlight>		</syntaxhighlight>
Line 32:		Line 32:
	So, let's have a look at an example hook function that will add a separator and one custom item to the popup menu:		So, let's have a look at an example hook function that will add a separator and one custom item to the popup menu:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	LONG PopupHook( struct Hook *hook, APTR o, UNUSED APTR reserved )		LONG PopupHook( struct Hook *hook, APTR o, UNUSED APTR reserved )
	{		{
Line 77:		Line 77:
	Once you have your hook function created and adding the items that you require, window.class needs to know about it. We do this by initialising a struct Hook, and adding our hook function to it. The code for that can be like so:		Once you have your hook function created and adding the items that you require, window.class needs to know about it. We do this by initialising a struct Hook, and adding our hook function to it. The code for that can be like so:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	struct Hook *popuphook;		struct Hook *popuphook;
	popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,		popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,
Line 90:		Line 90:
	Obviously, do not forget to		Obviously, do not forget to

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	IExec->FreeSysObject( ASOT_HOOK, mypopuphook );		IExec->FreeSysObject( ASOT_HOOK, mypopuphook );
	</syntaxhighlight>		</syntaxhighlight>
Line 98:		Line 98:
	In part one, we showed how to expand the window event loop to receive the new screen jumping event. In a similar vein, we also need to add a new event type so that we may be notified that the user selected one of our custom menu items. We do this by testing for the WMHI_POPUPMENU event. The enhanced event loop will now look like so:		In part one, we showed how to expand the window event loop to receive the new screen jumping event. In a similar vein, we also need to add a new event type so that we may be notified that the user selected one of our custom menu items. We do this by testing for the WMHI_POPUPMENU event. The enhanced event loop will now look like so:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	while( !done )		while( !done )
	{		{
Line 129:		Line 129:
	Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would be something like this to detect the menu item selected:		Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would be something like this to detect the menu item selected:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	case WMHI_POPUPMENU:		case WMHI_POPUPMENU:
	{		{

Simon Archer at 13:41, 13 October 2013

2013-10-13T13:41:23Z

← Older revision		Revision as of 13:41, 13 October 2013
Line 149:		Line 149:
	A fully working example with source code can be downloaded from [http://codebench.co.uk/os4coding/WindowPopup.lha here], which should give you a good indication of how to adapt your code. You will not be able to compile this code just yet, as a newer SDK will be required than that which is available at the time of writing.		A fully working example with source code can be downloaded from [http://codebench.co.uk/os4coding/WindowPopup.lha here], which should give you a good indication of how to adapt your code. You will not be able to compile this code just yet, as a newer SDK will be required than that which is available at the time of writing.

			In part 3, we will take a look at some extra functionality that has been added to window.class, and allows saving of window positions. For now, this is purely for reference only, as it will require a newer version of window.class than is currently publicly available.
	Thanks for looking.

Simon Archer at 13:38, 13 October 2013

2013-10-13T13:38:21Z

← Older revision		Revision as of 13:38, 13 October 2013
Line 147:		Line 147:

	We hope you have found this look at the popupmenu feature of window.class useful. Obviously the example code above is not complete, it is merely to show how the application programmer can go about using this new feature, and the steps required.		We hope you have found this look at the popupmenu feature of window.class useful. Obviously the example code above is not complete, it is merely to show how the application programmer can go about using this new feature, and the steps required.
	A fully working example with source code can be downloaded from here, which should give you a good indication of how to adapt your code. You will not be able to compile this code just yet, as a newer SDK will be required than that which is available at the time of writing.		A fully working example with source code can be downloaded from [http://codebench.co.uk/os4coding/WindowPopup.lha here], which should give you a good indication of how to adapt your code. You will not be able to compile this code just yet, as a newer SDK will be required than that which is available at the time of writing.

	Thanks for looking.		Thanks for looking.

Simon Archer at 13:33, 13 October 2013

2013-10-13T13:33:49Z

← Older revision		Revision as of 13:33, 13 October 2013
Line 86:		Line 86:
	</syntaxhighlight>		</syntaxhighlight>

	This hook now gets passed to the window.class a by passing WINDOW_PopupHook, mypopuphook in the tags when the window object is created.		This hook now gets passed to the window.class by passing WINDOW_PopupHook, mypopuphook in the tags when the window object is created.

	Obviously, do not forget to		Obviously, do not forget to
Line 127:		Line 127:
	</syntaxhighlight>		</syntaxhighlight>

	Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would something like this to detect the menu item selected:		Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would be something like this to detect the menu item selected:

	<syntaxhighlight>		<syntaxhighlight>

Simon Archer at 13:26, 13 October 2013

2013-10-13T13:26:00Z

← Older revision		Revision as of 13:26, 13 October 2013
Line 11:		Line 11:
	= Overview =		= Overview =

	The popup menu available from the window objects title bar is not designed to be a replacement for the applications menus, it is purely to offer the user some options which are applicable to the window object the menu is attached to. Such options could be offering a "Snapshot" facility where the application could save the current window size and position so that it will always open in the same place and be the same size more on that in part 3). Whatever the options, they should be relevant to the window and its operation. Remember, users are easily confused, so make your custom options simple and plainly obvious!		The popup menu available from the window objects title bar is not designed to be a replacement for the applications menus, it is purely to offer the user some options which are applicable to the window object the menu is attached to. Such options could be offering a "Snapshot" facility where the application could save the current window size and position so that it will always open in the same place and be the same size (''more on that in part 3''). Whatever the options, they should be relevant to the window and its operation. Remember, users are easily confused, so make your custom options simple and plainly obvious!

	= Adding items =		= Adding items =

Simon Archer at 13:25, 13 October 2013

2013-10-13T13:25:34Z

← Older revision		Revision as of 13:25, 13 October 2013
Line 11:		Line 11:
	= Overview =		= Overview =

	The popup menu available from the window objects title bar is not designed to be a replacement for the applications menus, it is purely to offer the user some options which are applicable to the window object the menu is attached to. Such options could be offering a "Snapshot" facility where the application could save the current window size and position so that it will always open in the same place and be the same size. Whatever the options, they should be ~~relevent~~ to the window and its operation. Remember, users are easily confused, so make your custom options simple and plainly obvious!		The popup menu available from the window objects title bar is not designed to be a replacement for the applications menus, it is purely to offer the user some options which are applicable to the window object the menu is attached to. Such options could be offering a "Snapshot" facility where the application could save the current window size and position so that it will always open in the same place and be the same size more on that in part 3). Whatever the options, they should be relevant to the window and its operation. Remember, users are easily confused, so make your custom options simple and plainly obvious!

	= Adding items =		= Adding items =

Benjamin West: /* Specifying your hook */

2013-07-11T12:31:49Z

Specifying your hook

← Older revision		Revision as of 12:31, 11 July 2013
Line 80:		Line 80:
	struct Hook *popuphook;		struct Hook *popuphook;
	popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,		popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,
	~~ASOHOOK~~, mypopupfunction,		ASOHOOK_Entry, mypopupfunction,
	~~ASOHOOK_SubEntry~~, NULL,		ASOHOOK_Subentry, NULL,
	ASOHOOK_Data, mydatapointer,		ASOHOOK_Data, mydatapointer,
	TAG_END );		TAG_END );

Steven Solie at 21:10, 13 May 2013

2013-05-13T21:10:45Z

← Older revision		Revision as of 21:10, 13 May 2013
Line 41:		Line 41:
	if(( item = IIntuition->NewObject( IPopupMenu->POPUPMENU_GetItemClass(), NULL,		if(( item = IIntuition->NewObject( IPopupMenu->POPUPMENU_GetItemClass(), NULL,
	PMIA_WideTitleBar, TRUE,		PMIA_WideTitleBar, TRUE,
	~~TAG_DONE~~ )))		TAG_END )))
	{		{
	if(!( IIntuition->IDoMethod( o, PM_INSERT, item, ~0 )))		if(!( IIntuition->IDoMethod( o, PM_INSERT, item, ~0 )))
Line 55:		Line 55:
	PMIA_Title, (ULONG) "Snapshot",		PMIA_Title, (ULONG) "Snapshot",
	PMIA_ID, (ULONG)ID_SNAPSHOT,		PMIA_ID, (ULONG)ID_SNAPSHOT,
	~~TAG_DONE~~ )))		TAG_END )))
	{		{
	if(!( IIntuition->IDoMethod( o, PM_INSERT, item, ~0 )))		if(!( IIntuition->IDoMethod( o, PM_INSERT, item, ~0 )))
Line 83:		Line 83:
	ASOHOOK_SubEntry, NULL,		ASOHOOK_SubEntry, NULL,
	ASOHOOK_Data, mydatapointer,		ASOHOOK_Data, mydatapointer,
	~~TAG_DONE~~ );		TAG_END );
	</syntaxhighlight>		</syntaxhighlight>

Steven Solie: /* Getting custom menu item events */

2012-05-01T15:55:28Z

Getting custom menu item events

← Older revision		Revision as of 15:55, 1 May 2012
Line 98:		Line 98:
	In part one, we showed how to expand the window event loop to receive the new screen jumping event. In a similar vein, we also need to add a new event type so that we may be notified that the user selected one of our custom menu items. We do this by testing for the WMHI_POPUPMENU event. The enhanced event loop will now look like so:		In part one, we showed how to expand the window event loop to receive the new screen jumping event. In a similar vein, we also need to add a new event type so that we may be notified that the user selected one of our custom menu items. We do this by testing for the WMHI_POPUPMENU event. The enhanced event loop will now look like so:

			<syntaxhighlight>
	<pre>
	while( !done )		while( !done )
	{		{
Line 125:		Line 125:
	}		}
	}		}
			</syntaxhighlight>
	</pre>

	Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would something like this to detect the menu item selected:		Earlier we mentioned about supplying meaningful menu item IDs, and this is where they play their part. Once your event loop detects the WMHI_POPUPMENU event, we can get the ID of the menu item selected by using the WMHI_GADGETMASK just like we would for gadgets. Taking our example hook function above into account, the event loop code would something like this to detect the menu item selected:

			<syntaxhighlight>
	<pre>
	case WMHI_POPUPMENU:		case WMHI_POPUPMENU:
	{		{
Line 142:		Line 142:
	break;		break;
	}		}
			</syntaxhighlight>
	</pre>

	= Summary =		= Summary =

Steven Solie: /* Specifying your hook */

2012-05-01T15:55:02Z

Specifying your hook

← Older revision		Revision as of 15:55, 1 May 2012
Line 77:		Line 77:
	Once you have your hook function created and adding the items that you require, window.class needs to know about it. We do this by initialising a struct Hook, and adding our hook function to it. The code for that can be like so:		Once you have your hook function created and adding the items that you require, window.class needs to know about it. We do this by initialising a struct Hook, and adding our hook function to it. The code for that can be like so:

			<syntaxhighlight>
	<pre>
	struct Hook *popuphook;		struct Hook *popuphook;
	popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,		popuphook = IExec->AllocSysObjectTags( ASOT_HOOK,
Line 84:		Line 84:
	ASOHOOK_Data, mydatapointer,		ASOHOOK_Data, mydatapointer,
	TAG_DONE );		TAG_DONE );
			</syntaxhighlight>
	</pre>

	This hook now gets passed to the window.class a by passing WINDOW_PopupHook, mypopuphook in the tags when the window object is created.		This hook now gets passed to the window.class a by passing WINDOW_PopupHook, mypopuphook in the tags when the window object is created.
Line 90:		Line 90:
	Obviously, do not forget to		Obviously, do not forget to

			<syntaxhighlight>
	<pre>
	IExec->FreeSysObject( ASOT_HOOK, mypopuphook );		IExec->FreeSysObject( ASOT_HOOK, mypopuphook );
			</syntaxhighlight>
	</pre>

	= Getting custom menu item events =		= Getting custom menu item events =