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

Timestamp:

Mar 18, 2011, 10:45:50 PM (14 years ago)

Author:

Dmitry A. Kuminov

Message:

xsystray: Finished r837.

File:

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

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

@@ -108 +108 @@
  */
 
-XSTAPI(BOOL, xstQuerySysTrayVersion)(PULONG pulMajor, PULONG pulMinor,
-                                     PULONG pulRevision);
+XSTAPI(BOOL, xstQuerySysTrayVersion)
+    (PULONG pulMajor,     // out: major version number
+     PULONG pulMinor,     // out: minor version number
+     PULONG pulRevision); // out: revision number
 
 /*
@@ -152 +154 @@
  */
 
-XSTAPI(BOOL, xstAddSysTrayIcon)(HWND hwnd, USHORT usId, HPOINTER hIcon,
-                                PCSZ pcszToolTip, ULONG ulMsgId, ULONG ulFlags);
+XSTAPI(BOOL, xstAddSysTrayIcon)
+    (HWND hwnd,       // in: window handle associated with the icon
+     USHORT usId,     // in: icon ID to add
+     HPOINTER hIcon,  // in: icon handle
+     PCSZ pcszToolTip,// in: tooltip text
+     ULONG ulMsgId,   // in: message ID for notifications
+     ULONG ulFlags);  // in: flags (not currently used, must be 0)
 
 /*
@@ -164 +171 @@
  */
 
-XSTAPI(BOOL, xstReplaceSysTrayIcon)(HWND hwnd, USHORT usId, HPOINTER hIcon);
+XSTAPI(BOOL, xstReplaceSysTrayIcon)
+    (HWND hwnd,       // in: window handle associated with the icon
+     USHORT usId,     // in: icon ID to change
+     HPOINTER hIcon); // in: new icon handle
 
 /*
@@ -175 +185 @@
  */
 
-XSTAPI(BOOL, xstRemoveSysTrayIcon)(HWND hwnd, USHORT usId);
+XSTAPI(BOOL, xstRemoveSysTrayIcon)
+    (HWND hwnd,    // in: window handle associated with the icon
+     USHORT usId); // in: icon ID to remove
 
 /*
@@ -194 +206 @@
  */
 
-XSTAPI(BOOL, xstSetSysTrayIconToolTip)(HWND hwnd, USHORT usId, PCSZ pcszToolTip);
+XSTAPI(BOOL, xstSetSysTrayIconToolTip)
+    (HWND hwnd,         // in: window handle associated with the icon
+     USHORT usId,       // in: icon ID to set the tooltip for
+     PCSZ pcszToolTip); // in: tooltip text
 
 /*
@@ -203 +218 @@
 
 XSTAPI(BOOL, xstShowSysTrayIconBalloon)(HWND hwnd, USHORT usId, PCSZ pcszTitle,
-                                      PCSZ pcszText, ULONG ulFlags,
-                                      ULONG ulTimeout);
+                                      PCSZ pcszText, ULONG ulFlags,
+                                      ULONG ulTimeout);
 
 /*
@@ -223 +238 @@
  */
 
-XSTAPI(BOOL, xstQuerySysTrayIconRect)(HWND hwnd, USHORT usId, PRECTL prclRect);
+XSTAPI(BOOL, xstQuerySysTrayIconRect)
+    (HWND hwnd,        // in: window handle associated with the icon
+     USHORT usId,      // in: icon ID to query the rectangle for
+     PRECTL prclRect); // out: where to store the returned rectangle
 
 /*