~ubuntu-branches/ubuntu/oneiric/valkyrie/oneiric

« back to all changes in this revision

Viewing changes to doc/mainwindow.html

  • Committer: Bazaar Package Importer
  • Author(s): Hai Zaar
  • Date: 2009-05-06 14:48:00 UTC
  • Revision ID: james.westby@ubuntu.com-20090506144800-vw617m4d4qa2pam3
Tags: upstream-1.4.0
Import upstream version 1.4.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head>
 
3
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 
4
<title>2.�The Main Window</title>
 
5
<link rel="stylesheet" href="valkyrie.css" type="text/css">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.65.1">
 
7
<link rel="home" href="index.html" title="Valkyrie Documentation">
 
8
<link rel="up" href="manual.html" title="Valkyrie User Manual">
 
9
<link rel="previous" href="intro.why_valkyrie.html" title="1.2.�Why Valkyrie is thusly named">
 
10
<link rel="next" href="mainwindow.vg_ctl_tool_bar.html" title="2.2.�Valgrind Control ToolBar">
 
11
</head>
 
12
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
13
<div><table class="nav" width="100%" cellspacing="3" cellpadding="3" border="0" summary="Navigation header"><tr>
 
14
<td width="22px" align="center" valign="middle"><a accesskey="p" href="intro.why_valkyrie.html"><img src="images/prev.png" width="18" height="21" border="0" alt="Prev"></a></td>
 
15
<td width="25px" align="center" valign="middle"><a accesskey="u" href="manual.html"><img src="images/up.png" width="21" height="18" border="0" alt="Up"></a></td>
 
16
<td width="31px" align="center" valign="middle"><a accesskey="h" href="index.html"><img src="images/home.png" width="27" height="20" border="0" alt="Up"></a></td>
 
17
<th align="center" valign="middle">Valkyrie User Manual</th>
 
18
<td width="22px" align="center" valign="middle"><a accesskey="n" href="mainwindow.vg_ctl_tool_bar.html"><img src="images/next.png" width="18" height="21" border="0" alt="Next"></a></td>
 
19
</tr></table></div>
 
20
<div class="chapter" lang="en">
 
21
<div class="titlepage">
 
22
<div><div><h2 class="title">
 
23
<a name="mainwindow"></a>2.�The Main Window</h2></div></div>
 
24
<div></div>
 
25
</div>
 
26
<div class="toc">
 
27
<p><b>Table of Contents</b></p>
 
28
<dl>
 
29
<dt><span class="sect1"><a href="mainwindow.html#menu_bar">2.1. The MenuBar</a></span></dt>
 
30
<dd><dl>
 
31
<dt><span class="sect2"><a href="mainwindow.html#file_menu">2.1.1. The File Menu</a></span></dt>
 
32
<dt><span class="sect2"><a href="mainwindow.html#tools_menu">2.1.2. The Tools Menu</a></span></dt>
 
33
<dt><span class="sect2"><a href="mainwindow.html#options_menu">2.1.3. The Options Menu</a></span></dt>
 
34
<dt><span class="sect2"><a href="mainwindow.html#help_menu">2.1.4. The Help Menu</a></span></dt>
 
35
<dt><span class="sect2"><a href="mainwindow.html#context_help">2.1.5. Context Help</a></span></dt>
 
36
</dl></dd>
 
37
<dt><span class="sect1"><a href="mainwindow.vg_ctl_tool_bar.html">2.2. Valgrind Control ToolBar</a></span></dt>
 
38
<dt><span class="sect1"><a href="mainwindow.tool_bar.html">2.3. ToolView ToolBar</a></span></dt>
 
39
<dt><span class="sect1"><a href="mainwindow.tool_view.html">2.4. ToolViews</a></span></dt>
 
40
<dt><span class="sect1"><a href="mainwindow.flags_widget.html">2.5. Flags Widget</a></span></dt>
 
41
<dt><span class="sect1"><a href="mainwindow.status_msg.html">2.6. Status Messages</a></span></dt>
 
42
</dl>
 
43
</div>
 
44
<p>The main window is composed of several elements, explanations for
 
45
which are below.</p>
 
46
<div class="sect1" lang="en">
 
47
<div class="titlepage">
 
48
<div><div><h2 class="title" style="clear: both">
 
49
<a name="menu_bar"></a>2.1.�The MenuBar</h2></div></div>
 
50
<div></div>
 
51
</div>
 
52
<div class="sect2" lang="en">
 
53
<div class="titlepage">
 
54
<div><div><h3 class="title">
 
55
<a name="file_menu"></a>2.1.1.�The File Menu</h3></div></div>
 
56
<div></div>
 
57
</div>
 
58
<div class="itemizedlist"><ul type="disc">
 
59
<li>
 
60
<p><a name="run_button"></a><span><b class="command">File-&gt;Run Valgrind:</b></span></p>
 
61
<p>This option will be disabled if a process is currently
 
62
    running.</p>
 
63
<p>Selecting this option will run Valgrind on whatever executable 
 
64
    is currently specified in the Options::Valkyrie::Binary option.
 
65
    If no executable has been set, a dialog will pop up asking you to 
 
66
    enter the path/to/executable.</p>
 
67
<p>The "Run Valgrind" toolbutton is a shortcut to this menu option.</p>
 
68
</li>
 
69
<li>
 
70
<p><a name="stop_button"></a><span><b class="command">File-&gt;Stop:</b></span></p>
 
71
<p>This option will be disabled unless a process is currently
 
72
    running.</p>
 
73
<p>Selecting this option will abort the current run.</p>
 
74
<p>Note: Not all processes can currently be stopped: for example
 
75
    loading/saving a logfile.</p>
 
76
<p>The "Stop" toolbutton is a shortcut to this menu option.</p>
 
77
</li>
 
78
<li>
 
79
<p><span><b class="command">File-&gt;Close:</b></span></p>
 
80
<p>Selecting this will close the current ToolView.  If the ToolView
 
81
    contains an unsaved file, or if a process is in the middle of being run,
 
82
    a dialog will pop up asking for confirmation.</p>
 
83
</li>
 
84
<li>
 
85
<p><span><b class="command">File-&gt;Exit:</b></span></p>
 
86
<p>Exits Valkyrie.  If a process is in the middle of being run, 
 
87
    or a ToolView contains unsaved data, a dialog will pop up asking for 
 
88
    confirmation.</p>
 
89
</li>
 
90
</ul></div>
 
91
</div>
 
92
<div class="sect2" lang="en">
 
93
<div class="titlepage">
 
94
<div><div><h3 class="title">
 
95
<a name="tools_menu"></a>2.1.2.�The Tools Menu</h3></div></div>
 
96
<div></div>
 
97
</div>
 
98
<div class="itemizedlist">
 
99
<a name="tview_buttons"></a><ul type="disc"><li>
 
100
<p>This menu shows which Valgrind tools are available.  The currently 
 
101
    selected tool is greyed out.</p>
 
102
<p>The "ToolView Buttons" at the bottom, just below the status
 
103
    message area, provide a quick way of switching between views. The
 
104
    currently selected ToolView button is depressed.</p>
 
105
</li></ul>
 
106
</div>
 
107
</div>
 
108
<div class="sect2" lang="en">
 
109
<div class="titlepage">
 
110
<div><div><h3 class="title">
 
111
<a name="options_menu"></a>2.1.3.�The Options Menu</h3></div></div>
 
112
<div></div>
 
113
</div>
 
114
<div class="itemizedlist"><ul type="disc"><li>
 
115
<p>This menu contains links to a dialog where preferences, options and 
 
116
    flags may be set for Valkyrie, Valgrind, and (supported) Valgrind tools.
 
117
    Any flag which may be given on the command-line for Valkyrie or Valgrind
 
118
    is available to be set in this dialog.
 
119
    Also see <a href="mainwindow.html#context_help">Context Help</a> below.</p>
 
120
<p>For detailed information on this dialog, see the 
 
121
    <a href="options_dialog.html">Options Dialog</a> page.</p>
 
122
</li></ul></div>
 
123
</div>
 
124
<div class="sect2" lang="en">
 
125
<div class="titlepage">
 
126
<div><div><h3 class="title">
 
127
<a name="help_menu"></a>2.1.4.�The Help Menu</h3></div></div>
 
128
<div></div>
 
129
</div>
 
130
<div class="itemizedlist"><ul type="disc">
 
131
<li>
 
132
<p><span><b class="command">Handbook</b></span></p>
 
133
<p>You can access the HandBook at any time.  It contains the manuals 
 
134
    for both Valgrind and Valkyrie.  See also 
 
135
    <a href="mainwindow.html#context_help">Context Help</a> below.</p>
 
136
</li>
 
137
<li>
 
138
<p><span><b class="command">About Dialog</b></span></p>
 
139
<p>This is a small dialog with brief "about" information.</p>
 
140
</li>
 
141
</ul></div>
 
142
</div>
 
143
<div class="sect2" lang="en">
 
144
<div class="titlepage">
 
145
<div><div><h3 class="title">
 
146
<a name="context_help"></a>2.1.5.�Context Help</h3></div></div>
 
147
<div></div>
 
148
</div>
 
149
<div class="itemizedlist"><ul type="disc"><li>
 
150
<p>When clicked, the cursor will change its shape; then, clicking 
 
151
    on any widget anywhere within Valkyrie will bring up the "Handbook" 
 
152
    at the relevant page, providing instant help without having to trawl 
 
153
    through the manual.</p>
 
154
<p>This is particularly useful for the
 
155
    <a href="options_dialog.html">Options Dialog</a> box: Clicking on a option widget
 
156
    will take you directly to the relevant section of the manual.</p>
 
157
</li></ul></div>
 
158
</div>
 
159
</div>
 
160
</div>
 
161
<div>
 
162
<br><table class="nav" width="100%" cellspacing="3" cellpadding="2" border="0" summary="Navigation footer">
 
163
<tr>
 
164
<td rowspan="2" width="40%" align="left">
 
165
<a accesskey="p" href="intro.why_valkyrie.html">&lt;&lt;�1.2.�Why Valkyrie is thusly named</a>�</td>
 
166
<td width="20%" align="center"><a accesskey="u" href="manual.html">Up</a></td>
 
167
<td rowspan="2" width="40%" align="right">�<a accesskey="n" href="mainwindow.vg_ctl_tool_bar.html">2.2.�Valgrind Control ToolBar�&gt;&gt;</a>
 
168
</td>
 
169
</tr>
 
170
<tr><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td></tr>
 
171
</table>
 
172
</div>
 
173
</body>
 
174
</html>