1<page xmlns="http://projectmallard.org/1.0/" type="topic" id="event_monitor_plugin">
2  <info>
3    <link type="guide" xref="index#examining_a11y" />
4    <title type="sort">4. Event Monitor Plugin</title>
5    <link type="next" xref="quick_select_plugin" />
6    <desc>
7      Monitoring accessible events as they occur
8    </desc>
9    <credit type="author">
10      <name>Eitan Isaacson</name>
11      <email>eitan@ascender.com</email>
12    </credit>
13    <credit type="author">
14      <name>Peter Parente</name>
15      <email>pparent@us.ibm.com</email>
16    </credit>
17    <credit type="author">
18      <name>Aline Bessa</name>
19      <email>alibezz@gmail.com</email>
20    </credit>
21    <license>
22      <p>Creative Commons Share Alike 3.0</p>
23    </license>
24  </info>
25  <title> Event Monitor Plugin</title>
26  <p>
27    The Event Monitor Plugin allows you to view
28    <link href="http://accessibility.linuxfoundation.org/a11yspecs/atspi/adoc/atspi-events.html">AT-SPI events</link>
29    as they occur on the applications exposed in <app>Accerciser</app>'s
30    <link xref="desktop_tree_view">Application Tree View</link>. The plugin is useful to explore the dynamics of an
31    application's interface and verify which accessible widgets are related to which AT-SPI events.
32  </p>
33
34  <figure>
35    <title>Event Monitor Plugin</title>
36    <desc>
37      The Event Monitor Plugin allows you to view AT-SPI events and match them
38      with accessible widgets.
39    </desc>
40    <media type="image" mime="image/png" width="700" height="500" src="figures/event_monitor_plugin.png">
41      <p>
42       The Event Monitor Plugin allows you to view AT-SPI events and match them
43       with accessible widgets.
44      </p>
45    </media>
46  </figure>
47
48  <section id="running_event_monitor_plugin">
49    <title>Running the Event Monitor Plugin</title>
50    <p>
51      When you open the Event Monitor Plugin, you see a list of checkboxes
52      representing all the different AT-SPI event classes covered by the
53      plugin:
54    </p>
55
56    <list>
57      <item>
58        <p>
59          document
60        </p>
61      </item>
62      <item>
63        <p>
64          focus
65        </p>
66      </item>
67      <item>
68        <p>
69          mouse
70        </p>
71      </item>
72      <item>
73        <p>
74          object
75        </p>
76      </item>
77      <item>
78        <p>
79          terminal
80        </p>
81      </item>
82      <item>
83        <p>
84          window
85        </p>
86      </item>
87    </list>
88
89    <p>
90      If you check a class,
91      all of its event types will be monitored by the plugin. The classes
92      are exposed as tree structures; therefore, you can refine your selection
93      by expanding them and checking only the event types you really care about.
94    </p>
95    <p>
96      If you want to monitor all possible types of AT-SPI events, press the <cmd>Select All</cmd>
97      button. Similarly, if you want to clear all currently selected event types,
98      press the <cmd>Clear Selection</cmd> button.
99    </p>
100
101    <note style="tip">
102      <p>
103        Selecting only a few event types per monitoring gives you a clearer output.
104      </p>
105    </note>
106
107    <p>
108      Another way to refine event monitoring is by the event source. By default, the Source option <cmd>Everything</cmd>
109      is selected, indicating that AT-SPI events of all applications will be monitored.
110      If you want to investigate a single application, select it
111      in the Application Tree View and click the Source radio button <cmd>Selected application</cmd>. Likewise,
112      if you want to monitor a single accessible widget and its corresponding descendants,
113      select it in the Application Tree View and click the Source radio button <cmd>Selected accessible</cmd>.
114    </p>
115
116    <p>
117      After selecting event types and specifying a Source option, the Event Monitor Plugin starts
118      monitoring AT-SPI events automatically, because the <cmd>Monitor Events</cmd> button is
119      pressed by default. Whenever you want to stop monitoring, click the <cmd>Monitor Events</cmd>
120      button. To restart monitoring, press this button again.
121    </p>
122
123    <p>
124      For each incoming event, the Event Monitor Plugin indicates the source and the application. Activating the
125      link for either of these items will cause it to become selected in the Application Tree View.
126    </p>
127
128    <p>
129      If you want to save the output generated by the Event Monitor Plugin,
130      just press the <cmd>Save</cmd> button. To clear the output screen, you just need to
131      click the <cmd>Clear</cmd> button.
132    </p>
133  </section>
134</page>
135