Changeset 33298 in vbox

Timestamp:

Oct 21, 2010 11:07:23 AM (14 years ago)

Author:

vboxsync

Message:

Main: fix docs for aggregator API, burn fix

Location:

trunk/src/VBox

Files:

• Frontends/VBoxShell/vboxshell.py (modified) (1 diff)
• Main/idl/VirtualBox.xidl (modified) (1 diff)
• Main/include/EventImpl.h (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxShell/vboxshell.py

@@ -405 +405 @@
     listener = console.eventSource.createListener()
     registered = False
-    # we create an aggregated event source to listen for multiple event types
+    # we create an aggregated event source to listen for multiple event sources (keyboard and mouse in our case)
     agg = console.eventSource.createAggregator([console.keyboard.eventSource, console.mouse.eventSource])
     demo = open(file, 'w')

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -14123 +14123 @@
     <method name="createAggregator">
       <desc>
-        Creates a aggregator event source, collecting events from multiple source.
-        This way single listener can collect events from multiple sources, using
-        getEvent() of this aggregator.
+        Creates a aggregator event source, collecting events from multiple sources.
+        This way single listener can listen for events coming from multiple sources,
+        using single blocking getEvent() of this aggregator.
       </desc>
       <param name="subordinates" type="IEventSource" dir="in" safearray="yes">

trunk/src/VBox/Main/include/EventImpl.h

@@ -155 +155 @@
     // IEventSource methods
     STDMETHOD(CreateListener)(IEventListener ** aListener);
+    STDMETHOD(CreateAggregator)(ComSafeArrayIn(IEventSource*, aSubordinates),
+                                IEventSource **               aAggregator);
     STDMETHOD(RegisterListener)(IEventListener * aListener,
                                 ComSafeArrayIn(VBoxEventType_T, aInterested),