[lttv.git] / ltt / branches / poly / doc / user / guiEvents.txt

|-----------------------------------------|
|Graphical Event Viewer Plugin User Manual|
|-----------------------------------------|

This viewers shows a list of the events that are included in the currently
viewed time interval. This is a detailed manner of seeing each event's
information.

Showing this viewer is as simple as adding it to the current tab by selecting
the Insert Event Viewer menu item from the Tools menu or by clicking on
this viewer's Insertion Button. You can then use up/down arrows buttons and
delete button when the viewer is selected to change it's position in the
tab or remove it.

It them appears in the current tab. If there are events to display in the
current time frame selected by the tab, you should already see them in the
list. You can move the scrollbar on the left side up and down to display
the different events in the list. As you can see, this list is limited to
the currently viewed time interval. In order to see more events in this
list, you can use a Zoom Extended of the main window (this will show all
the trace's events). You can also specify the laps of time you want to see
using Show Time Frame.

One important feature of this plugin is the ability to inform the tab in
which it resides of the currently selected event. By clicking on an event,
it will appear highlighted in the list and this event will then become the
current event.

The events shown are selected by the filters applied on them. Hence, you can
configure the viewer's associated filter using various criterias in order
to select the events you want to show.

By clicking on the viewer with the right mouse button, a popup menu appears,
giving the opportunity to configure the viewer's filter or to configure
the viewer itself. Configuration of the filter will be explained in another
document, but event viewer's configuration follows.

The viewer's configuration window permits a selection of the fields that
must be displayed in the event viewer. There are fields which can always be
selected, as, for example, event type or time of the event, while there are
fields that are specific to the event types present in the trace. A browse
list, following the nested architecture of the description of events, will
show all the available fields on the left. A list at the right side will
list all the currently selectied fields. Two arrows in the middle of the
two lists can be used to add or remove a field from the shown fields list.
Commit	Line	Data
56e159f2	1	\|-----------------------------------------\|
	2	\|Graphical Event Viewer Plugin User Manual\|
	3	\|-----------------------------------------\|
	4
eebf2d0f	5	This viewers shows a list of the events that are included in the currently
	6	viewed time interval. This is a detailed manner of seeing each event's
	7	information.
56e159f2	8
eebf2d0f	9	Showing this viewer is as simple as adding it to the current tab by selecting
	10	the Insert Event Viewer menu item from the Tools menu or by clicking on
	11	this viewer's Insertion Button. You can then use up/down arrows buttons and
	12	delete button when the viewer is selected to change it's position in the
	13	tab or remove it.
56e159f2	14
eebf2d0f	15	It them appears in the current tab. If there are events to display in the
	16	current time frame selected by the tab, you should already see them in the
	17	list. You can move the scrollbar on the left side up and down to display
	18	the different events in the list. As you can see, this list is limited to
	19	the currently viewed time interval. In order to see more events in this
	20	list, you can use a Zoom Extended of the main window (this will show all
	21	the trace's events). You can also specify the laps of time you want to see
	22	using Show Time Frame.
56e159f2	23
eebf2d0f	24	One important feature of this plugin is the ability to inform the tab in
	25	which it resides of the currently selected event. By clicking on an event,
	26	it will appear highlighted in the list and this event will then become the
	27	current event.
56e159f2	28
eebf2d0f	29	The events shown are selected by the filters applied on them. Hence, you can
	30	configure the viewer's associated filter using various criterias in order
	31	to select the events you want to show.
56e159f2	32
eebf2d0f	33	By clicking on the viewer with the right mouse button, a popup menu appears,
	34	giving the opportunity to configure the viewer's filter or to configure
	35	the viewer itself. Configuration of the filter will be explained in another
	36	document, but event viewer's configuration follows.
56e159f2	37
eebf2d0f	38	The viewer's configuration window permits a selection of the fields that
	39	must be displayed in the event viewer. There are fields which can always be
	40	selected, as, for example, event type or time of the event, while there are
	41	fields that are specific to the event types present in the trace. A browse
	42	list, following the nested architecture of the description of events, will
	43	show all the available fields on the left. A list at the right side will
	44	list all the currently selectied fields. Two arrows in the middle of the
	45	two lists can be used to add or remove a field from the shown fields list.