Changeset 837 for trunk/src/3rdparty/os2/xsystray/apilib/xsystray.h

Timestamp:

Mar 18, 2011, 2:28:54 AM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

xsystray: Moved instant API documentation from .c to xsystray.h and bumped the version number to 0.1.1 due to r836.

File:

• trunk/src/3rdparty/os2/xsystray/apilib/xsystray.h (modified) (3 diffs)

trunk/src/3rdparty/os2/xsystray/apilib/xsystray.h

@@ -13 +13 @@
  *      Refer to the "API" file for more details about the public API.
  *
- *      Copyright (C) 2009 Dmitry A. Kuminov
+ *      Copyright (C) 2009 Kuminov
  *
  *      This file is part of the Extended system tray widget source package.
@@ -81 +81 @@
 } XSTWHEELMSG, *PXSTWHEELMSG;
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 BOOL XSTAPI xstQuerySysTrayVersion(PULONG pulMajor, PULONG pulMinor,
                                    PULONG pulRevision);
-                                    
+
+/*
+ *@@ xstAddSysTrayIcon:
+ *
+ *      Adds an icon for the given window handle to the system tray. The icon ID
+ *      is used to distinguish between several icons for the same window handle.
+ *      If the icon with the specified ID already exists in the system tray, it
+ *      will be replaced.
+ *
+ *      Returns TRUE on success and FALSE otherwise.
+ *
+ *      The specified window handle receives notification messages about icon
+ *      events using the message ID specified by the ulMsgId parameter. The
+ *      layout of the message parameters is as follows:
+ *
+ *          param1
+ *              USHORT  usIconID        icon ID
+ *              USHORT  usNotifyCode    notify code, one of XST_IN_ constants
+ *
+ *          param2
+ *              PVOID   pData           notify code specific data (see below)
+ *
+ *      The following notify codes are currently recognized:
+ *
+ *          XST_IN_MOUSE:
+ *              Mouse event in the icon area. Currently, only mouse click
+ *              messages are recognized. param2 is a pointer to the XSTMOUSEMSG
+ *              structure containing full mouse message details.
+ *
+ *          XST_IN_CONTEXT:
+ *              Context menu event in the icon area. param2 is a pointer to the
+ *              XSTCONTEXTMSG structure containing full message details.
+ *
+ *          XST_IN_WHEEL:
+ *              Mouse wheel event in the icon area. param2 is a pointer to the
+ *              XSTWHEELTMSG structure containing full message details.
+ *
+ *      NOTE: The maximum tooltip text length (including terminating null) is
+ *      limited to a value returned by xstGetSysTrayMaxTextLen(). If the
+ *      supplied string is longer, it will be truncated.
+ */
+
 BOOL XSTAPI xstAddSysTrayIcon(HWND hwnd, USHORT usId, HPOINTER hIcon,
                               PCSZ pcszToolTip, ULONG ulMsgId, ULONG ulFlags);
-                               
+
+/*
+ *@@ xstReplaceSysTrayIcon:
+ *
+ *      Replaces the existing icon previously added by xstAddSysTrayIcon() with
+ *      a new icon.
+ *
+ *      Returns TRUE on success and FALSE otherwise.
+ */
+
 BOOL XSTAPI xstReplaceSysTrayIcon(HWND hwnd, USHORT usId, HPOINTER hIcon);
 
+
+
+
+
+
+
+
+
+
 BOOL XSTAPI xstRemoveSysTrayIcon(HWND hwnd, USHORT usId);
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 BOOL XSTAPI xstSetSysTrayIconToolTip(HWND hwnd, USHORT usId, PCSZ pcszToolTip);
+
+
+
+
+
+
 
 BOOL XSTAPI xstShowSysTrayIconBalloon(HWND hwnd, USHORT usId, PCSZ pcszTitle,
@@ -97 +195 @@
                                       ULONG ulTimeout);
 
+
+
+
+
+
+
 BOOL XSTAPI xstHideSysTrayIconBalloon(HWND hwnd, USHORT usId);
 
+
+
+
+
+
+
+
+
+
 BOOL XSTAPI xstQuerySysTrayIconRect(HWND hwnd, USHORT usId, PRECTL prclRect);
 
+
+
+
+
+
+
+
+
+
+
+
+
 ULONG XSTAPI xstGetSysTrayCreatedMsgId();
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 ULONG XSTAPI xstGetSysTrayMaxTextLen();