source: trunk/src/3rdparty/os2/xsystray/README@ 503

Extended system tray widget for XCenter/eCenter
Version 0.1.0

Copyright (C) 2009 Dmitry A. Kuminov

Extended system tray widget is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License as
published by the Free Software Foundation, in version 2 as it comes in
the "COPYING" file of the Extended system tray widget distribution. This
program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.



INTRODUCTION

The extended system tray widget is a plugin for XCenter that provides support
for the system tray area in the XCenter bar. This area is commonly used by
long running applications to display their status using graphical icons and to
provide a way to control these applications by clicking on their icons.

There is a number of other tools to implement the described functionality (for
example, SysTray/WPS by Dmitry Zaharov and the XCenter plugin for it by Eugene
Romanenko). The main reason to create yet another implementation is that
existing ones do not provide the level of functionality required by the Qt
toolkit for which this extended implementation was created for.

Note that since the SysTray/WPS API is being already used by a number of OS/2
applications to implement system tray icons (e.g. PM Downloader, CoolFM), the
Extended system tray widget implements this API as well to provide backward
compatibility. See the API file for more information.

The word "extended" in the widget name is used to distinguish from the XCenter
widget by Eugene Romanenko and also to indicate that this one provides some
extended functionality (for example the ability to add any valid icon to the
tray, not only the frame window's icon).



INSTALLATION

In order to manually install the extended system tray widget plugin to XCenter,
copy xsystray.dll to

    <XWorkplace installation folder>\plugins\xcenter\

If you are using eCenter (rebranded XCenter included in the latest eComStation
releases), copy xsystray.dll to

        <Boot drive>:\ecs\system\ewps\plugins\xcenter\

Then you should close all XCenter instances and start them again. The system
tray widget will appear in the widget list under the name "Extended system
tray".



UPGRADING

If you are upgrading from the previous version, you should do the following:

  - Unlock the old xsystray.dll file (for example, using unlock.exe from the
    lxlite package).
  - Overwrite it with the new xsystray.dll file.
  - Restart WPS. Note that restarting XCenter is not enough since the old DLL
    will remain loaded in this case.

The new version should be now picked up automatically.



HISTORY

... unreleased yet ...



CREDITS AND COPYRIGHTS

This product uses code from the XWorkplace project (c) by Ulrich Moeller.

SysTray/WPS is copyright (c) by 1999-2002 OS2.Ru DevTeam.
Syswray widget is copyright (c) by Eugene Romanenko.

Qt is a trademark of Nokia Corporation and/or its subsidiary(-ies).
OS/2 and OS/2 Warp are trademarks of the IBM Corporation and/or its subsidiary(-ies).
eComStation is a trademark of Serenity Systems International and/or its subsidiary(-ies).

Etc.