20.1 Overview

Plugins that have the capability flag HWPLUG_CAPS_REQUESTERADAPTER set can replace Hollywood's inbuilt requester handler with their customized version. If you're writing a display adapter using an alternative toolkit, it might be good idea to also use the requester facilities of this toolkit for consistency reasons and an overall more polished appearance.

Please note that requester adapters are not automatically initialized when Hollywood loads the plugin. Instead, you have to manually call hw_SetRequesterAdapter() in your RequirePlugin() function to activate the requester adapter. The requester adapter will then only be activated if the user calls @REQUIRE on your plugin. Otherwise, Hollywood will use its default requester handler. See Auto and manual plugin initialization for details.

You don't have to implement all functions offered by the requester adapter API. Many functions are optional and only have to be implemented if you explicitly request their use in your call to hw_SetRequesterAdapter(). However, it is mandatory that all functions defined by the display adapter API are declared so that Hollywood can import their symbols when it loads the plugin. Functions that are optional and that you don't enable via hw_SetRequesterAdapter() can just be dummies then. Here is an overview of all requester adapter APIs that are optional:

SystemRequest()
Only used if activated by setting HWSRAFLAGS_SYSTEMREQUEST.

FileRequest()
Only used if activated by setting HWSRAFLAGS_FILEREQUEST.

PathRequest()
Only used if activated by setting HWSRAFLAGS_PATHREQUEST.

StringRequest()
Only used if activated by setting HWSRAFLAGS_STRINGREQUEST.

ListRequest()
Only used if activated by setting HWSRAFLAGS_LISTREQUEST.

FontRequest()
Only used if activated by setting HWSRAFLAGS_FONTREQUEST.

ColorRequest()
Only used if activated by setting HWSRAFLAGS_COLORREQUEST.

See hw_SetRequesterAdapter for information on how to install your requester adapter.

This plugin type is supported since Hollywood 6.0.


Show TOC