AmiDock and Dockies - Revision history

Costel Mincea: Text replacement - "" to ""

2025-01-26T19:26:20Z

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

← Older revision		Revision as of 19:26, 26 January 2025
Line 47:		Line 47:
	Context menus are dynamically built in response to DOCKYGET_ContextMenu attribute:		Context menus are dynamically built in response to DOCKYGET_ContextMenu attribute:

	<syntaxhighlight>		<syntaxhighlight lang="C" line>
	BOOL DockyGet (struct DockyIFace Self, uint32 msgType, uint32 msgData)		BOOL DockyGet (struct DockyIFace Self, uint32 msgType, uint32 msgData)
	{		{

Roman Kargin: /* Introduction */

2014-05-01T09:27:42Z

Introduction

← Older revision		Revision as of 09:27, 1 May 2014
Line 1:		Line 1:
	= Introduction =		= Introduction =

	AmiDock is a tool to maintain a graphical menu bars (Docks) at the Workbench screen that can be used or to execute other programs from a selection of icons (either in the main Dock or in sub-Docks as specified by the AmiDock preferences), or to handle special kind of application called "Dockies", which can provide different functionality: render different kind of data right into the dock, provide user with a menu related to the ~~docky~~ of choice and so on.		AmiDock is a tool to maintain a graphical menu bars (Docks) at the Workbench screen that can be used or to execute other programs from a selection of icons (either in the main Dock or in sub-Docks as specified by the AmiDock preferences), or to handle special kind of application called "Dockies", which can provide different functionality: render different kind of data right into the dock, provide user with a menu related to the Docky of choice and so on.

	~~Amidock~~ implemented as commodity, and together with being responsible for creating and controlling ~~docks~~ and ~~dockies~~ it provide different functionality such as ARexx support and a rich API by which your Dockies can control most of AmiDock's features.		AmiDock implemented as commodity, and together with being responsible for creating and controlling Docks and Dockies it provide different functionality such as ARexx support and a rich API by which your Dockies can control most of AmiDock's features.

	= What is a Dock and a Docky? =		= What is a Dock and a Docky? =

Roman Kargin: /* What is AmiDock */

2014-05-01T05:20:00Z

What is AmiDock

← Older revision		Revision as of 05:20, 1 May 2014
Line 4:		Line 4:

	Amidock implemented as commodity, and together with being responsible for creating and controlling docks and dockies it provide different functionality such as ARexx support and a rich API by which your Dockies can control most of AmiDock's features.		Amidock implemented as commodity, and together with being responsible for creating and controlling docks and dockies it provide different functionality such as ARexx support and a rich API by which your Dockies can control most of AmiDock's features.

	= What is AmiDock =

	AmiDock is the program responsible for creating and controlling docks and dockies. AmiDock is implemented as a commodity but it's more than just that and provides many features like ARexx support and a rich API by which your Dockies can control most of AmiDock's features.

	= What is a Dock and a Docky? =		= What is a Dock and a Docky? =

Roman Kargin: /* Introduction */

2014-05-01T05:19:25Z

Introduction

← Older revision		Revision as of 05:19, 1 May 2014
Line 1:		Line 1:
	= Introduction =		= Introduction =

	AmiDock is a tool to maintain a graphical menu bars (Docks) at the Workbench screen that can be used or to execute other programs from a selection of icons (either in the main Dock or in sub-Docks as specified by the AmiDock preferences), or to handle special kind of application called "Dockies", which can provide different functionality, render different kind of data right into the dock, provide user with a menu related to the docky of choice and so on.		AmiDock is a tool to maintain a graphical menu bars (Docks) at the Workbench screen that can be used or to execute other programs from a selection of icons (either in the main Dock or in sub-Docks as specified by the AmiDock preferences), or to handle special kind of application called "Dockies", which can provide different functionality: render different kind of data right into the dock, provide user with a menu related to the docky of choice and so on.

			Amidock implemented as commodity, and together with being responsible for creating and controlling docks and dockies it provide different functionality such as ARexx support and a rich API by which your Dockies can control most of AmiDock's features.

	= What is AmiDock =		= What is AmiDock =

Roman Kargin: /* Introduction */

2014-04-29T05:30:50Z

Introduction

← Older revision		Revision as of 05:30, 29 April 2014
Line 1:		Line 1:
	= Introduction =		= Introduction =

	AmiDock is a tool to maintain a graphical menu ~~bar~~ at ~~the bottom of~~ the Workbench screen that can be used to execute other programs from a selection of icons, either in the main Dock or in sub-Docks as specified by the AmiDock preferences.		AmiDock is a tool to maintain a graphical menu bars (Docks) at the Workbench screen that can be used or to execute other programs from a selection of icons (either in the main Dock or in sub-Docks as specified by the AmiDock preferences), or to handle special kind of application called "Dockies", which can provide different functionality, render different kind of data right into the dock, provide user with a menu related to the docky of choice and so on.

	= What is AmiDock =		= What is AmiDock =

Steven Solie at 18:55, 28 April 2014

2014-04-28T18:55:48Z

← Older revision		Revision as of 18:55, 28 April 2014
Line 1:		Line 1:
	{{WIP}}

	= Introduction =		= Introduction =

Steven Solie at 18:55, 28 April 2014

2014-04-28T18:55:36Z

← Older revision		Revision as of 18:55, 28 April 2014
Line 113:		Line 113:
	(8-bit) bitmap provided in the DockyRenderDestination's alpha.RP field.		(8-bit) bitmap provided in the DockyRenderDestination's alpha.RP field.

	= ~~Final~~ ~~Words~~ =		= See Also =

	= Links =

	1. SDK:Documentation/AutoDocs/docky.doc		1. SDK:Documentation/AutoDocs/docky.doc

	2. ~~Sys~~:Documentation/Commodities/AmiDock_Arexx.doc		2. SYS:Documentation/Commodities/AmiDock_Arexx.doc

	3. SDK:Examples/AmiDock/		3. SDK:Examples/AmiDock/

Steven Solie: /* Is there a way to trigger a redraw from outside the docky? */

2014-04-28T18:54:47Z

Is there a way to trigger a redraw from outside the docky?

← Older revision		Revision as of 18:54, 28 April 2014
Line 104:		Line 104:

	You are notified about the task/bit to signal through DOCKYSET_DockyAttention (you would store it in the library base for an easy access by the main program). When your program signals AmiDock, every docky is sent the DOCKYGET_NeedsAttention message, so it is a good idea to use a flag to know if the notification really comes from your program.		You are notified about the task/bit to signal through DOCKYSET_DockyAttention (you would store it in the library base for an easy access by the main program). When your program signals AmiDock, every docky is sent the DOCKYGET_NeedsAttention message, so it is a good idea to use a flag to know if the notification really comes from your program.

			== How does DOCKYGET_SupportsComposite work? ==

			When compositing is enabled, a docky receives a DOCKYGET_SupportsComposite query. If it returns TRUE, it will then receive a DOCKYGET_CompositeMode query to which it can reply either DOCKYCOMPMODE_PreblendedRGB (0) or DOCKYCOMPMODE_RawRGB (1). The former has no advantages over the previous method, but was included for backward compatibility. The latter, however, allows you to directly copy the source ARGB data to the destination bitmap (or buffer) rather than blend it yourself. This way, it will be AmiDock itself that does the blending (once) without the need to undo the
			previous blending to get the raw RGB data.

			One thing to take into account when using this method, though, is that on a 16-bit screen you will get an actual 16-bit destination bitmap, not 32-bit as it happens when returning FALSE to DOCKYGET_SupportsComposite. In this case, you will need to write the alpha channel separately to the
			(8-bit) bitmap provided in the DockyRenderDestination's alpha.RP field.

	= Final Words =		= Final Words =

Steven Solie: /* FAQ */

2014-04-28T18:51:16Z

FAQ

← Older revision		Revision as of 18:51, 28 April 2014
Line 39:		Line 39:
	= FAQ =		= FAQ =

	~~''Q:~~ Is it possible to create an application docky and then update its content on the fly and how ?		== Is it possible to create an application docky and then update its content on the fly and how? ==

	A: Set the icon type to APPICONT_Docky; but you'll need to create a real docky as well then. If it doesn't need to be truly active it is possible just to change the icon's imagery (I think you have to un-register/re-register to get it to change though, so no good for frequent changes)		Set the icon type to APPICONT_Docky; but you'll need to create a real docky as well then. If it doesn't need to be truly active it is possible just to change the icon's imagery (I think you have to un-register/re-register to get it to change though, so no good for frequent changes)

		⚫	== I have successfully drawn a datatype (a picture) in a Docky and the picture file has more than 256 colors but it is rendered in 256 colors only. Why? ==

		⚫	Just add PDTA_DestMode, PMODE_V43 to the NewDTObject call. You might also want to add DTA_GroupID, GID_PICTURE in order to restrict the file type to pictures.
⚫	~~''Q:~~ I have successfully drawn a datatype (a picture) in a Docky and the picture file has more than 256 colors, but it is rendered in 256 colors only. Why ?

			== How are context menus created? ==
⚫	A: Just add PDTA_DestMode, PMODE_V43 to the NewDTObject call. You might also want to add DTA_GroupID, GID_PICTURE in order to restrict the file type to pictures.

		⚫	Context menus are dynamically built in response to DOCKYGET_ContextMenu attribute:

	''Q: How are context menus created? I don't see any contextmenu example in the SDK examples, but DOCKYGET_ContextMenu takes en Object * as data. What kind of Object are we talking about?

⚫	A: Context menus are dynamically built in response to DOCKYGET_ContextMenu attribute:

	<syntaxhighlight>		<syntaxhighlight>
Line 93:		Line 91:
	</syntaxhighlight>		</syntaxhighlight>

		⚫	== How do you use an alpha layer for a Docky? ==

		⚫	On non-composited screens, AmiDock uses a "fake" transparency effect (i.e. the bitmap is filled with the contents of the window behind the dock), meaning that you can only add things over the background but you cannot render half or totally transparent contents without doing the blending at the same time (or you'll lose background information).
⚫	~~''Q:~~ How to use ~~Alpha~~ layer for ~~Docky~~ ?

⚫	A: On non-composited screens, AmiDock uses a "fake" transparency effect (i.e. the bitmap is filled with the contents of the window behind the dock), meaning that you can only add things over the background but you cannot render half or totally transparent contents without doing the blending at the same time (or you'll lose background information).

	So if you want to support this configuration you need to follow this rule or provide an alternate rendering if you want to do fancy stuff when compositing is enabled.		So if you want to support this configuration you need to follow this rule or provide an alternate rendering if you want to do fancy stuff when compositing is enabled.
Line 102:		Line 99:
	Now, what you are trying to do should work on composited screens, but you have to tell AmiDock that you are using composited mode (see DOCKYGET_SupportsComposite and DOCKYGET_CompositeMode) so that it does not try to de-multiply the docky bitmap. Also I'm not sure you can use legacy pens to fill alpha channel, you're better off with direct ARGB painting (see SetRPAttrs() with RPTAG_APenColor).		Now, what you are trying to do should work on composited screens, but you have to tell AmiDock that you are using composited mode (see DOCKYGET_SupportsComposite and DOCKYGET_CompositeMode) so that it does not try to de-multiply the docky bitmap. Also I'm not sure you can use legacy pens to fill alpha channel, you're better off with direct ARGB painting (see SetRPAttrs() with RPTAG_APenColor).

		⚫	== Is there a way to trigger a redraw from outside the docky? ==

		⚫	Use DOCKYGET_NeedsAttention for this. This is how a docky can be notified from an external task by signaling AmiDock process. Quite straightforward, this is how e.g. [http://os4depot.net/share/utility/docky/winbar-docky.lha winbar.docky] ([http://os4depot.net/share/utility/docky/winbar_docky_src.zip source code is here], prefsobjects_macro.h include file which is required [http://openamiga.org/attachment/project/29/prefsobjects_macros.h here]) is told to rethink its layout in response to a change in preferences, or Intuition windows list. A shared structure and [[Exec_Mutexes\|Mutex]] to protect the data. By the way, winbar.docky source code can be helpful not only for that, but for all other things such as adding context menus, firing requests to AmiDock or other of the many still undocumented features of the API.
⚫	~~''Q:~~ Is there a way to trigger a redraw from outside the docky ?

⚫	A: Use DOCKYGET_NeedsAttention for this. This is how a docky can be notified from an external task by signaling AmiDock process. Quite straightforward, this is how e.g. [http://os4depot.net/share/utility/docky/winbar-docky.lha winbar.docky] ([http://os4depot.net/share/utility/docky/winbar_docky_src.zip source code is here], prefsobjects_macro.h include file which is required [http://openamiga.org/attachment/project/29/prefsobjects_macros.h here]) is told to rethink its layout in response to a change in preferences, or Intuition windows list. A shared structure and [[Exec_Mutexes\|Mutex]] to protect the data. By the way, winbar.docky source code can be helpful not only for that, but for all other things such as adding context menus, firing requests to AmiDock or other of the many still undocumented features of the API.

	~~I.e. you~~ are notified about the task/bit to signal through DOCKYSET_DockyAttention (you would store it in the library base for an easy access by the main program). When your program signals AmiDock, every docky is sent the DOCKYGET_NeedsAttention message, so it is a good idea to use a flag to know if the notification really comes from your program.		You are notified about the task/bit to signal through DOCKYSET_DockyAttention (you would store it in the library base for an easy access by the main program). When your program signals AmiDock, every docky is sent the DOCKYGET_NeedsAttention message, so it is a good idea to use a flag to know if the notification really comes from your program.

	= Final Words =		= Final Words =

Steven Solie at 18:46, 28 April 2014

2014-04-28T18:46:09Z

← Older revision		Revision as of 18:46, 28 April 2014
Line 30:		Line 30:

	To sum up in "standalone dockies" the docky itself is the application (the only reason of existence of the application is the docky) while for "AppDockIcon dockies" the docky is just a graphical representation of a bigger application (the docky is just here to add user friendliness or visual feedback of the surrounding application)		To sum up in "standalone dockies" the docky itself is the application (the only reason of existence of the application is the docky) while for "AppDockIcon dockies" the docky is just a graphical representation of a bigger application (the docky is just here to add user friendliness or visual feedback of the surrounding application)

	= AmiDock's API =

	= Different types of Dockies =

	== Standalone Dockies ==

	== Application Dockies ==

	= How to create and manipulate a simple docky =		= How to create and manipulate a simple docky =