<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<!--
* $Rev$
* $Date$
*
* ***** BEGIN LICENSE BLOCK *****
*
* Version: MPL 1.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is overview_pane.htm
*
* The Initial Developer of the Original Code is Peter Johnson
* (http://www.delphidabbler.com/).
*
* Portions created by the Initial Developer are Copyright (C) 2005-2011 Peter
* Johnson. All Rights Reserved.
*
* Contributor(s)
* NONE
*
* ***** END LICENSE BLOCK *****
-->
<html>
<head>
<meta http-equiv="Content-Type" content="text-html; charset=Windows-1252">
<title>
Overview Pane
</title>
<link rel="stylesheet" href="../css/codesnip.css" type="text/css">
</head>
<body>
<h1>
Overview Pane
</h1>
<p>
This pane appears on the left hand side of the main window. It lists all
the snippets in the database. Snippets can be grouped in three ways:
by category, using the <em>Categorised</em> tab, alphabetically, using the
<em>Alphabetical</em> tab or by <a href="snippet_kinds.htm">snippet
kind</a> using the <em>Snippet Kind</em> tab.
</p>
<p>
Selecting an item in the overview pane causes detailed information about
it to appear in the <a href="detail_pane.htm">Detail Pane</a>. Selecting a
snippet displays a description and its source code while selecting a
section heading lists all the currently selected routines in the section
along with their descriptions.
</p>
<p>
The nodes of the tree used to display the routines can be expanded and
collapsed using the
<img
src="../images/expand.gif"
alt="Expand toolbar button"
class="glyph"
> or
<img
src="../images/collapse.gif"
alt="Collapse toolbar button"
class="glyph"
> buttons in the title of the pane, or by using the various expand and
collapse options on the <a href="menu_view.htm">View</a> menu.
</p>
<p>
You can confgure how the overview pane's display appears when the program
starts by using the <a
href="dlg_prefs_general.htm"
>General</a> tab of the <a
href="dlg_preferences.htm"
>Preferences</a> dialog box (accessed via the <em>Tools | Preferences</em>
menu option). The pane can either display all items or just the section
headers.
</p>
<h2>
Keyboard Shortcuts
</h2>
<p>
The following keyboard shortcuts can be used when the overview pane has
focus.
</p>
<table class="menu" cellspacing="1" cellpadding="0">
<tr>
<td class="item smallcaps">
Up
</td>
<td class="desc">
Moves to the previous entry in the tree, if any, and displays it.
</td>
</tr>
<tr>
<td class="item smallcaps">
Down
</td>
<td class="desc">
Moves to the next entry in the tree, if any, and displays it.
</td>
</tr>
<tr>
<td class="item smallcaps">
Shift+Up
</td>
<td class="desc">
Selects the section header above the currently selected item and
displays the section's details in the details pane. No action is taken
if the first section header is already selected.
</td>
</tr>
<tr>
<td class="item smallcaps">
Shift+Down
</td>
<td class="desc">
Selects the section header below the selected item and displays the
section's details in the details pane. If the selected item is part of
the last section, its own section header is selected.
</td>
</tr>
<tr>
<td class="item smallcaps">
Left
</td>
<td class="desc">
<ul>
<li>
If a sub item is currently selected, the item's parent node is
selected.
</li>
<li>
If an expanded section head item is currently selected, it's
section is collapsed.
</li>
<li>
If a collapsed section head is currently selected, no action is
taken.
</li>
</ul>
</td>
</tr>
<tr>
<td class="item smallcaps">
Right
</td>
<td class="desc">
<ul>
<li>
If a collapsed section header is selected the section is expanded.
</li>
<li>
If an expanded section header is selected the section's first
child node is selected.
</li>
<li>
If a child node or an empty section header is selected no action
is taken.
</li>
</ul>
</td>
</tr>
<tr>
<td class="item smallcaps">
Page Up
</td>
<td class="desc">
Jumps up one page in the tree and displays the newly selected item.
</td>
</tr>
<tr>
<td class="item smallcaps">
Page Down
</td>
<td class="desc">
Jumps down one page in the tree and displays the newly selected item.
</td>
</tr>
<tr>
<td class="item">
<span class="smallcaps">Home</span><br>
or<br>
<span class="smallcaps">Ctrl+Home</span>
</td>
<td class="desc">
Selects and displays the first item in the tree.
</td>
</tr>
<tr>
<td class="item">
<span class="smallcaps">End</span><br>
or<br>
<span class="smallcaps">Ctrl+End</span>
</td>
<td class="desc">
Selects and displays the last item in the tree.
</td>
</tr>
<tr>
<td class="item smallcaps">
Return
</td>
<td class="desc">
<ul>
<li>
When a section header is selected it is toggled between expanded
and collapsed state.
</li>
<li>
When a child node is selected no action is taken.
</li>
</ul>
</td>
</tr>
<tr>
<td class="item smallcaps">
Ctrl+Num Sub
</td>
<td class="desc">
Collapses an expanded section and selects the section header.
</td>
</tr>
<tr>
<td class="item smallcaps">
Ctrl+Num Plus
</td>
<td class="desc">
Expands a collapsed section.
</td>
</tr>
<tr>
<td class="item smallcaps">
Shift+Ctrl+Num Sub
</td>
<td class="desc">
Collapses all sections in the tree.
</td>
</tr>
<tr>
<td class="item smallcaps">
Shift+Ctrl+Num Plus
</td>
<td class="desc">
Fully expands the tree.
</td>
</tr>
</table>
</body>
</html>
