annotate doc/docbook/GuideMainWindowImagePane.xml @ 1734:b92fc3c922ac

scripts for converting wiki documentation to docbook

<?xml version="1.0" encoding="utf-8"?>
<section id="GuideMainWindowImagePane">
    <title>
      Image Pane
    </title>
    <para>
      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.
    </para>
    <para/><section id="Imagedisplay"><title>
      Image display
    </title>
    <para>
      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.
    </para>
    <para>
      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.
    </para>
    <para>
      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.
    </para>
    <para/></section><section id="Imagepanningandmanipulation"><title>
      Image panning and manipulation
    </title>
    <para>
      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.
    </para>
    <para/><section id="Keyboard"><title>
      Keyboard
    </title>
    <para>
      Use the Arrows to pan the image in the desired direction, to increase the panning speed hold down the Shift + Arrows.<?db2html element="br"?>
      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.
    </para>
    <informaltable><tgroup cols="3"><tbody><row><entry>
          Shortcut
        </entry><entry>
          Context menu name
        </entry><entry>
          Description
        </entry></row>
<row><entry>
          + =
        </entry><entry>
          Zoom in
        </entry><entry>
          Zoom in.
        </entry></row>
<row><entry>
          -
        </entry><entry>
          Zoom out
        </entry><entry>
          Zoom out.
        </entry></row>
<row><entry>
          X [Keypad]*
        </entry><entry>
          Fit image to window
        </entry><entry>
          Scale the image to fit the available display area.
        </entry></row>
<row><entry>
          Z [Keypad]/
        </entry><entry>
          Zoom 1:1
        </entry><entry>
          Reset the zoom to original image size.
        </entry></row>
<row><entry>
          ]
        </entry><entry>
          Rotate clockwise
        </entry><entry>
          Rotate the image clockwise 90 degrees.
        </entry></row>
<row><entry>
          [
        </entry><entry>
          Rotate counterclockwise
        </entry><entry>
          Rotate the image counterclockwise 90 degrees.
        </entry></row>
<row><entry>
          Shift + R
        </entry><entry>
          Rotate 180
        </entry><entry>
          Rotate the image 180 degrees.
        </entry></row>
<row><entry>
          Shift + M
        </entry><entry>
          Mirror
        </entry><entry>
          Flip the image horizontally.
        </entry></row>
<row><entry>
          Shift + F
        </entry><entry>
          Flip
        </entry><entry>
          Flip the image vertically.
        </entry></row>
</tbody></tgroup></informaltable>
    <para>
      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.
    </para>
    <para/></section><section id="Mouse"><title>
      Mouse
    </title>
    <para>
      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>].
    </para>
    <para>
      To scale the image size hold down the Ctrl key and scroll the mouse wheel up to zoom in, or down to zoom out.
    </para>
    <para/><section id="SmoothScroll"><title>
      Smooth Scroll
    </title>
    <para>
      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.
    </para>
    <para/></section></section></section><section id="Navigation"><title>
      Navigation
    </title>
    <para>
      The displayed image can be changed to the next or previous image using the keyboard or mouse.
    </para>
    <para/><section id="Keyboard1"><title>
      Keyboard
    </title>
    <para>
      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.
    </para>
    <para/></section><section id="Mouse1"><title>
      Mouse
    </title>
    <para>
      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>].
    </para>
    <para/></section></section><section id="Contextmenu"><title>
      Context menu
    </title>
    <para>
      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:
    </para>
    <variablelist><varlistentry><term>
        View in new window
      </term><listitem><para>
        Opens a new window containing a second copy of the current image.
      </para></listitem></varlistentry><varlistentry><term>
        Pause slide show, Continue slide show
      </term><listitem><para>
        Controls the pause state of an active slide show, the text of the menu will change to reflect the action that will be performed.
      </para></listitem></varlistentry></variablelist>
    <para/></section><section id="DragandDrop"><title>
      Drag and Drop
    </title>
    <para>
      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.
    </para>
    <para>
      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.
    </para>
    <para/></section><section id="Displayingimagessidebyside"><title>
      Displaying images side by side
    </title>
    <para>
      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.
    </para>
    <para>
      Connected zoom is possible through the View &gt; Connected zoom menu. Zoom is then applied to all displayed images.
    </para>
    <para>
      Connected scrolling is also possible using Shift and primary mouse button.
    </para>
    <para>
      As a general rule, hotkeys and mouse without shift affects just one image and with shift all images.
    </para>
    <para>
      (*) 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.
    </para>
  <para/></section></section>