Revert "Typo fix: s/allows to/allows one to/"
[geeqie.git] / doc / docbook / GuideMainWindowImagePane.xml
1 <?xml version="1.0" encoding="utf-8"?>
2 <section id="GuideMainWindowImagePane">
3     <title>
4       Image Pane
5     </title>
6     <para>
7       The image pane is the region of the main window that displays the selected image. The image pane allows adjustment of display size and orientation; it also provides several methods to manipulate the image with the mouse and keyboard.
8     </para>
9     <para/><section id="Imagedisplay"><title>
10       Image display
11     </title>
12     <para>
13       The image is drawn to the screen as it is decoded from disk. The image can be panned and zoomed while it is still loading. Image adjustment operations for rotation, mirror, and flip will delay until the image is completed. The adjustment queue will remember one operation and will retain the most recently requested function, which will be performed once the image has finished loading.
14     </para>
15     <para>
16       The quality of the image, especially when using the zoom feature, is dependent on the settings that are available on the <link linkend="GuideOptionsImage">Image tab</link> of the preferences dialog.
17     </para>
18     <para>
19       To increase the speed of loading the next image when navigating the image list in sequence, enable the <link linkend="GuideOptionsImage">Preload next image</link> option.
20     </para>
21     <para/></section><section id="Imagepanningandmanipulation"><title>
22       Image panning and manipulation
23     </title>
24     <para>
25       When the image size is larger than the image pane, the visible region can be changed with the keyboard or mouse. The keyboard can also be used to adjust the orientation of the image.
26     </para>
27     <para/><section id="Keyboard"><title>
28       Keyboard
29     </title>
30     <para>
31       Use the Arrows to pan the image in the desired direction, to increase the panning speed hold down the Shift + Arrows.<?db2html element="br"?>
32       Press Ctrl + Arrows to move to the respective edge of the image. The image can only be panned with the keyboard when the image has the focus, indicated by a dotted line surrounding the image pane.
33     </para>
34     <informaltable><tgroup cols="3"><tbody><row><entry>
35           Shortcut
36         </entry><entry>
37           Context menu name
38         </entry><entry>
39           Description
40         </entry></row>
41 <row><entry>
42           + =
43         </entry><entry>
44           Zoom in
45         </entry><entry>
46           Zoom in.
47         </entry></row>
48 <row><entry>
49           -
50         </entry><entry>
51           Zoom out
52         </entry><entry>
53           Zoom out.
54         </entry></row>
55 <row><entry>
56           X [Keypad]*
57         </entry><entry>
58           Fit image to window
59         </entry><entry>
60           Scale the image to fit the available display area.
61         </entry></row>
62 <row><entry>
63           Z [Keypad]/
64         </entry><entry>
65           Zoom 1:1
66         </entry><entry>
67           Reset the zoom to original image size.
68         </entry></row>
69 <row><entry>
70           ]
71         </entry><entry>
72           Rotate clockwise
73         </entry><entry>
74           Rotate the image clockwise 90 degrees.
75         </entry></row>
76 <row><entry>
77           [
78         </entry><entry>
79           Rotate counterclockwise
80         </entry><entry>
81           Rotate the image counterclockwise 90 degrees.
82         </entry></row>
83 <row><entry>
84           Shift + R
85         </entry><entry>
86           Rotate 180
87         </entry><entry>
88           Rotate the image 180 degrees.
89         </entry></row>
90 <row><entry>
91           Shift + M
92         </entry><entry>
93           Mirror
94         </entry><entry>
95           Flip the image horizontally.
96         </entry></row>
97 <row><entry>
98           Shift + F
99         </entry><entry>
100           Flip
101         </entry><entry>
102           Flip the image vertically.
103         </entry></row>
104 </tbody></tgroup></informaltable>
105     <para>
106       Note: The rotation, mirror, and flip functions will not change the image data directly. Depending on the <link linkend="GuideOptionsMetadata">Metadata Options</link>, they just alter the Orientation property in memory, in private metadata file or in the image. The image can be rotated according to the saved metadata with "Apply the orientation to image content" command.
107     </para>
108     <para/></section><section id="Mouse"><title>
109       Mouse
110     </title>
111     <para>
112       Press the primary mouse button on the image and hold it, then move the mouse to pan the image in the desired direction. Releasing the mouse button will stop the panning operation. The mouse wheel can also be used to scroll the image when holding down the Shift key [<ulink url="/wiki#bottomnote1">(*)</ulink>].
113     </para>
114     <para>
115       To scale the image size hold down the Ctrl key and scroll the mouse wheel up to zoom in, or down to zoom out.
116     </para>
117     <para/><section id="SmoothScroll"><title>
118       Smooth Scroll
119     </title>
120     <para>
121       To start the smooth scroll function hold down the Shift key and click the primary mouse button. An icon will appear at the location of the mouse pointer, the mouse can then be positioned to pan the image. The image will pan in the direction of the mouse pointer relative to the icon. The pan speed will increase in proportion to the distance that the pointer is from the center of the icon. To end the smooth scroll function click the primary mouse button within the image pane.
122     </para>
123     <para/></section></section></section><section id="Navigation"><title>
124       Navigation
125     </title>
126     <para>
127       The displayed image can be changed to the next or previous image using the keyboard or mouse.
128     </para>
129     <para/><section id="Keyboard1"><title>
130       Keyboard
131     </title>
132     <para>
133       The <ulink url="/wiki/PageDown">PageDown?</ulink> and <ulink url="/wiki/PageUp">PageUp?</ulink> keys will change the image to the next or previous image, respectively, in the list. The Home and End keys will jump to the first and last image, respectively. When the image has the focus, the <ulink url="/wiki/SpaceBar">SpaceBar?</ulink> and <ulink url="/wiki/BackSpace">BackSpace?</ulink> keys can also be used to change the image.
134     </para>
135     <para/></section><section id="Mouse1"><title>
136       Mouse
137     </title>
138     <para>
139       To change to the next image in the list click the left mouse button, click the middle mouse button to change to the previous image. The mouse wheel can also be used to change the current image [<ulink url="/wiki#bottomnote1">(*)</ulink>].
140     </para>
141     <para/></section></section><section id="Contextmenu"><title>
142       Context menu
143     </title>
144     <para>
145       Right clicking the mouse or pressing the menu key while the image has the focus will display a menu. The menu functions will perform the same as those that match the window's <link linkend="GuideMainWindowMenus">menu bar</link>, however a few functions are unique to the context menu:
146     </para>
147     <variablelist><varlistentry><term>
148         View in new window
149       </term><listitem><para>
150         Opens a new window containing a second copy of the current image.
151       </para></listitem></varlistentry><varlistentry><term>
152         Pause slide show, Continue slide show
153       </term><listitem><para>
154         Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed.
155       </para></listitem></varlistentry></variablelist>
156     <para/></section><section id="DragandDrop"><title>
157       Drag and Drop
158     </title>
159     <para>
160       Files and folders can be dropped onto the image pane, dropping a file will display the file and dropping a folder will change the main window to display the contents of the folder. When dropping multiple items on the image pane, only the first item in the list will be used, all additional items will be ignored.
161     </para>
162     <para>
163       A drag and drop operation can be initiated from the image pane with the middle mouse button, the dragged item will contain the file path of the displayed image.
164     </para>
165     <para/></section><section id="Displayingimagessidebyside"><title>
166       Displaying images side by side
167     </title>
168     <para>
169       Using View &gt; Split item from the main menu, image pane can be splitted in up to four panes, this allows to display images side by side. You may use drag'n drop to change images in each pane.
170     </para>
171     <para>
172       Connected zoom is possible through the View &gt; Connected zoom menu. Zoom is then applied to all displayed images.
173     </para>
174     <para>
175       Connected scrolling is also possible using Shift and primary mouse button.
176     </para>
177     <para>
178       As a general rule, hotkeys and mouse without shift affects just one image and with shift all images.
179     </para>
180     <para>
181       (*) Note: The mouse wheel behavior for scrolling and image step can be swapped with the Mouse wheel scrolls image option located on the <link linkend="GuideOptionsAdvanced">Advanced tab?</link> of the preferences dialog.
182     </para>
183   <para/></section></section>